{
"openapi":"3.1.0",
"info":{
"title":"Infobip OpenAPI Specification",
"description":"OpenAPI Specification that contains all public endpoints and webhooks.",
"contact":{
"name":"Infobip support",
"email":"support@infobip.com"
},
"version":"3.210.0",
"x-generatedAt":"2026-07-23T15:24:00.141761715Z"
},
"tags":[
{
"name":"channels",
"description":"Create a perfect customer experience by using the channels your customer already use and love.\n",
"x-type":"category",
"x-displayName":"Channels"
},
{
"name":"apple-mfb",
"description":"Use Apple Messages for Business to contact customers in real time.\n\nThrough the Messages app on iOS, macOS, watchOS, and iPadOS, Apple Messages for Business makes it easy for customers to communicate with businesses. Customers can use the Messages app to communicate with brands for a number of reasons, including asking inquiries, getting help, scheduling appointments, and making payments using Apple Pay.\n\nPeople can use apps, features, and services like Maps and Spotlight (iPhone search) to discover businesses and seamlessly initiate conversations with them. The familiar Messages app interface on iPhone, iPad, Mac, and Apple Watch ensures that customer interaction is intuitive and efficient, and the informality of chat produces a customer service experience that feels personal and meaningful.\n\nMore than 2 billion active Apple devices worldwide can interact with brands through Apple Messages for Business. \n\nTo utilize Apple Messages for Business in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n",
"x-type":"product",
"x-displayName":"Apple Messages for Business"
},
{
"name":"sending-apple-mfb-message",
"description":"Sends one or more messages to multiple recipients.\n",
"x-type":"module",
"x-displayName":"Outbound Message"
},
{
"name":"logs-and-status-reports-apple-mfb",
"description":"Status Reports tell you what happened to the message you sent, whether it was successfully delivered or failed to be delivered. Logs provide similar information to Status Reports but are available to query for 48hrs.\n",
"x-type":"module",
"x-displayName":"Logs and Status Reports"
},
{
"name":"incoming-apple-mfb-message",
"description":"Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.\n",
"x-type":"module",
"x-displayName":"Receive incoming message"
}
],
"paths":{
"/apple-mfb/1/messages":{
"post":{
"tags":[
"channels",
"apple-mfb",
"sending-apple-mfb-message"
],
"summary":"Send Apple Messages for Business",
"description":"Send one or more messages to multiple recipients.",
"externalDocs":{
"description":"Learn more about Apple Messages for Business channel and use cases",
"url":"https://www.infobip.com/docs/apple-messages-for-business"
},
"operationId":"send-apple-mfb-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest"
},
"examples":{
"Text message example":{
"summary":"Text message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"text":"Some text",
"type":"TEXT"
}
}
]
}
},
"Image message example":{
"summary":"Image message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"https://api.infobip.com/ott/1/media/testImage",
"type":"IMAGE"
}
}
]
}
},
"Image message with header and caption example":{
"summary":"Image message with header and caption example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"https://api.infobip.com/ott/1/media/testImage",
"header":"Header",
"caption":"Caption",
"type":"IMAGE"
}
}
]
}
},
"Video message example":{
"summary":"Video message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"http://my.domain/video.mp4",
"type":"VIDEO"
}
}
]
}
},
"Video message with header and caption example":{
"summary":"Video message with header and caption example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"http://my.domain/video.mp4",
"header":"header",
"caption":"caption",
"type":"VIDEO"
}
}
]
}
},
"Document message example":{
"summary":"Document message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"https://api.infobip.com/ott/1/media/testPdf",
"type":"DOCUMENT"
}
}
]
}
},
"Media message example":{
"summary":"Media message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"urls":[
"https://api.infobip.com/ott/1/media/testImage",
"http://my.domain/video.mp4"
],
"type":"MEDIA"
}
}
]
}
},
"Document message with header and caption example":{
"summary":"Document message with header and caption example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"https://api.infobip.com/ott/1/media/testPdf",
"header":"header",
"caption":"caption",
"type":"DOCUMENT"
}
}
]
}
},
"Text message with SMS failover":{
"summary":"Text message with SMS failover",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"text":"Some text",
"type":"TEXT"
},
"options":{
"smsFailover":{
"sender":"InfoSMS",
"text":"This is a failover message.",
"destinationMatching":[
{
"initial":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"failover":"41793026727"
}
]
}
}
}
]
}
},
"Rich link message example":{
"summary":"Rich link message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"linkUrl":"http://my.domain/image.png",
"linkTitle":"Sample Title",
"imageUrl":"https://api.infobip.com/ott/1/media/testImage",
"videoUrl":"http://my.domain/video.mp4",
"type":"RICH_LINK"
}
}
]
}
},
"App Clip message example":{
"summary":"App Clip message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"url":"https://appclip.apple.com/id?=com.example.Clip&promotion=WWDC23",
"storeRegion":"US",
"type":"APP_CLIP"
}
}
]
}
},
"Quick reply message example":{
"summary":"Quick reply message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"summaryText":"Summary Text",
"items":[
{
"identifier":"identifier_1",
"title":"Title 1"
},
{
"identifier":"identifier_2",
"title":"Title 2"
}
],
"requestIdentifier":"1234-5678",
"type":"QUICK_REPLY"
}
}
]
}
},
"Form message example":{
"summary":"Form message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"data":{
"pages":[
{
"items":[
{
"identifier":"id-a",
"title":"Apples",
"value":"apples"
},
{
"identifier":"id-o",
"title":"Oranges",
"value":"oranges"
}
],
"pageIdentifier":"0",
"subtitle":"Select what fruit you like",
"nextPageIdentifier":"1",
"title":"Food",
"submitForm":false,
"multipleSelection":true,
"type":"SELECT"
},
{
"pageIdentifier":"1",
"subtitle":"When were you born?",
"title":"Birthday",
"submitForm":true,
"options":{
"dateFormat":"MM/DD/YYYY",
"startDate":"2025-01-05",
"maximumDate":"2025-01-10",
"minimumDate":"2025-01-01",
"labelText":"Choose the date"
},
"type":"DATE_PICKER"
}
],
"startPageIdentifier":"0",
"private":true,
"showSummary":true
},
"images":[
{
"imageUrl":"https://api.infobip.com/ott/1/media/testImage",
"identifier":"imgIdScreen"
}
],
"requestIdentifier":"requestId",
"receivedMessage":{
"style":"ICON",
"title":"Please fill out this form",
"subtitle":"We really need this data",
"imageIdentifier":"imgIdScreen"
},
"replyMessage":{
"style":"ICON",
"title":"Thank you!",
"subtitle":"This will help improve our services",
"imageIdentifier":"imgIdScreen"
},
"type":"FORM"
}
}
]
}
},
"Authentication request message example":{
"summary":"Authentication request message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
],
"content":{
"images":[
{
"imageUrl":"https://api.infobip.com/ott/1/media/testImage",
"identifier":"img1"
}
],
"requestIdentifier":"1234-5678",
"receivedMessage":{
"style":"ICON",
"title":"Please log in",
"subtitle":"using LinkedIn",
"imageIdentifier":"img1"
},
"replyMessage":{
"style":"ICON",
"title":"Successful login",
"subtitle":"using LinkedIn",
"imageIdentifier":"img1"
},
"scopes":[
"r_liteprofile"
],
"type":"AUTHENTICATION_REQUEST"
}
}
]
}
},
"Invitation message example":{
"summary":"Invitation message example",
"value":{
"messages":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"48123456789"
}
],
"content":{
"requestIdentifier":"1234-5678",
"templateId":"binaryChoice.engage.noImage",
"locale":"en-us",
"referenceId":"1009273616-A",
"placeholders":{
"brandName":"testBrand"
},
"type":"INVITATION"
}
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"value":{
"bulkId":"1688025180464000013",
"messages":[
{
"messageId":"1688025180464000014",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message sent to next instance"
},
"destination":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"apple-mfb:message:send",
"apple-mfb:manage"
]
}
},
"/apple-mfb/1/events":{
"post":{
"tags":[
"channels",
"apple-mfb",
"sending-apple-mfb-message"
],
"summary":"Send Apple Events",
"description":"Send one or more events to multiple recipients.",
"externalDocs":{
"description":"Learn more about Apple Messages for Business channel and use cases",
"url":"https://www.infobip.com/docs/apple-messages-for-business"
},
"operationId":"send-apple-mfb-event",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest"
},
"examples":{
"Typing indicator event example":{
"summary":"Typing indicator event example",
"value":{
"events":[
{
"content":{
"typingIndicatorType":"TYPING_START",
"type":"TYPING_INDICATOR"
},
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destinations":[
{
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
]
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"examples":{
"Successful response":{
"summary":"Successful response",
"value":{
"bulkId":"1688025180464000013",
"messages":[
{
"messageId":"1688025180464000014",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message sent to next instance"
},
"destination":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es="
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"apple-mfb:message:send",
"apple-mfb:manage"
]
}
},
"/apple-mfb/1/reports":{
"get":{
"tags":[
"channels",
"apple-mfb",
"logs-and-status-reports-apple-mfb"
],
"summary":"Get Apple Messages for Business delivery reports",
"description":"If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.",
"externalDocs":{
"description":"Learn more about Apple Messages for Business channel and use cases",
"url":"https://www.infobip.com/docs/apple-messages-for-business"
},
"operationId":"get-outbound-apple-mfb-message-delivery-reports",
"parameters":[
{
"name":"bulkId",
"in":"query",
"description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"messageId",
"in":"query",
"description":"The ID that uniquely identifies the message sent.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"limit",
"in":"query",
"description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":50,
"maximum":1000
},
"example":1
},
{
"name":"entityId",
"in":"query",
"description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"promotional-traffic-entity"
},
{
"name":"applicationId",
"in":"query",
"description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"marketing-automation-application"
},
{
"name":"campaignReferenceId",
"in":"query",
"description":"ID of a campaign that was sent in the message.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"summersale"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":{
"results":[
{
"bulkId":"1688025180464000013",
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":0,
"name":"NO_ERROR",
"description":"No Error",
"permanent":false
},
"messageId":"1688025180464000014",
"to":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"sender":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"sentAt":"2023-09-26T10:52:15.457+0000",
"doneAt":"2023-09-26T10:52:15.799+0000",
"messageCount":1,
"mccMnc":"22801",
"platform":{
"entityId":"promotional-traffic-entity",
"applicationId":"marketing-automation-application"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"apple-mfb:message:send",
"apple-mfb:manage"
]
}
},
"/apple-mfb/1/logs":{
"get":{
"tags":[
"channels",
"apple-mfb",
"logs-and-status-reports-apple-mfb"
],
"summary":"Get message logs",
"description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.",
"operationId":"get-outbound-apple-mfb-message-logs",
"parameters":[
{
"name":"sender",
"in":"query",
"description":"The sender ID which can be alphanumeric or numeric.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"destination",
"in":"query",
"description":"Message destination address.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
},
{
"name":"bulkId",
"in":"query",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"example":"BULK-ID-123-xyz"
},
{
"name":"messageId",
"in":"query",
"description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz"
},
{
"name":"generalStatus",
"in":"query",
"required":false,
"style":"form",
"explode":true,
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageGeneralStatus"
}
},
{
"name":"sentSince",
"in":"query",
"description":"The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time"
},
"example":"2020-02-22T17:42:05.390+01:00"
},
{
"name":"sentUntil",
"in":"query",
"description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"format":"date-time",
"description":"The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ.",
"example":"2020-02-23T17:42:05.39+01:00"
},
"example":"2020-02-23T17:42:05.390+01:00"
},
{
"name":"limit",
"in":"query",
"description":"Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":50,
"maximum":1000
}
},
{
"name":"entityId",
"in":"query",
"description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"promotional-traffic-entity"
},
{
"name":"applicationId",
"in":"query",
"description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
},
"example":"marketing-automation-application"
},
{
"name":"campaignReferenceId",
"in":"query",
"description":"ID of a campaign that was sent in the message. May contain multiple comma-separated values.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"array",
"items":{
"type":"string"
}
},
"example":"summersale"
},
{
"name":"useCursor",
"in":"query",
"description":"Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"boolean"
}
},
{
"name":"cursor",
"in":"query",
"description":"Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogResponseLogAppleMfbOutboundContent"
},
"examples":{
"Log result":{
"summary":"Log result",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"destination":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"bulkId":"1688025180464000013",
"messageId":"1688025180464000014",
"sentAt":"2023-02-01T23:00:00.000+0000",
"doneAt":"2023-02-03T00:01:01.000+0000",
"messageCount":1,
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":0,
"name":"NO_ERROR",
"description":"No Error",
"permanent":false
},
"platform":{
"entityId":"promotional-traffic-entity",
"applicationId":"marketing-automation-application"
},
"content":{
"text":"Some text",
"type":"TEXT"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"apple-mfb:logs:read",
"apple-mfb:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":120,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
}
},
"components":{
"schemas":{
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Altitude":{
"type":"object",
"description":"Altitude of the location.",
"properties":{
"value":{
"type":"number",
"format":"double",
"description":"Value of altitude."
},
"uncertainty":{
"type":"number",
"format":"double",
"description":"Uncertainty around altitude value."
},
"unit":{
"type":"string",
"description":"Unit of altitude values."
}
},
"required":[
"uncertainty",
"unit",
"value"
],
"title":"Altitude"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEvent":{
"type":"object",
"description":"An array of event objects of the events to be sent.",
"properties":{
"content":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContent"
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventOptions"
},
"sender":{
"type":"string",
"description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)."
},
"destinations":{
"type":"array",
"description":"An array of destination objects for where the event is being sent. A valid destination is required.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination"
}
}
},
"required":[
"destinations",
"sender"
],
"title":"AppleMfbEvent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventOptions":{
"type":"object",
"description":"Event options.",
"properties":{
"platform":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform"
},
"validityPeriod":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod"
}
},
"title":"AppleMfbEventOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest":{
"type":"object",
"properties":{
"events":{
"type":"array",
"description":"An array of event objects of the events to be sent.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEvent"
}
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultEventRequestOptions"
}
},
"required":[
"events"
],
"title":"AppleMfbEventRequest"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundAuthContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request Identifier."
},
"authenticated":{
"type":"boolean",
"description":"Returns information if the user has authenticated correctly."
},
"authenticationCode":{
"type":"string",
"description":"Authentication code returned in case of a successful authentication."
},
"errorCode":{
"type":"integer",
"format":"int32",
"description":"Error code returned in case of a failed authentication."
}
}
}
],
"required":[
"authenticated",
"context",
"requestIdentifier",
"type"
],
"title":"AppleMfbInboundAuthContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCloseConversationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
}
}
}
],
"required":[
"context",
"type"
],
"title":"AppleMfbInboundCloseConversationContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTextContent",
"TYPING_INDICATOR":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTypingIndicatorContent",
"LIST_PICKER_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundListPickerContent",
"TIME_PICKER_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTimePickerContent",
"AUTHENTICATION_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundAuthContent",
"APPLE_PAY_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundPayResponseContent",
"CUSTOM_INTERACTIVE_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCustomInteractiveContent",
"CLOSE_CONVERSATION":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCloseConversationContent",
"QUICK_REPLY":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundQuickReplyContent",
"FORM_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundFormContent",
"INVITATION_RESPONSE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundInvitationContent",
"ROADSIDE_ASSISTANCE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundRoadsideAssistanceContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContentType"
}
},
"required":[
"type"
],
"title":"AppleMfbInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContentType":{
"type":"string",
"enum":[
"TEXT",
"TYPING_INDICATOR",
"LIST_PICKER_RESPONSE",
"TIME_PICKER_RESPONSE",
"AUTHENTICATION_RESPONSE",
"APPLE_PAY_RESPONSE",
"CUSTOM_INTERACTIVE_RESPONSE",
"CLOSE_CONVERSATION",
"QUICK_REPLY",
"FORM_RESPONSE",
"INVITATION_RESPONSE",
"ROADSIDE_ASSISTANCE"
],
"title":"AppleMfbInboundContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCustomInteractiveContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"urlData":{
"type":"array",
"description":"List of parameters.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Parameter"
}
},
"sessionIdentifier":{
"type":"string",
"description":"Session identifier."
},
"attachments":{
"type":"array",
"description":"Attachments list.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Attachment"
}
}
}
}
],
"required":[
"attachments",
"context",
"sessionIdentifier",
"type",
"urlData"
],
"title":"AppleMfbInboundCustomInteractiveContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundFormContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request identifier."
},
"privateForm":{
"type":"boolean",
"description":"Indicates if response is private."
},
"selections":{
"type":"array",
"description":"Forms containing user responses.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
"maxItems":2147483647,
"minItems":1
}
}
}
],
"required":[
"context",
"requestIdentifier",
"selections",
"type"
],
"title":"AppleMfbInboundFormContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundInvitationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request identifier."
},
"choice":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Choice"
}
}
}
],
"required":[
"choice",
"context",
"requestIdentifier",
"type"
],
"title":"AppleMfbInboundInvitationContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundListPickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request identifier."
},
"listPickerSelectedItems":{
"type":"array",
"description":"List of selected items.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerSelectedItem"
}
}
}
}
],
"required":[
"context",
"listPickerSelectedItems",
"requestIdentifier",
"type"
],
"title":"AppleMfbInboundListPickerContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundPayResponseContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request Identifier."
},
"paid":{
"type":"boolean",
"description":"Payment Status."
},
"lineItems":{
"type":"array",
"description":"Items List.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LineItem"
}
},
"total":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LineItem"
}
}
}
],
"required":[
"context",
"lineItems",
"paid",
"requestIdentifier",
"total",
"type"
],
"title":"AppleMfbInboundPayResponseContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundQuickReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request Identifier."
},
"quickReplySelectedItem":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.QuickReplySelectedItem"
}
}
}
],
"required":[
"context",
"quickReplySelectedItem",
"requestIdentifier",
"type"
],
"title":"AppleMfbInboundQuickReplyContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of mobile originated messages.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InboundMessageAppleMfbInboundContent"
}
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"The number of messages returned in the results array."
},
"pendingMessageCount":{
"type":"integer",
"format":"int32",
"description":"The number of messages that have not been pulled in."
}
},
"title":"AppleMfbInboundResponse"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundRoadsideAssistanceContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"rsaContent":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent"
}
}
}
],
"required":[
"context",
"rsaContent",
"type"
],
"title":"AppleMfbInboundRoadsideAssistanceContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTextContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"text":{
"type":"string",
"description":"Received message text."
},
"attachments":{
"type":"array",
"description":"Attachment list.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Attachment"
}
}
}
}
],
"required":[
"context",
"text",
"type"
],
"title":"AppleMfbInboundTextContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTimePickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"requestIdentifier":{
"type":"string",
"description":"Request Identifier."
},
"selectedTime":{
"type":"string",
"format":"date-time",
"description":"Selected Time (UTC date)."
},
"selectedDuration":{
"type":"integer",
"format":"int32",
"description":"An integer representing the duration of the time slot, in seconds."
},
"timezoneOffset":{
"type":"integer",
"format":"int32",
"description":"An integer representing the number of minutes from GMT."
},
"selectedTimeslotIdentifier":{
"type":"string",
"description":"Selected TimeItem Identifier."
}
}
}
],
"required":[
"context",
"requestIdentifier",
"selectedDuration",
"selectedTime",
"selectedTimeslotIdentifier",
"type"
],
"title":"AppleMfbInboundTimePickerContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTypingIndicatorContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
{
"type":"object",
"properties":{
"context":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context"
},
"typingIndicatorType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TypingIndicatorType"
}
}
}
],
"required":[
"context",
"type",
"typingIndicatorType"
],
"title":"AppleMfbInboundTypingIndicatorContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbMessage":{
"type":"object",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"properties":{
"sender":{
"type":"string",
"description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)."
},
"destinations":{
"type":"array",
"description":"An array of destination objects for where messages are being sent. A valid destination is required.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination"
}
},
"content":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContent"
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnMessageFailoverOptions"
},
"webhooks":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Webhooks"
}
},
"required":[
"content",
"destinations",
"sender"
],
"title":"AppleMfbMessage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAppClipContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL used by Apple Messages for Business to identify the App Clip"
},
"storeRegion":{
"type":"string",
"description":"ISO 3166 alpha-2 country code of the App Store region. By default it is 'US'. Set this value in case the App Clip is not in the US App Store.",
"maxLength":2,
"minLength":2
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"type",
"url"
],
"title":"AppleMfbOutboundAppClipContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAuthRequestContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"images":{
"type":"array",
"description":"An array of images.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image"
}
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"receivedMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing received message bubble presented in Messages app."
},
"replyMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing reply message bubble presented in Messages app."
},
"redirectUri":{
"type":"string",
"description":"URL that OAuth provider sends auth code and state to."
},
"state":{
"type":"string",
"description":"Unique identifier of this authentication request."
},
"scopes":{
"type":"array",
"description":"List of scopes being the subject of this authentication request.",
"items":{
"type":"string",
"description":"List of scopes being the subject of this authentication request."
}
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"receivedMessage",
"replyMessage",
"type"
],
"title":"AppleMfbOutboundAuthRequestContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent":{
"type":"object",
"description":"Content of the message.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TYPING_INDICATOR":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTypingIndicatorContent",
"RICH_LINK":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundRichLinkContent",
"VIDEO":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundVideoContent",
"FORM":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundFormContent",
"TEXT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTextContent",
"PAY_REQUEST":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundPayRequestContent",
"AUTHENTICATION_REQUEST":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAuthRequestContent",
"LIST_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundListPickerContent",
"INVITATION":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundInvitationContent",
"APP_CLIP":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAppClipContent",
"IMAGE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundImageContent",
"DOCUMENT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundDocumentContent",
"MEDIA":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMediaContent",
"TIME_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTimePickerContent",
"QUICK_REPLY":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundQuickReplyContent"
}
},
"properties":{
"type":{
"type":"string",
"enum":[
"LOCATION",
"VIDEO",
"TEXT",
"AUDIO",
"LIST_PICKER",
"APPLE_TEXT_WITH_QUICK_REPLY_CONTENT",
"APPLE_FORM_CONTENT",
"IMAGE",
"APPLE_TIME_PICKER_CONTENT",
"DOCUMENT",
"MEDIA",
"TIME_PICKER",
"APPLE_LIST_PICKER_CONTENT",
"TYPING_INDICATOR",
"APPLE_AUTH_REQUEST_CONTENT",
"APPLE_PAY_REQUEST_CONTENT",
"RICH_LINK",
"FORM",
"APPLE_TYPING_INDICATOR_CONTENT",
"APPLE_QUICK_REPLY_CONTENT",
"PAY_REQUEST",
"AUTHENTICATION_REQUEST",
"TEXT_WITH_QUICK_REPLY",
"BUSINESS_UPDATE",
"INVITATION",
"APP_CLIP",
"MULTIPART",
"APPLE_RICH_LINK_CONTENT",
"APPLE_CUSTOM_INTERACTIVE_CONTENT",
"QUICK_REPLY"
]
}
},
"title":"AppleMfbOutboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundDocumentContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the document being sent."
},
"header":{
"type":"string",
"description":"Text that will displayed above the document.",
"maxLength":3500,
"minLength":0
},
"caption":{
"type":"string",
"description":"Text that will displayed under the document.",
"maxLength":3500,
"minLength":0
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"type",
"url"
],
"title":"AppleMfbOutboundDocumentContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContent":{
"type":"object",
"description":"Event content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TYPING_INDICATOR":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTypingIndicatorContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType"
}
},
"required":[
"type"
],
"title":"AppleMfbOutboundEventContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType":{
"type":"string",
"enum":[
"TYPING_INDICATOR"
],
"title":"AppleMfbOutboundEventContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundFormContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"data":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormData"
},
"images":{
"type":"array",
"description":"An array of images.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image"
}
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"receivedMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing received message bubble presented in Messages app."
},
"replyMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing reply message bubble presented in Messages app."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"data",
"receivedMessage",
"replyMessage",
"type"
],
"title":"AppleMfbOutboundFormContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundImageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the image being sent.",
"maxLength":1000,
"minLength":0
},
"header":{
"type":"string",
"description":"Text that will displayed above the image.",
"maxLength":3500,
"minLength":0
},
"caption":{
"type":"string",
"description":"Text that will displayed under the image.",
"maxLength":3500,
"minLength":0
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"type",
"url"
],
"title":"AppleMfbOutboundImageContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundInvitationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"templateId":{
"type":"string",
"description":"Identifier of the template that should be used in the Invitation message. Possible values are defined by Apple."
},
"locale":{
"type":"string",
"description":"Indicates the language used in the message (eg. `en-US`). If locale is not specified, default language will be used."
},
"referenceId":{
"type":"string",
"description":"Reference field to provide context of what the Invitation message is for (eg. order number, case identifier, etc). Should not contain quotation marks or apostrophe characters.",
"maxLength":1000,
"minLength":0
},
"placeholders":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Template placeholders. All the required placeholders must be provided and can't be null. Otherwise, the validation will fail and the message will be rejected by Apple."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"placeholders",
"referenceId",
"templateId",
"type"
],
"title":"AppleMfbOutboundInvitationContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundListPickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"images":{
"type":"array",
"description":"An array of images.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image"
}
},
"listPicker":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPicker"
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"receivedMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing received message bubble presented in Messages app."
},
"replyMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing reply message bubble presented in Messages app."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"listPicker",
"receivedMessage",
"replyMessage",
"type"
],
"title":"AppleMfbOutboundListPickerContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMediaContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"urls":{
"type":"array",
"description":"URLs of the media being sent. Only images and videos can be presented as a gallery (stacked on top of each other).",
"items":{
"type":"string",
"description":"URLs of the media being sent. Only images and videos can be presented as a gallery (stacked on top of each other).",
"maxLength":1000,
"minLength":0
}
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"type",
"urls"
],
"title":"AppleMfbOutboundMediaContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTextContent",
"IMAGE":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundImageContent",
"VIDEO":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundVideoContent",
"DOCUMENT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundDocumentContent",
"QUICK_REPLY":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundQuickReplyContent",
"RICH_LINK":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundRichLinkContent",
"AUTHENTICATION_REQUEST":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAuthRequestContent",
"LIST_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundListPickerContent",
"FORM":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundFormContent",
"TIME_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTimePickerContent",
"PAY_REQUEST":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundPayRequestContent",
"INVITATION":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundInvitationContent",
"MEDIA":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMediaContent",
"APP_CLIP":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAppClipContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
},
"required":[
"type"
],
"title":"AppleMfbOutboundMessageContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"DOCUMENT",
"MEDIA",
"QUICK_REPLY",
"RICH_LINK",
"APP_CLIP",
"AUTHENTICATION_REQUEST",
"LIST_PICKER",
"FORM",
"TIME_PICKER",
"PAY_REQUEST",
"INVITATION"
],
"title":"AppleMfbOutboundMessageContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundPayRequestContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"images":{
"type":"array",
"description":"An array of images.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image"
}
},
"receivedMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataApplePayMessage"
}
],
"description":"Object describing received message bubble presented in Messages app."
},
"lineItems":{
"type":"array",
"description":"Set of line items that explain recurring payments and additional charges and discounts.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ApplePayLineItem"
}
},
"total":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ApplePayLineItem"
},
"shippingMethods":{
"type":"array",
"description":"An array of shipping methods for delivering physical goods.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ApplePayShippingMethod"
}
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"configuration":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PaymentConfiguration"
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"receivedMessage",
"total",
"type"
],
"title":"AppleMfbOutboundPayRequestContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundQuickReplyContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"summaryText":{
"type":"string",
"description":"A summary text that will be used for device notification but also shown in the transcript after user makes a choice."
},
"items":{
"type":"array",
"description":"An array of possible replies.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.QuickReplyItem"
},
"maxItems":5,
"minItems":2
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"items",
"summaryText",
"type"
],
"title":"AppleMfbOutboundQuickReplyContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundRichLinkContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"linkUrl":{
"type":"string",
"description":"URL of the rich link message.\nIf `linkTitle` and `imageUrl` are not provided, it will resolve them from page metadata.\nWorks best if provided page support Open Graph protocol."
},
"linkTitle":{
"type":"string",
"description":"Title of the rich link message. Not applicable to Apple Maps or Apple Music linkUrls."
},
"imageUrl":{
"type":"string",
"description":"URL of the image.\nApple supports images of size up to 200kB. Not applicable to Apple Maps or Apple Music linkUrls."
},
"videoUrl":{
"type":"string",
"description":"URL of the video. Not applicable to Apple Maps or Apple Music linkUrls."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"linkUrl",
"type"
],
"title":"AppleMfbOutboundRichLinkContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTextContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Textual content of the message.",
"maxLength":7000,
"minLength":1
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"text",
"type"
],
"title":"AppleMfbOutboundTextContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTimePickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"images":{
"type":"array",
"description":"An array of images.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image"
}
},
"event":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Event"
},
"requestIdentifier":{
"type":"string",
"description":"Identifier of the request. Generated automatically if empty."
},
"receivedMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing received message bubble presented in Messages app."
},
"replyMessage":{
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage"
}
],
"description":"Object describing reply message bubble presented in Messages app."
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"event",
"receivedMessage",
"replyMessage",
"type"
],
"title":"AppleMfbOutboundTimePickerContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTypingIndicatorContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"typingIndicatorType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TypingIndicatorType"
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType"
}
}
}
],
"required":[
"type",
"typingIndicatorType"
],
"title":"AppleMfbOutboundTypingIndicatorContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundVideoContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the video being sent."
},
"header":{
"type":"string",
"description":"Text that will displayed above the video.",
"maxLength":3500,
"minLength":0
},
"caption":{
"type":"string",
"description":"Text that will displayed under the video.",
"maxLength":3500,
"minLength":0
},
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType"
}
}
}
],
"required":[
"type",
"url"
],
"title":"AppleMfbOutboundVideoContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest":{
"type":"object",
"properties":{
"messages":{
"type":"array",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbMessage"
}
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultMessageRequestOptions"
}
},
"required":[
"messages"
],
"title":"AppleMfbRequest"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ApplePayLineItem":{
"type":"object",
"description":"Line item that represents the total for the payment.",
"properties":{
"label":{
"type":"string",
"description":"Short, localized description of the line item."
},
"amount":{
"type":"string",
"description":"The monetary amount of the line item."
},
"type":{
"type":"string",
"description":"Value that indicates whether the line item is final or pending."
}
},
"required":[
"amount",
"label",
"type"
],
"title":"ApplePayLineItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ApplePayShippingMethod":{
"type":"object",
"description":"An array of shipping methods for delivering physical goods.",
"properties":{
"amount":{
"type":"string",
"description":"The nonnegative cost associated with this shipping method."
},
"detail":{
"type":"string",
"description":"Additional description of the shipping method."
},
"identifier":{
"type":"string",
"description":"Client-defined value used to identify this shipping method."
},
"label":{
"type":"string",
"description":"Short description of the shipping method."
}
},
"required":[
"amount",
"detail",
"identifier",
"label"
],
"title":"ApplePayShippingMethod"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Attachment":{
"type":"object",
"description":"Attachments list.",
"properties":{
"fileName":{
"type":"string",
"description":"Name of the attachment."
},
"downloadId":{
"type":"string",
"description":"Download identifier of the attachment."
},
"url":{
"type":"string",
"description":"URL of the attachment."
}
},
"required":[
"downloadId",
"fileName",
"url"
],
"title":"Attachment"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Capability":{
"type":"string",
"description":"Identifies Apple Messages for Business features supported by the customer’s device.",
"enum":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
],
"title":"Capability"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Choice":{
"type":"string",
"description":"Binary choice.",
"enum":[
"YES",
"NO"
],
"title":"Choice"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ContactField":{
"type":"string",
"description":"The list of shipping or contact information required from the customer to fulfill the order.",
"enum":[
"POSTAL_ADDRESS",
"EMAIL",
"PHONE",
"NAME",
"PHONETIC_NAME"
],
"title":"ContactField"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Context":{
"type":"object",
"description":"Message Context.",
"properties":{
"intent":{
"type":"string",
"description":"Purpose of the chat."
},
"group":{
"type":"string",
"description":"Group designates to handle the customer’s question or problem."
},
"locale":{
"type":"string",
"description":"Locale."
},
"userPhoneNumber":{
"type":"string",
"description":"Phone number of the user who sent the message. Available only in conversations with Business Update messages."
},
"referenceId":{
"type":"string",
"description":"Reference identifier sent in the original outbound Business Update message. Available only in conversations with Business Update messages."
},
"capabilityList":{
"type":"array",
"description":"Identifies Apple Messages for Business features supported by the customer’s device.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Capability"
}
}
},
"title":"Context"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.CursorPageInfo":{
"type":"object",
"description":"Cursor information.",
"properties":{
"limit":{
"type":"integer",
"format":"int32",
"description":"Requested limit."
},
"nextCursor":{
"type":"string",
"description":"The `cursor` value you will use in your next request to fetch the subsequent set of results."
}
},
"readOnly":true,
"title":"CursorPageInfo"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerPage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Unique identifier of the page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Question of the page."
},
"nextPageIdentifier":{
"type":"string",
"description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.",
"maxLength":20,
"minLength":0
},
"title":{
"type":"string",
"description":"Title of the page."
},
"submitForm":{
"type":"boolean",
"description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages."
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerPageOptions"
}
}
}
],
"required":[
"nextPageIdentifier",
"pageIdentifier",
"subtitle",
"type"
],
"title":"DatePickerPage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerPageOptions":{
"type":"object",
"description":"Options of the page.",
"properties":{
"dateFormat":{
"type":"string",
"description":"Date format used on the page e.g. `MM/dd/yyyy`."
},
"startDate":{
"type":"string",
"format":"date",
"description":"Date displayed by the date picker. Has the following format: `YYYY-MM-DD`."
},
"maximumDate":{
"type":"string",
"format":"date",
"description":"Maximum date that the date picker can show. Has the following format: `YYYY-MM-DD`."
},
"minimumDate":{
"type":"string",
"format":"date",
"description":"Minimum date that the date picker can show. Has the following format: `YYYY-MM-DD`."
},
"labelText":{
"type":"string",
"description":"Text to be shown next to the date field."
}
},
"title":"DatePickerPageOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerSelectionInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Identifier of returned page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle."
},
"item":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerSelectionItemInboundContent"
}
}
}
],
"required":[
"item",
"pageIdentifier",
"subtitle",
"type"
],
"title":"DatePickerSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerSelectionItemInboundContent":{
"type":"object",
"description":"Returned item.",
"properties":{
"title":{
"type":"string",
"description":"Title of the item."
},
"value":{
"type":"string",
"format":"date-time",
"description":"Value of the item."
}
},
"required":[
"title",
"value"
],
"title":"DatePickerSelectionItemInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultEventRequestOptions":{
"type":"object",
"description":"Options applicable to all events in the request.",
"properties":{
"schedule":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings"
}
},
"title":"DefaultEventRequestOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultMessageRequestOptions":{
"type":"object",
"description":"Options applicable to all messages in the request.",
"properties":{
"schedule":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings"
},
"tracking":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.UrlOptions"
}
},
"title":"DefaultMessageRequestOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryDay":{
"type":"string",
"description":"Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.",
"enum":[
"MONDAY",
"TUESDAY",
"WEDNESDAY",
"THURSDAY",
"FRIDAY",
"SATURDAY",
"SUNDAY"
],
"title":"DeliveryDay"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReport":{
"type":"object",
"description":"Collection of reports, one per every message.",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request."
},
"price":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError"
},
"messageId":{
"type":"string",
"description":"Unique message ID."
},
"to":{
"type":"string",
"description":"Message destination address."
},
"sender":{
"type":"string",
"description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)."
},
"sentAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"doneAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"The number of sent messages."
},
"mccMnc":{
"type":"string",
"description":"Mobile country and network codes."
},
"callbackData":{
"type":"string",
"description":"Callback data sent through ‛callbackData‛ field when sending message."
},
"platform":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"DeliveryReport"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReport"
}
}
},
"title":"DeliveryReports"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime":{
"type":"object",
"description":"The exact time of the day. The time is expressed in the UTC time zone.",
"properties":{
"hour":{
"type":"integer",
"format":"int32",
"description":"Hour when the time window opens when used in the `from` property or closes when used in the `to` property.",
"maximum":23,
"minimum":0
},
"minute":{
"type":"integer",
"format":"int32",
"description":"Minute when the time window opens when used in the `from` property or closes when used in the `to` property.",
"maximum":59,
"minimum":0
}
},
"required":[
"hour",
"minute"
],
"title":"DeliveryTime"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTimeWindow":{
"type":"object",
"description":"Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.",
"properties":{
"days":{
"type":"array",
"description":"Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryDay"
}
},
"from":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime"
},
"to":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime"
}
},
"required":[
"days"
],
"title":"DeliveryTimeWindow"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Event":{
"type":"object",
"description":"Object describing time picker's event.",
"properties":{
"identifier":{
"type":"string",
"description":"Identifier of the event."
},
"title":{
"type":"string",
"description":"Title of the event."
},
"timeslots":{
"type":"array",
"description":"An array of event's time slots.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.EventTimeslot"
}
},
"locationItem":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LocationItem"
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the event's image."
},
"timezoneOffset":{
"type":"integer",
"format":"int32",
"description":"Time zone offset from GMT in minutes. If not set, times are shown according to the customer’s current time zone.",
"maximum":840,
"minimum":-840
}
},
"required":[
"identifier",
"timeslots",
"title"
],
"title":"Event"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.EventTimeslot":{
"type":"object",
"description":"An array of event's time slots.",
"properties":{
"duration":{
"type":"integer",
"format":"int32",
"description":"Duration of the time slot in seconds.",
"minimum":0
},
"startTime":{
"type":"string",
"format":"date-time",
"description":"A UTC date string."
},
"identifier":{
"type":"string",
"description":"Identifier of the time slot."
}
},
"required":[
"duration",
"identifier",
"startTime"
],
"title":"EventTimeslot"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FailoverDestinationPair":{
"type":"object",
"description":"The SMS failover destination matching.",
"properties":{
"initial":{
"type":"string",
"description":"The initial destination address specified in the request."
},
"failover":{
"type":"string",
"description":"The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)"
}
},
"required":[
"failover",
"initial"
],
"title":"FailoverDestinationPair"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormData":{
"type":"object",
"description":"Data of the form.",
"properties":{
"pages":{
"type":"array",
"description":"An array of different pages to be shown in the form.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage"
}
},
"startPageIdentifier":{
"type":"string",
"description":"Identifier for the starting page of the form. Must match one of the string identifiers for the configured pages.",
"maxLength":20,
"minLength":0
},
"splash":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSplash"
},
"private":{
"type":"boolean",
"default":false,
"description":"Indicates whether to mark the response as private."
},
"showSummary":{
"type":"boolean",
"default":false,
"description":"If set to true then it shows the summary of all the selections made within the form."
}
},
"required":[
"pages",
"startPageIdentifier"
],
"title":"FormData"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage":{
"type":"object",
"description":"An array of different pages to be shown in the form.",
"discriminator":{
"propertyName":"type",
"mapping":{
"SELECT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectPage",
"PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerPage",
"DATE_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerPage",
"INPUT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputPage"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPageType"
}
},
"required":[
"type"
],
"title":"FormPage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPageType":{
"type":"string",
"enum":[
"SELECT",
"PICKER",
"DATE_PICKER",
"INPUT"
],
"title":"FormPageType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent":{
"type":"object",
"description":"Forms containing user responses.",
"discriminator":{
"propertyName":"type",
"mapping":{
"MULTI_SELECT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MultiSelectSelectionInboundContent",
"SELECT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectSelectionInboundContent",
"PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerSelectionInboundContent",
"DATE_PICKER":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DatePickerSelectionInboundContent",
"INPUT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputSelectionInboundContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContentType"
}
},
"required":[
"type"
],
"title":"FormSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContentType":{
"type":"string",
"enum":[
"PICKER",
"DATE_PICKER",
"INPUT",
"SELECT",
"MULTI_SELECT"
],
"title":"FormSelectionInboundContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionItemInboundContent":{
"type":"object",
"description":"Returned item.",
"properties":{
"title":{
"type":"string",
"description":"Title of the item."
},
"value":{
"type":"string",
"description":"Value of the item."
}
},
"required":[
"title",
"value"
],
"title":"FormSelectionItemInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSplash":{
"type":"object",
"description":"Shown at the start of the form.",
"properties":{
"buttonTitle":{
"type":"string",
"description":"Text on the button shown on the page. If missing then this view doesn't display and continues onto the first module."
},
"splashText":{
"type":"string",
"description":"If set, displays the body copy for the page."
},
"header":{
"type":"string",
"description":"If set, it displays in bold the title on the page underneath the image."
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the image to be shown at the top of the view."
}
},
"required":[
"buttonTitle",
"header",
"imageIdentifier",
"splashText"
],
"title":"FormSplash"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Image":{
"type":"object",
"description":"An array of images.",
"properties":{
"imageUrl":{
"type":"string",
"description":"URL of the image."
},
"identifier":{
"type":"string",
"description":"Identifier of the image. Each one should be unique per message."
}
},
"required":[
"identifier",
"imageUrl"
],
"title":"Image"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InboundMessageAppleMfbInboundContent":{
"type":"object",
"description":"Collection of mobile originated messages.",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"sender":{
"type":"string",
"description":"Number which sent the message."
},
"to":{
"type":"string",
"description":"Sender provided during the activation process."
},
"integrationType":{
"type":"string",
"description":"Integration type."
},
"receivedAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"keyword":{
"type":"string",
"description":"Keyword extracted from the message text."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the received message."
},
"pairedMessageId":{
"type":"string",
"description":"Message ID of paired outgoing message if matched by Infobip platform."
},
"callbackData":{
"type":"string",
"description":"Callback data sent through ‛callbackData‛ field when sending message."
},
"message":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent"
},
"price":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice"
}
},
"required":[
"integrationType",
"message",
"messageId",
"price",
"receivedAt",
"sender",
"to"
],
"title":"InboundMessageAppleMfbInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.IndiaDltOptions":{
"type":"object",
"description":"Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.",
"properties":{
"contentTemplateId":{
"type":"string",
"description":"Registered DLT content template ID which matches message you are sending."
},
"principalEntityId":{
"type":"string",
"description":"Your assigned DLT principal entity ID."
},
"telemarketerId":{
"type":"string",
"description":"Your assigned Telemarketer ID. (required for Aggregators)"
}
},
"required":[
"principalEntityId"
],
"title":"IndiaDltOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputPage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Unique identifier of the page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Question of the page."
},
"nextPageIdentifier":{
"type":"string",
"description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.",
"maxLength":20,
"minLength":0
},
"title":{
"type":"string",
"description":"Title of the page."
},
"submitForm":{
"type":"boolean",
"description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages."
},
"hintText":{
"type":"string",
"description":"Text to give the user more input context that displays below the Input field."
},
"options":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputPageOptions"
}
}
}
],
"required":[
"nextPageIdentifier",
"pageIdentifier",
"subtitle",
"type"
],
"title":"InputPage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputPageOptions":{
"type":"object",
"description":"Options of the page.",
"properties":{
"regex":{
"type":"string",
"description":"String representing a JSON encoded regular expression (regex) string to limit the type of input for input field to use."
},
"placeholder":{
"type":"string",
"description":"Text string used when there is no other text in the input text field."
},
"required":{
"type":"boolean",
"default":false,
"description":"When set to true, the next button on page is disabled until the user provides input"
},
"inputType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputType"
},
"labelText":{
"type":"string",
"description":"Text label shown to identify the input field. Only applies to inputType: SINGLELINE."
},
"prefixText":{
"type":"string",
"description":"String value representing optional text shown next to the text field. Only applies to inputType: SINGLELINE."
},
"maximumCharacterCount":{
"type":"integer",
"format":"int32",
"description":"Maximum field size in characters.",
"minimum":0
},
"keyboardType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.KeyboardType"
},
"appleTextContentType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TextContentType"
}
},
"title":"InputPageOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputSelectionInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Identifier of returned page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle."
},
"item":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionItemInboundContent"
}
}
}
],
"required":[
"item",
"pageIdentifier",
"subtitle",
"type"
],
"title":"InputSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InputType":{
"type":"string",
"default":"SINGLELINE",
"description":"Type of input.",
"enum":[
"MULTILINE",
"SINGLELINE"
],
"title":"InputType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataApplePayMessage":{
"type":"object",
"description":"Object describing received message bubble presented in Messages app.",
"properties":{
"title":{
"type":"string",
"description":"Title of the message.",
"maxLength":512,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle of the message.",
"maxLength":512,
"minLength":0
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the message's image."
}
},
"required":[
"title"
],
"title":"InteractiveDataApplePayMessage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessage":{
"type":"object",
"description":"Object describing reply message bubble presented in Messages app.",
"properties":{
"style":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessageStyle"
},
"title":{
"type":"string",
"description":"Title of the message.",
"maxLength":512,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle of the message.",
"maxLength":512,
"minLength":0
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the message's image."
}
},
"required":[
"title"
],
"title":"InteractiveDataMessage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InteractiveDataMessageStyle":{
"type":"string",
"description":"Style of the message.",
"enum":[
"ICON",
"SMALL",
"LARGE"
],
"title":"InteractiveDataMessageStyle"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.KeyboardType":{
"type":"string",
"default":"DEFAULT",
"description":"Type of keyboard to be shown.",
"enum":[
"DEFAULT",
"ASCII_CAPABLE",
"NUMBERS_AND_PUNCTUATION",
"URL",
"NUMBER_PAD",
"PHONE_PAD",
"NAME_PHONE_PAD",
"EMAIL_ADDRESS",
"DECIMAL_PAD",
"TWITTER_KEYBOARD",
"WEB_SEARCH"
],
"title":"KeyboardType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LineItem":{
"type":"object",
"description":"Total Values for all items.",
"properties":{
"type":{
"type":"string",
"description":"A value that indicates whether the line item is final or pending."
},
"label":{
"type":"string",
"description":"A short, localized description of the line item."
},
"amount":{
"type":"string",
"description":"The monetary amount of the line item."
}
},
"title":"LineItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPicker":{
"type":"object",
"description":"Object describing list picker's sections.",
"properties":{
"sections":{
"type":"array",
"description":"An array of list picker sections.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerSection"
}
}
},
"required":[
"sections"
],
"title":"ListPicker"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerItem":{
"type":"object",
"description":"An array of list picker items.",
"properties":{
"identifier":{
"type":"string",
"description":"Identifier of the item."
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the item's image."
},
"order":{
"type":"integer",
"format":"int32",
"description":"An integer representing the ordinal position for the item. If this field is missing, the item isn't sorted within the items array."
},
"subtitle":{
"type":"string",
"description":"Subtitle of the item."
},
"title":{
"type":"string",
"description":"Title of the item."
}
},
"required":[
"identifier",
"title"
],
"title":"ListPickerItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerSection":{
"type":"object",
"description":"An array of list picker sections.",
"properties":{
"items":{
"type":"array",
"description":"An array of list picker items.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerItem"
}
},
"order":{
"type":"integer",
"format":"int32",
"description":"An integer containing the ordinal in the sections array."
},
"title":{
"type":"string",
"description":"Title of the section."
},
"multipleSelection":{
"type":"boolean",
"default":false,
"description":"A Boolean that indicates whether the customer can make multiple selections within the section."
}
},
"required":[
"items",
"title"
],
"title":"ListPickerSection"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ListPickerSelectedItem":{
"type":"object",
"description":"List of selected items.",
"properties":{
"title":{
"type":"string",
"description":"A string field of the section title."
},
"identifier":{
"type":"string",
"description":" A string field identifying the item."
}
},
"required":[
"identifier",
"title"
],
"title":"ListPickerSelectedItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Location":{
"type":"object",
"description":"Location of the request.",
"properties":{
"position":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Position"
},
"radius":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Radius"
},
"altitude":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Altitude"
}
},
"title":"Location"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LocationItem":{
"type":"object",
"description":"Location of the event.",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"description":"Latitude of the location."
},
"longitude":{
"type":"number",
"format":"double",
"description":"Longitude of the location."
},
"radius":{
"type":"number",
"format":"double",
"description":"Radius of the location."
},
"title":{
"type":"string",
"description":"Title of the location."
}
},
"required":[
"latitude",
"longitude",
"title"
],
"title":"LocationItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogAppleMfbOutboundContent":{
"type":"object",
"description":"An array of message log results, one object per each message log entry.",
"properties":{
"sender":{
"type":"string",
"description":"The sender ID which can be alphanumeric or numeric."
},
"destination":{
"type":"string",
"description":"Message destination address."
},
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.",
"example":"BULK-ID-123-xyz"
},
"messageId":{
"type":"string",
"description":"Unique message ID for which a log is requested."
},
"sentAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the message was sent. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"doneAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"The number of messages content was split to."
},
"price":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError"
},
"platform":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform"
},
"content":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"LogAppleMfbOutboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogResponseLogAppleMfbOutboundContent":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"An array of message log results, one object per each message log entry.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogAppleMfbOutboundContent"
}
},
"cursor":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.CursorPageInfo"
}
},
"title":"LogResponseLogAppleMfbOutboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MerchantCapability":{
"type":"string",
"description":"An array of payment capabilities supported by the merchant. The array must include 3DS.",
"enum":[
"3DS",
"CREDIT",
"DEBIT",
"EMV"
],
"title":"MerchantCapability"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageDeliveryReporting":{
"type":"object",
"description":"Provides options for configuring the delivery report behavior.",
"properties":{
"url":{
"type":"string",
"description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`."
},
"intermediateReport":{
"type":"boolean",
"description":"The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`."
},
"notify":{
"type":"boolean",
"description":"Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply."
}
},
"title":"MessageDeliveryReporting"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError":{
"type":"object",
"description":"Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Error group ID."
},
"groupName":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageErrorGroup"
},
"id":{
"type":"integer",
"format":"int32",
"description":"Error ID."
},
"name":{
"type":"string",
"description":"[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes)."
},
"description":{
"type":"string",
"description":"Human-readable description of the error."
},
"permanent":{
"type":"boolean",
"description":"Indicates whether the error is recoverable or not."
}
},
"title":"MessageError"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageErrorGroup":{
"type":"string",
"description":"Error group name that describes which category the error code belongs to.",
"enum":[
"OK",
"HANDSET_ERRORS",
"USER_ERRORS",
"OPERATOR_ERRORS"
],
"title":"MessageErrorGroup"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageGeneralStatus":{
"type":"string",
"description":"Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).",
"enum":[
"ACCEPTED",
"PENDING",
"UNDELIVERABLE",
"DELIVERED",
"EXPIRED",
"REJECTED"
],
"title":"MessageGeneralStatus"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice":{
"type":"object",
"description":"Sent message price.",
"properties":{
"pricePerMessage":{
"type":"number",
"description":"Price per one message."
},
"currency":{
"type":"string",
"description":"The currency in which the price is expressed."
}
},
"title":"MessagePrice"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseDetails":{
"type":"object",
"description":"Other details of the message.",
"title":"MessageResponseDetails"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseMessageResponseDetails":{
"type":"object",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"properties":{
"messageId":{
"type":"string",
"description":"Unique message ID. If not provided, it will be auto-generated and returned in the API response."
},
"status":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus"
},
"destination":{
"type":"string",
"description":"The destination address of the message, i.e., its recipient."
},
"details":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseDetails"
}
},
"title":"MessageResponseMessageResponseDetails"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus":{
"type":"object",
"description":"Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID."
},
"groupName":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageGeneralStatus"
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status code ID."
},
"name":{
"type":"string",
"description":"[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name."
},
"description":{
"type":"string",
"description":"Human-readable description of the status."
},
"action":{
"type":"string",
"description":"Action to take to recover from the error."
}
},
"title":"MessageStatus"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MultiSelectSelectionInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Identifier of returned page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle."
},
"items":{
"type":"array",
"description":"Returned items.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionItemInboundContent"
},
"maxItems":2147483647,
"minItems":1
}
}
}
],
"required":[
"items",
"pageIdentifier",
"subtitle",
"type"
],
"title":"MultiSelectSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Network":{
"type":"string",
"description":"An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.",
"enum":[
"AMEX",
"CHINA_UNION_PAY",
"DISCOVER",
"ELECTRON",
"INTERAC",
"MAESTRO",
"MASTERCARD",
"PRIVATE_LABEL",
"VISA"
],
"title":"Network"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnMessageFailoverOptions":{
"type":"object",
"description":"Message options.",
"properties":{
"platform":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform"
},
"validityPeriod":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod"
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTimeWindow"
},
"campaignReferenceId":{
"type":"string",
"description":"ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.",
"maxLength":255,
"minLength":0
},
"smsFailover":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnSmsFailover"
}
},
"title":"NonMsisdnMessageFailoverOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnSmsFailover":{
"type":"object",
"description":"Failover SMS message to be sent if the original message could not be delivered.",
"properties":{
"sender":{
"type":"string",
"description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)."
},
"text":{
"type":"string",
"description":"Content of the message being sent."
},
"validityPeriod":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod"
},
"regional":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RegionalOptions"
},
"destinationMatching":{
"type":"array",
"description":"The SMS failover destination matching.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FailoverDestinationPair"
}
}
},
"required":[
"text"
],
"title":"NonMsisdnSmsFailover"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Parameter":{
"type":"object",
"description":"List of parameters.",
"properties":{
"name":{
"type":"string",
"description":"Name of the parameter."
},
"value":{
"type":"string",
"description":"Value of the parameter."
}
},
"required":[
"name"
],
"title":"Parameter"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PaymentConfiguration":{
"type":"object",
"description":"Customizable configuration which enables individual overrides of Portal settings.",
"properties":{
"merchantDomain":{
"type":"string",
"description":"The domain of the merchant's website."
},
"merchantDisplayName":{
"type":"string",
"description":"The merchant's display name."
},
"merchantPaymentGatewayUrl":{
"type":"string",
"description":"The URL of the merchant's payment gateway. This is the URL that Apple Pay uses to process payments."
},
"merchantCountryCode":{
"type":"string",
"description":"The two-letter ISO 3166 merchant’s country code.",
"pattern":"^[A-Z]{2}$"
},
"currencyCode":{
"type":"string",
"description":"The three-letter ISO 4217 currency code for the payment.",
"pattern":"^[A-Z]{3}$"
},
"merchantCapabilities":{
"type":"array",
"description":"An array of payment capabilities supported by the merchant. The array must include 3DS.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MerchantCapability"
}
},
"supportedNetworks":{
"type":"array",
"description":"An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Network"
}
},
"requiredBillingFields":{
"type":"array",
"description":"The list of the customer's required billing information needed to process the transaction.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ContactField"
}
},
"requiredShippingFields":{
"type":"array",
"description":"The list of shipping or contact information required from the customer to fulfill the order.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ContactField"
}
},
"paymentMethodUpdateUrl":{
"type":"string",
"description":"Called by Apple Pay when the user changes the payment method."
},
"shippingContactUpdateUrl":{
"type":"string",
"description":"Called by Apple Pay when the user changes their shipping address information."
},
"shippingMethodUpdateUrl":{
"type":"string",
"description":"Called by Apple Pay when the user changes the shipping method."
},
"orderTrackingUrl":{
"type":"string",
"description":"Called by Apple Pay after completing the order provides you with an opportunity to update the order information in your system."
},
"fallbackUrl":{
"type":"string",
"description":"A URL that opens in a web browser so the user can complete the purchase if their device is unable to make payments using Apple Pay."
}
},
"title":"PaymentConfiguration"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerPage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage"
},
{
"type":"object",
"properties":{
"items":{
"type":"array",
"description":"An array of objects defining the user experience.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerPageItem"
}
},
"pageIdentifier":{
"type":"string",
"description":"Unique identifier of the page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Question of the page."
},
"nextPageIdentifier":{
"type":"string",
"description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.",
"maxLength":20,
"minLength":0
},
"title":{
"type":"string",
"description":"Title of the page."
},
"submitForm":{
"type":"boolean",
"description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages."
},
"pickerTitle":{
"type":"string",
"description":"Text shown next to the picker text field."
},
"selectedItemIndex":{
"type":"integer",
"format":"int32",
"default":0,
"description":"A zero-indexed number identifying the item in the picker wheel should be selected by default.",
"minimum":0
}
}
}
],
"required":[
"items",
"nextPageIdentifier",
"pageIdentifier",
"subtitle",
"type"
],
"title":"PickerPage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerPageItem":{
"type":"object",
"description":"An array of objects defining the user experience.",
"properties":{
"title":{
"type":"string",
"description":"Title of the item."
},
"value":{
"type":"string",
"description":"Value of the item itself."
},
"identifier":{
"type":"string",
"description":"Unique identifier of the item."
}
},
"required":[
"identifier",
"title",
"value"
],
"title":"PickerPageItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.PickerSelectionInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Identifier of returned page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle."
},
"item":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionItemInboundContent"
}
}
}
],
"required":[
"item",
"pageIdentifier",
"subtitle",
"type"
],
"title":"PickerSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform":{
"type":"object",
"description":"Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
}
},
"title":"Platform"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Position":{
"type":"object",
"description":"Position of the location.",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"description":"Latitude.",
"maximum":90,
"minimum":-90
},
"longitude":{
"type":"number",
"format":"double",
"description":"Longitude.",
"maximum":180,
"minimum":-180
}
},
"required":[
"latitude",
"longitude"
],
"title":"Position"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.QuickReplyItem":{
"type":"object",
"description":"An array of possible replies.",
"properties":{
"identifier":{
"type":"string",
"description":"Unique item identifier."
},
"title":{
"type":"string",
"description":"Title of the quick reply item. Max 1 line of text."
}
},
"required":[
"identifier",
"title"
],
"title":"QuickReplyItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.QuickReplySelectedItem":{
"type":"object",
"description":"Selected quick reply.",
"properties":{
"identifier":{
"type":"string",
"description":"An identifier to identify the item."
},
"title":{
"type":"string",
"description":"Title of the quick reply item. Max 1 line of text."
}
},
"required":[
"identifier",
"title"
],
"title":"QuickReplySelectedItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Radius":{
"type":"object",
"description":"Radius around the location.",
"properties":{
"value":{
"type":"number",
"format":"double",
"description":"Value of radius."
},
"unit":{
"type":"string",
"description":"Unit of radius value."
}
},
"required":[
"unit",
"value"
],
"title":"Radius"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RecipientType":{
"type":"string",
"description":"Recipient Type must be `TACIR` or `BIREYSEL`.",
"enum":[
"BIREYSEL",
"TACIR"
],
"title":"RecipientType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RegionalOptions":{
"type":"object",
"description":"Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.",
"properties":{
"indiaDlt":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.IndiaDltOptions"
},
"turkeyIys":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TurkeyIysOptions"
},
"southKorea":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SouthKoreaOptions"
}
},
"title":"RegionalOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings":{
"type":"object",
"description":"Options for scheduling a message.",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.",
"maxLength":100,
"minLength":0
},
"sendAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance."
},
"sendingSpeedLimit":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SendingSpeedLimit"
}
},
"title":"RequestSchedulingSettings"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails":{
"type":"object",
"properties":{
"bulkId":{
"type":"string",
"description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs."
},
"messages":{
"type":"array",
"description":"An array of message objects of a single message or multiple messages sent under one bulk ID.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseMessageResponseDetails"
}
}
},
"required":[
"messages"
],
"title":"ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent":{
"type":"object",
"description":"Event from roadside assistance satellite communication.",
"discriminator":{
"propertyName":"type",
"mapping":{
"REQUEST":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceRequestInboundContent",
"TEXT":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceTextInboundContent",
"LOCATION":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceLocationInboundContent",
"STATUS":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceStatusInboundContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContentType"
}
},
"title":"RoadsideAssistanceInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContentType":{
"type":"string",
"enum":[
"REQUEST",
"TEXT",
"LOCATION",
"STATUS"
],
"title":"RoadsideAssistanceInboundContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceLocationInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent"
},
{
"type":"object",
"properties":{
"messageNumber":{
"type":"integer",
"format":"int32",
"description":"Number of the message in a conversation."
},
"position":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Position"
},
"radius":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Radius"
},
"altitude":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Altitude"
}
}
}
],
"required":[
"altitude",
"messageNumber",
"position",
"radius"
],
"title":"RoadsideAssistanceLocationInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceRequestInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent"
},
{
"type":"object",
"properties":{
"request":{
"type":"object",
"additionalProperties":{
"type":"object"
},
"description":"Contains details filled in request questionnaire."
},
"location":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Location"
}
}
}
],
"required":[
"location",
"request"
],
"title":"RoadsideAssistanceRequestInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceStatusInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent"
},
{
"type":"object",
"properties":{
"status":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RsaStatus"
}
}
}
],
"required":[
"status"
],
"title":"RoadsideAssistanceStatusInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceTextInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RoadsideAssistanceInboundContent"
},
{
"type":"object",
"properties":{
"messageNumber":{
"type":"integer",
"format":"int32",
"description":"Number of the message in a conversation."
},
"text":{
"type":"string",
"description":"Received message text."
}
}
}
],
"required":[
"messageNumber",
"text"
],
"title":"RoadsideAssistanceTextInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RsaStatus":{
"type":"string",
"description":"Status of Satellite communication.",
"enum":[
"SATELLITE_UNAVAILABLE"
],
"title":"RsaStatus"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectPage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormPage"
},
{
"type":"object",
"properties":{
"items":{
"type":"array",
"description":"An array of objects defining the user experience.",
"items":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectPageItem"
}
},
"pageIdentifier":{
"type":"string",
"description":"Unique identifier of the page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Question of the page."
},
"nextPageIdentifier":{
"type":"string",
"description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.",
"maxLength":20,
"minLength":0
},
"title":{
"type":"string",
"description":"Title of the page."
},
"submitForm":{
"type":"boolean",
"description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages."
},
"multipleSelection":{
"type":"boolean",
"default":false,
"description":"Enables multiple selection for the page."
}
}
}
],
"required":[
"items",
"nextPageIdentifier",
"pageIdentifier",
"subtitle",
"type"
],
"title":"SelectPage"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectPageItem":{
"type":"object",
"description":"An array of objects defining the user experience.",
"properties":{
"identifier":{
"type":"string",
"description":"Unique identifier of the item."
},
"title":{
"type":"string",
"description":"Title of the item."
},
"value":{
"type":"string",
"description":"Value of the item itself."
},
"nextPageIdentifier":{
"type":"string",
"description":"Identifier of the next page. Set this value only when multipleSelection is not defined or set to false.",
"maxLength":20,
"minLength":0
},
"imageIdentifier":{
"type":"string",
"description":"Identifier of the item's image."
}
},
"required":[
"identifier",
"title",
"value"
],
"title":"SelectPageItem"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SelectSelectionInboundContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionInboundContent"
},
{
"type":"object",
"properties":{
"pageIdentifier":{
"type":"string",
"description":"Identifier of returned page.",
"maxLength":20,
"minLength":0
},
"subtitle":{
"type":"string",
"description":"Subtitle."
},
"item":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FormSelectionItemInboundContent"
}
}
}
],
"required":[
"item",
"pageIdentifier",
"subtitle",
"type"
],
"title":"SelectSelectionInboundContent"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SendingSpeedLimit":{
"type":"object",
"description":"Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches."
},
"timeUnit":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SpeedLimitTimeUnit"
}
},
"required":[
"amount"
],
"title":"SendingSpeedLimit"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SouthKoreaOptions":{
"type":"object",
"description":"Use case dependent parameters for sending SMS to phone numbers registered in South Korea.",
"properties":{
"title":{
"type":"string",
"description":"Title of the message.",
"maxLength":66,
"minLength":0
},
"resellerCode":{
"type":"integer",
"format":"int32",
"description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending."
}
},
"title":"SouthKoreaOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SpeedLimitTimeUnit":{
"type":"string",
"default":"MINUTE",
"description":"The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.",
"enum":[
"MINUTE",
"HOUR",
"DAY"
],
"title":"SpeedLimitTimeUnit"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TextContentType":{
"type":"string",
"description":"Value representing the keyboard and system information about the expected semantic meaning for the content that users enter.",
"enum":[
"NAME_PREFIX",
"GIVEN_NAME",
"MIDDLE_NAME",
"FAMILY_NAME",
"NAME_SUFFIX",
"NICKNAME",
"JOB_TITLE",
"ORGANIZATION_NAME",
"LOCATION",
"FULL_STREET_ADDRESS",
"STREET_ADDRESS_LINE_1",
"STREET_ADDRESS_LINE_2",
"ADDRESS_CITY",
"ADDRESS_STATE",
"ADDRESS_CITY_STATE",
"SUBLOCALITY",
"COUNTRY_NAME",
"POSTAL_CODE",
"TELEPHONE_NUMBER",
"EMAIL_ADDRESS",
"URL",
"CREDIT_CARD_NUMBER",
"USERNAME",
"PASSWORD",
"NEW_PASSWORD",
"ONE_TIME_CODE"
],
"title":"TextContentType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination":{
"type":"object",
"description":"An array of destination objects for where messages are being sent. A valid destination is required.",
"properties":{
"to":{
"type":"string",
"description":"The destination address of the message."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":200,
"minLength":0
}
},
"required":[
"to"
],
"title":"Destination"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TurkeyIysOptions":{
"type":"object",
"description":"IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.",
"properties":{
"brandCode":{
"type":"integer",
"format":"int32",
"description":"Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account."
},
"recipientType":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RecipientType"
}
},
"required":[
"recipientType"
],
"title":"TurkeyIysOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TypingIndicatorType":{
"type":"string",
"description":"Type of the indicator being sent",
"enum":[
"TYPING_START",
"TYPING_END"
],
"title":"TypingIndicatorType"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.UrlOptions":{
"type":"object",
"description":"Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Available only for `linkUrl` field of RICH_LINK.",
"properties":{
"shortenUrl":{
"type":"boolean",
"default":true,
"description":"Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options."
},
"trackClicks":{
"type":"boolean",
"default":true,
"description":"Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom."
},
"trackingUrl":{
"type":"string",
"description":"The URL of your callback server on to which the Click report will be sent."
},
"removeProtocol":{
"type":"boolean",
"default":false,
"description":"Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL."
},
"customDomain":{
"type":"string",
"description":"Select a predefined custom domain to use when generating a short URL."
}
},
"title":"UrlOptions"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod":{
"type":"object",
"description":"Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.",
"properties":{
"amount":{
"type":"integer",
"format":"int32",
"description":"Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`."
},
"timeUnit":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"ValidityPeriod"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriodTimeUnit":{
"type":"string",
"default":"MINUTES",
"description":"Message validity period time unit.",
"enum":[
"SECONDS",
"MINUTES",
"HOURS"
],
"title":"ValidityPeriodTimeUnit"
},
"91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Webhooks":{
"type":"object",
"description":"Provides options for configuring message webhooks.",
"properties":{
"delivery":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageDeliveryReporting"
},
"contentType":{
"type":"string",
"description":"Preferred delivery report content type, `application/json` or `application/xml`."
},
"callbackData":{
"type":"string",
"description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.",
"maxLength":4000,
"minLength":0
}
},
"title":"Webhooks"
},
"ApiError":{
"type":"object",
"properties":{
"errorCode":{
"type":"string",
"description":"An error code uniquely identifying the error case."
},
"description":{
"type":"string",
"description":"A detailed description of an error."
},
"action":{
"type":"string",
"description":"An action that should be taken to recover from the error."
},
"violations":{
"type":"array",
"description":"List of violations that caused the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorViolation"
}
},
"resources":{
"type":"array",
"description":"List of available resources to recover from the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorResource"
}
}
},
"required":[
"action",
"description",
"errorCode",
"resources",
"violations"
],
"title":"ApiError"
},
"ApiErrorResource":{
"type":"object",
"description":"List of available resources to recover from the error.",
"properties":{
"name":{
"type":"string",
"description":"Resource name."
},
"url":{
"type":"string",
"description":"Resource URL."
}
},
"title":"ApiErrorResource"
},
"ApiErrorViolation":{
"type":"object",
"description":"List of violations that caused the error.",
"properties":{
"property":{
"type":"string",
"description":"Request property that caused the error."
},
"violation":{
"type":"string",
"description":"Detailed violation description."
}
},
"title":"ApiErrorViolation"
}
},
"responses":{
"ApiError401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E401",
"description":"The request lacks valid authentication credentials for the requested resource.",
"action":"Check the resources and adjust authentication credentials.",
"violations":[],
"resources":[
{
"name":"API Authentication",
"url":"https://www.infobip.com/docs/essentials/api-authentication"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n"
}
}
},
"ApiError403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E403",
"description":"Insufficient permissions to access the requested resource.",
"action":"Repeat the request with new or different credentials.",
"violations":[],
"resources":[
{
"name":"API Scopes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n"
}
}
},
"ApiError429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E429",
"description":"Too many requests sent.",
"action":"Check request rate limit specified in the API endpoint documentation resource.",
"violations":[],
"resources":[
{
"name":"Throttling handling errors",
"url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n"
}
}
},
"ApiError500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E500",
"description":"Something went wrong.",
"action":"Contact the support.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n"
}
}
}
},
"parameters":{},
"examples":{},
"requestBodies":{},
"headers":{},
"securitySchemes":{
"APIKeyHeader":{
"type":"apiKey",
"description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n",
"name":"Authorization",
"in":"header"
},
"Basic":{
"type":"http",
"description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n",
"scheme":"basic"
},
"IBSSOTokenHeader":{
"type":"apiKey",
"description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n",
"name":"Authorization",
"in":"header"
},
"OAuth2":{
"type":"oauth2",
"description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```",
"flows":{
"clientCredentials":{
"tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
"scopes":{}
}
}
}
},
"links":{},
"callbacks":{}
},
"webhooks":{
"receive-outbound-apple-mfb-message-delivery-reports":{
"post":{
"tags":[
"channels",
"apple-mfb",
"logs-and-status-reports-apple-mfb"
],
"summary":"Receive Apple Messages for Business delivery reports",
"description":"For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.",
"externalDocs":{
"description":"Learn more about Apple Messages for Business channel and use cases",
"url":"https://www.infobip.com/docs/apple-messages-for-business"
},
"operationId":"receive-outbound-apple-mfb-message-delivery-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":{
"results":[
{
"bulkId":"1688025180464000013",
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":0,
"name":"NO_ERROR",
"description":"No Error",
"permanent":false
},
"messageId":"1688025180464000014",
"to":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"sender":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"sentAt":"2023-09-26T10:52:15.457+0000",
"doneAt":"2023-09-26T10:52:15.799+0000",
"messageCount":1,
"mccMnc":"22801",
"platform":{
"entityId":"promotional-traffic-entity",
"applicationId":"marketing-automation-application"
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":"\n \n \n 1688025180464000013\n \n 0.15\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n 1688025180464000014\n a42fa0e0-1d5f-44f6-a321-0e40300f7712\n urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=\n 2023-09-26T10:52:15.457+0000\n 2023-09-26T10:52:15.799+0000\n 1\n 22801\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n"
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-messages-apple-mfb-incoming-messages":{
"post":{
"tags":[
"channels",
"apple-mfb",
"incoming-apple-mfb-message"
],
"summary":"Receive incoming message",
"description":"Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.",
"externalDocs":{
"description":"Learn more about Apple Messages for Business channel and use cases",
"url":"https://www.infobip.com/docs/apple-messages-for-business"
},
"operationId":"receive-messages-apple-mfb-incoming-messages",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundResponse"
},
"examples":{
"Text message response example":{
"summary":"Text message response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"text":"Text",
"attachments":[
{
"fileName":"filename",
"downloadId":"downloadId",
"url":"http://image.url"
}
],
"type":"TEXT"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Typing Indicator response example":{
"summary":"Typing Indicator response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"typingIndicatorType":"TYPING_START",
"type":"TYPING_INDICATOR"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"List Picker response example":{
"summary":"List Picker response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"listPickerSelectedItems":[
{
"title":"item title",
"identifier":"selectedIdentifier"
}
],
"type":"LIST_PICKER_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Time Picker response example":{
"summary":"Time Picker response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"selectedTime":"2023-05-29T00:00:00.000+0000",
"selectedDuration":30,
"timezoneOffset":1,
"selectedTimeslotIdentifier":"identifier",
"type":"TIME_PICKER_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Authentication response example":{
"summary":"Authentication response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"authenticated":true,
"authenticationCode":"auth_code",
"errorCode":0,
"type":"AUTHENTICATION_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Apple Pay response example":{
"summary":"Apple Pay response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"paid":true,
"lineItems":[
{
"type":"type",
"label":"label",
"amount":"1"
}
],
"total":{
"type":"type",
"label":"label",
"amount":"1"
},
"type":"APPLE_PAY_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Custom Interactive response example":{
"summary":"Custom Interactive response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"urlData":[
{
"name":"param1",
"value":"value1"
},
{
"name":"param2",
"value":"value2"
}
],
"urlRawData":"param1,value1",
"sessionIdentifier":"givenSessionIdentifier",
"attachments":[
{
"fileName":"filename",
"downloadId":"downloadId",
"url":"http://image.url"
}
],
"type":"CUSTOM_INTERACTIVE_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Close Conversation response example":{
"summary":"Close Conversation response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"type":"CLOSE_CONVERSATION"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Quick Reply response example":{
"summary":"Quick Reply response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"quickReplySelectedItem":{
"identifier":"quick_reply_id",
"title":"title"
},
"type":"QUICK_REPLY"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Form response example":{
"summary":"Form response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"privateForm":true,
"selections":[
{
"pageIdentifier":"pageIdentifier",
"subtitle":"subtitle",
"item":{
"title":"title",
"value":"value"
},
"type":"INPUT"
}
],
"type":"FORM_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
},
"Invitation response example":{
"summary":"Invitation response example",
"value":{
"results":[
{
"sender":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"to":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"integrationType":"APPLE_BC",
"receivedAt":"2023-01-01T00:00:00.000+0000",
"messageId":"1688025180464000014",
"callbackData":"callbackData",
"message":{
"context":{
"intent":"Intent",
"group":"group",
"locale":"en_UK",
"capabilityList":[
"AUTHENTICATION_REQUEST",
"FORM",
"LIST_PICKER",
"QUICK_REPLY",
"TIME_PICKER"
]
},
"requestIdentifier":"givenRequestIdentifier",
"choice":"YES",
"type":"INVITATION_RESPONSE"
},
"price":{
"pricePerMessage":0,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":0
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
}
}
}