{ "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:23:55.585419342Z" }, "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":"sms", "description":"SMS (Short Message Service) is the most extensive messaging service available in terms of reach and coverage. A SMS can be sent to and from any mobile device in the world and does not necessarily require a data connection.\n\nInfobip SMS API allows you to send and receive text messages (SMS), fetch or receive delivery reports on your endpoint in real time, and see message logs. You can send messages in different languages, schedule your messages, define delivery time window, and much more.\n\nTo utilize SMS in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n", "x-type":"product", "x-displayName":"SMS" }, { "name":"outbound-sms", "description":"When you send an SMS to a phone number belonging to an end user's device you are sending an Outbound SMS. Historically, this was and still is referred to as a Mobile Terminated (MT) SMS, though nowadays an SMS is not always sent to a mobile device. In an Outbound SMS you can set the From or Sender field with whatever you have registered or purchased with Infobip, either a Long Number, Short Code, or text based Sender.\n", "x-type":"module", "x-displayName":"Outbound SMS" }, { "name":"send-message", "description":"", "x-type":"section", "x-displayName":"Send a message" }, { "name":"manage-scheduled-sms-messages", "description":"", "x-type":"section", "x-displayName":"Manage Scheduled SMS Messages" }, { "name":"confirm-conversion", "description":"", "x-type":"section", "x-displayName":"Confirm conversion" }, { "name":"inbound-sms", "description":"When an end user sends an SMS from their device to a Phone Number or Short Code they have sent an Inbound SMS. The Inbound SMS is routed to the Infobip Platform and Infobip in turn routes the SMS to its Customer who has purchased that Phone Number or Short Code. Inbound SMS, for historical reasons, are referred to as Mobile Originated (MO) SMS.\n", "x-type":"module", "x-displayName":"Inbound SMS" }, { "name":"logs-and-status-reports", "description":"Status Reports tell you what happened to the SMS you sent, whether it was successfully delivered or failed to be delivered.\nThey also provide timestamps, network information if available, and on SMS delivery failure, a status code indicating the reason. \nStatus Reports can be pushed in real-time to a Customer's webhook or can be retrieved by an API call. \nLogs provide similar information to Status Reports but are available to query for 48hrs.\n", "x-type":"module", "x-displayName":"Logs and Status Reports" } ], "paths":{ "/sms/3/messages":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send SMS message", "description":"With this API method, you can do anything from sending a basic message to one person, all the way to sending customized messages to thousands of recipients in one go. It comes with a range of useful features like transliteration, scheduling, and tracking in a unified way.\\\nIf utilizing Message Delivery Reports webhook, please consult the documentation provided at [Receive outbound SMS message reports](#channels/sms/receive-outbound-sms-message-report-v3).\\\nThis endpoint is the successor of [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message).", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope" }, "examples":{ "Send basic textual message":{ "summary":"Send basic textual message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"This is a sample message" } } ] } }, "Send fully-featured textual message":{ "summary":"Send fully-featured textual message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727", "messageId":"MESSAGE-ID-123-xyz" }, { "to":"41793026834" } ], "content":{ "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "transliteration":"TURKISH", "language":{ "languageCode":"TR" } }, "options":{ "validityPeriod":{ "amount":720, "timeUnit":"HOURS" }, "campaignReferenceId":"summersale" }, "webhooks":{ "delivery":{ "url":"https://www.example.com/sms/advanced", "intermediateReport":true }, "contentType":"application/json", "callbackData":"DLR callback data" } }, { "sender":"41793026700", "destinations":[ { "to":"41793026700" } ], "content":{ "text":"A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire." }, "options":{ "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } } } } ], "options":{ "schedule":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-24T15:00:00.000+0000" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/click-report", "removeProtocol":true, "customDomain":"example.com" }, "includeSmsCountInResponse":true, "conversionTracking":{ "useConversionTracking":true, "conversionTrackingName":"MY_CAMPAIGN" } } } }, "Send flash textual message":{ "summary":"Send flash textual message", "description":"Send a message that will pop-up on the user's phone", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Toto, I've got a feeling we're not in Kansas anymore." }, "options":{ "flash":true } } ] } }, "SMS language":{ "summary":"SMS language", "description":"Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "language":{ "languageCode":"TR" } } } ] } }, "SMS transliteration":{ "summary":"SMS transliteration", "description":"Send full-size messages in original language alphabet using transliteration conversion", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα", "transliteration":"GREEK" } } ] } }, "Platform features":{ "summary":"Platform features", "description":"Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "content":{ "text":"Custom application and entity based rules will be applied to this message" }, "options":{ "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } } ] } }, "Send Basic India DLT message":{ "summary":"Send Basic India DLT message", "description":"Send a message with India DLT parameters included", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "text":"India DLT parameters will be applied in this message" }, "options":{ "regional":{ "indiaDlt":{ "contentTemplateId":"1111111111111111111", "principalEntityId":"1111111111111111112", "telemarketerId":"111111111111" } } } } ] } }, "Send fully-featured binary SMS message":{ "summary":"Send fully-featured binary SMS message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727", "messageId":"MESSAGE-ID-123-xyz" }, { "to":"41793026834" } ], "content":{ "dataCoding":0, "esmClass":0, "hex":"54 65 73 74 20 6d 65 73 73 61 67 65 2e" }, "options":{ "validityPeriod":{ "amount":720, "timeUnit":"HOURS" } }, "webhooks":{ "delivery":{ "url":"https://www.example.com/sms/advanced", "intermediateReport":true }, "contentType":"application/json", "callbackData":"DLR callback data" } }, { "sender":"41793026700", "destinations":[ { "to":"41793026700" } ], "content":{ "dataCoding":0, "esmClass":0, "hex":"41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E" }, "options":{ "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } }, "campaignReferenceId":"summersale" } } ], "options":{ "schedule":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-23T14:00:00.000+0000" } } } }, "Send Unicode flash binary SMS message":{ "summary":"Send Unicode flash binary SMS message", "value":{ "messages":[ { "sender":"InfoSMS", "destinations":[ { "to":"41793026727" } ], "content":{ "dataCoding":8, "esmClass":0, "hex":"0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf" }, "options":{ "flash":true } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope" }, "examples":{ "Send basic textual message":{ "summary":"Send basic textual message", "value":"\n \n \n InfoSMS\n \n This is a sample message\n \n \n \n 41793026727\n \n \n \n \n\n" }, "Send fully-featured textual message":{ "summary":"Send fully-featured textual message", "value":"\n \n \n BULK-ID-123-xyz\n 2021-08-24T15:00:00.000+0000\n \n \n true\n true\n https://example.com/click-report\n true\n example.com\n \n true\n \n true\n MY_CAMPAIGN\n \n \n \n \n InfoSMS\n \n Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\n TURKISH\n \n TR\n \n \n \n \n 720\n HOURS\n \n summersale\n \n \n \n https://www.example.com/sms/advanced\n true\n \n application/json\n DLR callback data\n \n \n \n 41793026727\n MESSAGE-ID-123-xyz\n \n \n 41793026834\n \n \n \n \n 41793026700\n \n A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.\n \n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n \n \n \n 41793026700\n \n \n \n \n\n" }, "Send flash textual message":{ "summary":"Send flash textual message", "description":"Send a message that will pop-up on the user's phone", "value":"\n \n \n InfoSMS\n \n Toto, I've got a feeling we're not in Kansas anymore.\n \n \n true\n \n \n \n 41793026727\n \n \n \n \n\n" }, "SMS language":{ "summary":"SMS language", "description":"Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese", "value":"\n \n \n InfoSMS\n \n Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\n \n TR\n \n \n \n \n 41793026727\n \n \n \n \n\n" }, "SMS transliteration":{ "summary":"SMS transliteration", "description":"Send full-size messages in original language alphabet using transliteration conversion", "value":"\n \n \n InfoSMS\n \n Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα\n GREEK\n \n \n \n 41793026727\n \n \n \n \n\n" }, "Platform features":{ "summary":"Platform features", "description":"Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "value":"\n \n \n \n Custom application and entity based rules will be applied to this message\n \n \n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n \n 41793026727\n \n \n \n \n\n" }, "Send Basic India DLT message":{ "summary":"Send Basic India DLT message", "description":"Send a message with India DLT parameters included", "value":"\n \n \n InfoSMS\n \n India DLT parameters will be applied in this message\n \n \n \n \n 1111111111111111111\n 1111111111111111112\n 111111111111\n \n \n \n \n \n 41793026727\n \n \n \n \n\n" }, "Send fully-featured binary SMS message":{ "summary":"Send fully-featured binary SMS message", "value":"\n \n \n BULK-ID-123-xyz\n 2021-08-23T14:00:00.000+0000\n \n \n \n \n InfoSMS\n \n 0\n 0\n 54 65 73 74 20 6d 65 73 73 61 67 65 2e\n \n \n \n 720\n HOURS\n \n \n \n \n https://www.example.com/sms/advanced\n true\n \n application/json\n DLR callback data\n \n \n \n 41793026727\n MESSAGE-ID-123-xyz\n \n \n 41793026834\n \n \n \n \n 41793026700\n \n 0\n 0\n 41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E\n \n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n summersale\n \n \n \n 41793026700\n \n \n \n \n\n" }, "Send Unicode flash binary SMS message":{ "summary":"Send Unicode flash binary SMS message", "value":"\n \n \n InfoSMS\n \n 8\n 0\n 0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf\n \n \n true\n \n \n \n 41793026727\n \n \n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"41793026727", "details":{ "messageCount":1 } } ] } }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"41793026727", "details":{ "messageCount":1 } }, { "messageId":"3350be2d4219-3af1-23343-bbbb-1362af1edfd3", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"41435675123", "details":{ "messageCount":1 } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message sent to next instance\n \n 41793026727\n
\n 1\n
\n
\n
\n
\n" }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message sent to next instance\n \n 41793026727\n
\n 1\n
\n
\n \n 3350be2d4219-3af1-23343-bbbb-1362af1edfd3\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message sent to next instance\n \n 41435675123\n
\n 1\n
\n
\n
\n
\n" } } } } }, "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":[] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n property.path\n Violation message.\n \n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)\n- [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)\n" }, "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"send-sms-messages" }, { "versionNumber":2, "latest":false, "operationId":"send-sms-message" }, { "versionNumber":2, "latest":false, "operationId":"send-binary-sms-message" } ] } }, "/sms/3/text/query":{ "get":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send SMS message over query parameters", "description":"All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-messages) is not an option for your use case!
**Note:** Make sure that special characters are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide. This endpoint is the successor of [Send SMS message over query parameters](#channels/sms/send-sms-message-over-query-parameters).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-messages-over-query-parameters", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":100, "minLength":0 } }, { "name":"from", "in":"query", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"InfoSMS" }, { "name":"to", "in":"query", "description":"List of message recipients.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"41793026727,41793026834" }, { "name":"text", "in":"query", "description":"Content of the message being sent.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Message text" }, { "name":"flash", "in":"query", "description":"Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"transliteration", "in":"query", "description":"Conversion of a message text from one script to another.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TURKISH" }, { "name":"languageCode", "in":"query", "description":"Code for language character set of a message content.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TR" }, { "name":"intermediateReport", "in":"query", "description":"Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report-v3) that will be sent on your callback server.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"notifyUrl", "in":"query", "description":"The URL on your call back server on to which a delivery report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"https://www.example.com" }, { "name":"notifyContentType", "in":"query", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"application/json" }, { "name":"callbackData", "in":"query", "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](#channels/sms/get-outbound-sms-message-delivery-reports-v3). The maximum value is 4000 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":4000, "minLength":0 }, "example":"callbackData" }, { "name":"validityPeriod", "in":"query", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":720 }, { "name":"sendAt", "in":"query", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" } }, { "name":"includeSmsCountInResponse", "in":"query", "description":"Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted. ", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"trackingUrl", "in":"query", "description":"The URL of your callback server on to which the Click report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"trackingType", "in":"query", "description":"Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Custom tracking type" }, { "name":"indiaDltContentTemplateId", "in":"query", "description":"The ID of your registered DLT (Distributed Ledger Technology) content template.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111111" }, { "name":"indiaDltPrincipalEntityId", "in":"query", "description":"Your DLT (Distributed Ledger Technology) entity id.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111112" }, { "name":"indiaDltTelemarketerId", "in":"query", "description":"Your assigned Telemarketer ID. (required for Aggregators)", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":111111111111 }, { "name":"turkeyIysBrandCode", "in":"query", "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.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"turkeyIysRecipientType", "in":"query", "description":"Recipient Type must be TACIR or BIREYSEL", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"southKoreaResellerCode", "in":"query", "description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"southKoreaTitle", "in":"query", "description":"Title of the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Title of the message.", "maxLength":66, "minLength":0 } } ], "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"41793026727", "details":{ "messageCount":1 } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n 1\n PENDING\n 26\n PENDING_ACCEPTED\n Message sent to next instance\n \n 41793026727\n
\n 1\n
\n
\n
\n
\n" } } } } }, "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", "sms:message:send", "sms:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)\n- [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)\n" }, "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"send-sms-messages-over-query-parameters" }, { "versionNumber":1, "latest":false, "operationId":"send-sms-message-over-query-parameters" } ] } }, "/sms/1/text/query":{ "get":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send SMS message over query parameters", "description":"All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-message) is not an option for your use case!
**Note:** Make sure that special characters and user credentials are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-message-over-query-parameters", "parameters":[ { "name":"username", "in":"query", "description":"Username for authentication.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"password", "in":"query", "description":"Password for authentication.", "required":true, "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. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"from", "in":"query", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"InfoSMS" }, { "name":"to", "in":"query", "description":"List of message recipients.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"41793026727,41793026834" }, { "name":"text", "in":"query", "description":"Content of the message being sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Message text" }, { "name":"flash", "in":"query", "description":"Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"transliteration", "in":"query", "description":"Conversion of a message text from one script to another.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TURKISH" }, { "name":"languageCode", "in":"query", "description":"Code for language character set of a message content.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"TR" }, { "name":"intermediateReport", "in":"query", "description":"Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) that will be sent on your callback server.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":true }, { "name":"notifyUrl", "in":"query", "description":"The URL on your call back server on to which a delivery report will be sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"https://www.example.com" }, { "name":"notifyContentType", "in":"query", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"application/json" }, { "name":"callbackData", "in":"query", "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](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":4000, "minLength":0 }, "example":"callbackData" }, { "name":"validityPeriod", "in":"query", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":720 }, { "name":"sendAt", "in":"query", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" } }, { "name":"track", "in":"query", "description":"Sets the conversion element to be tracked. Possible values: `SMS` and `URL`. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"URL" }, { "name":"processKey", "in":"query", "description":"The process key which uniquely identifies conversion tracking.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"trackingType", "in":"query", "description":"Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Custom tracking type" }, { "name":"indiaDltContentTemplateId", "in":"query", "description":"The ID of your registered DLT (Distributed Ledger Technology) content template.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111111" }, { "name":"indiaDltPrincipalEntityId", "in":"query", "description":"Your DLT (Distributed Ledger Technology) entity id.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"1111111111111111112" }, { "name":"indiaDltTelemarketerId", "in":"query", "description":"Your assigned Telemarketer ID. (required for Aggregators)", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":111111111111 }, { "name":"turkeyIysBrandCode", "in":"query", "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.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } }, { "name":"turkeyIysRecipientType", "in":"query", "description":"Recipient Type must be TACIR or BIREYSEL", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"southKoreaResellerCode", "in":"query", "description":"Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" } } ], "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026727", "smsCount":1 } ] } }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":{ "bulkId":"2034072219640523073", "messages":[ { "messageId":"2033247207850523791", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026727", "smsCount":1 }, { "messageId":"2033247207850523792", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ENROUTE" }, "to":"41793026834", "smsCount":1 } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ENROUTE\n \n 41793026727\n 1\n \n \n\n" }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":"\n 2034072219640523073\n \n \n 2033247207850523791\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ENROUTE\n \n 41793026727\n 1\n \n \n 2033247207850523792\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ENROUTE\n \n 41793026834\n 1\n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-deprecationInformation":{ "deprecation":"2024-10-09T12:00:00.00+0000", "successorOperationId":"send-sms-messages-over-query-parameters" }, "x-additionalInfo":{ "markdown":"### Related\n- [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)\n- [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)\n" }, "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"send-sms-messages-over-query-parameters" }, { "versionNumber":1, "latest":false, "operationId":"send-sms-message-over-query-parameters" } ] } }, "/sms/1/preview":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Preview SMS message", "description":"Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"preview-sms-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest" }, "examples":{ "Preview message count and remaining characters":{ "summary":"Preview message count and remaining characters", "description":"Use this method to check how many characters are left in your message and if it fits into one or more messages.", "value":{ "text":"Let's see how many characters remain unused in this message." } }, "Preview with message language":{ "summary":"Preview with message language", "description":"In this example we will request a message preview for Turkish language by introducing the languageCode parameter.", "value":{ "text":"Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.", "languageCode":"TR" } }, "Preview with transliteration":{ "summary":"Preview with transliteration", "description":"Transliteration is a technique that replaces the original special characters", "value":{ "text":"Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα", "transliteration":"GREEK" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest" }, "examples":{ "Preview message count and remaining characters":{ "summary":"Preview message count and remaining characters", "description":"Use this method to check how many characters are left in your message and if it fits into one or more messages.", "value":"\n Let's see how many characters remain unused in this message.\n\n" }, "Preview with message language":{ "summary":"Preview with message language", "description":"In this example we will request a message preview for Turkish language by introducing the languageCode parameter.", "value":"\n Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.\n TR\n\n" }, "Preview with transliteration":{ "summary":"Preview with transliteration", "description":"Transliteration is a technique that replaces the original special characters", "value":"\n Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα\n GREEK\n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse" }, "examples":{ "Preview response":{ "summary":"Preview response", "value":{ "originalText":"Let's see how many characters remain unused in this message.", "previews":[ { "textPreview":"Let's see how many characters remain unused in this message.", "messageCount":1, "charactersRemaining":100, "configuration":{} } ] } }, "Preview response for request with message language":{ "summary":"Preview response for request with message language", "value":{ "originalText":"Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.", "previews":[ { "textPreview":"Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.", "messageCount":2, "charactersRemaining":36, "configuration":{} }, { "textPreview":"Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.", "messageCount":1, "charactersRemaining":57, "configuration":{ "language":{ "languageCode":"TR" } } } ] } }, "Preview response for request with transliteration":{ "summary":"Preview response for request with transliteration", "value":{ "originalText":"Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα.", "previews":[ { "textPreview":"Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα", "messageCount":3, "charactersRemaining":46, "configuration":{} }, { "textPreview":"ΩΣ MEΓAPIKO ΨHΦIΣMA EINAI ΓNΩΣTH H AΠOΦAΣH THΣ EKKΛHΣIAΣ TOY ΔHMOY TΩN AΘHNAIΩN (ΠIΘANON ΓYPΩ ΣTO 433/2 Π.X.) NA EΠIBAΛEI AYΣTHPO KAI KAΘOΛIKO EMΠAPΓKO ΣTA", "messageCount":1, "charactersRemaining":5, "configuration":{ "transliteration":"GREEK" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse" }, "examples":{ "Preview response":{ "summary":"Preview response", "value":"\n Let's see how many characters remain unused in this message.\n \n \n Let's see how many characters remain unused in this message.\n 1\n 100\n \n \n \n\n" }, "Preview response for request with message language":{ "summary":"Preview response for request with message language", "value":"\n Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.\n \n \n Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.\n 2\n 36\n \n \n \n Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.\n 1\n 57\n \n \n TR\n \n \n \n \n\n" }, "Preview response for request with transliteration":{ "summary":"Preview response for request with transliteration", "value":"\n Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα.\n \n \n Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα\n 3\n 46\n \n \n \n ΩΣ MEΓAPIKO ΨHΦIΣMA EINAI ΓNΩΣTH H AΠOΦAΣH THΣ EKKΛHΣIAΣ TOY ΔHMOY TΩN AΘHNAIΩN (ΠIΘANON ΓYPΩ ΣTO 433/2 Π.X.) NA EΠIBAΛEI AYΣTHPO KAI KAΘOΛIKO EMΠAPΓKO ΣTA\n 1\n 5\n \n GREEK\n \n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:manage" ] } }, "/sms/2/text/advanced":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send SMS message", "description":"Use this endpoint to send an SMS and set up a rich set of features, such as batch sending with a single API request, scheduling, URL tracking, language and transliteration configuration, etc. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\\\nIn light of improved features, this endpoint has been superseded. Please visit [Send SMS message](#channels/sms/send-sms-messages) for the next version.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-sms-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest" }, "examples":{ "Send basic textual messages":{ "summary":"Send basic textual messages", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "from":"InfoSMS", "text":"This is a sample message" } ] } }, "Send fully-featured textual message":{ "summary":"Send fully-featured textual message", "value":{ "bulkId":"BULK-ID-123-xyz", "messages":[ { "callbackData":"DLR callback data", "destinations":[ { "messageId":"MESSAGE-ID-123-xyz", "to":"41793026727" }, { "to":"41793026834" } ], "flash":false, "from":"InfoSMS", "intermediateReport":true, "language":{ "languageCode":"TR" }, "notifyContentType":"application/json", "notifyUrl":"https://www.example.com/sms/advanced", "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.", "transliteration":"TURKISH", "validityPeriod":720, "campaignReferenceId":"summersale" }, { "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } }, "destinations":[ { "to":"41793026700" } ], "from":"41793026700", "sendAt":"2021-08-25T16:00:00.000+0000", "text":"A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire." } ], "tracking":{ "track":"SMS", "type":"MY_CAMPAIGN" } } }, "Send flash message":{ "summary":"Send flash message", "description":"Send a message that will pop-up on the user's phone", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "flash":true, "from":"InfoSMS", "text":"Toto, I've got a feeling we're not in Kansas anymore." } ] } }, "SMS language":{ "summary":"SMS language", "description":"Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "from":"InfoSMS", "language":{ "languageCode":"TR" }, "text":"Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz." } ] } }, "SMS transliteration":{ "summary":"SMS transliteration", "description":"Send full-size messages in original language alphabet using transliteration conversion", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "from":"InfoSMS", "text":"Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα", "transliteration":"GREEK" } ] } }, "Platform features":{ "summary":"Platform features", "description":"Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "text":"Custom application and entity based rules will be applied to this message", "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } ] } }, "Send Basic India DLT message":{ "summary":"Send Basic India DLT message", "description":"Send a message with India DLT parameters included", "value":{ "messages":[ { "destinations":[ { "to":"41793026727" } ], "from":"InfoSMS", "regional":{ "indiaDlt":{ "contentTemplateId":"1111111111111111111", "principalEntityId":"1111111111111111112", "telemarketerId":"111111111111" } }, "text":"India DLT parameters will be applied in this message" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest" }, "examples":{ "Send basic textual messages":{ "summary":"Send basic textual messages", "value":"\n \n \n InfoSMS\n This is a sample message\n \n \n 41793026727\n \n \n \n \n\n" }, "Send fully-featured textual message":{ "summary":"Send fully-featured textual message", "value":"\n BULK-ID-123-xyz\n \n SMS\n MY_CAMPAIGN\n \n \n \n DLR callback data\n false\n InfoSMS\n true\n \n TR\n \n application/json\n https://www.example.com/sms/advanced\n Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\n TURKISH\n 720\n summersale\n \n \n MESSAGE-ID-123-xyz\n 41793026727\n \n \n 41793026834\n \n \n \n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n 41793026700\n 2021-08-25T16:00:00.000+0000\n A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.\n \n \n 41793026700\n \n \n \n \n\n" }, "Send flash message":{ "summary":"Send flash message", "description":"Send a message that will pop-up on the user's phone", "value":"\n \n \n true\n InfoSMS\n Toto, I've got a feeling we're not in Kansas anymore.\n \n \n 41793026727\n \n \n \n \n\n" }, "SMS language":{ "summary":"SMS language", "description":"Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese", "value":"\n \n \n InfoSMS\n \n TR\n \n Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.\n \n \n 41793026727\n \n \n \n \n\n" }, "SMS transliteration":{ "summary":"SMS transliteration", "description":"Send full-size messages in original language alphabet using transliteration conversion", "value":"\n \n \n InfoSMS\n Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα\n GREEK\n \n \n 41793026727\n \n \n \n \n\n" }, "Platform features":{ "summary":"Platform features", "description":"Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "value":"\n \n \n Custom application and entity based rules will be applied to this message\n promotional-traffic-entity\n marketing-automation-application\n \n \n 41793026727\n \n \n \n \n\n" }, "Send Basic India DLT message":{ "summary":"Send Basic India DLT message", "description":"Send a message with India DLT parameters included", "value":"\n \n \n InfoSMS\n \n \n 1111111111111111111\n 1111111111111111112\n 111111111111\n \n \n India DLT parameters will be applied in this message\n \n \n 41793026727\n \n \n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026727" } ] } }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":{ "bulkId":"2034072219640523073", "messages":[ { "messageId":"2033247207850523791", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026727" }, { "messageId":"2033247207850523792", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026834" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026727\n \n \n\n" }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":"\n 2034072219640523073\n \n \n 2033247207850523791\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026727\n \n \n 2033247207850523792\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026834\n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-additionalInfo":{ "markdown":"### Related\n- [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)\n- [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)\n" }, "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"send-sms-messages" }, { "versionNumber":2, "latest":false, "operationId":"send-sms-message" }, { "versionNumber":2, "latest":false, "operationId":"send-binary-sms-message" } ] } }, "/sms/2/binary/advanced":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "send-message" ], "summary":"Send binary SMS message", "description":"Send single or multiple binary messages to one or more destination address. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\\\nIn light of improved features, this endpoint has been superseded. Please visit [Send SMS message](#channels/sms/send-sms-messages) for the next version.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"send-binary-sms-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest" }, "examples":{ "Send fully-featured binary message":{ "summary":"Send fully-featured binary message", "value":{ "bulkId":"BULK-ID-123-xyz", "messages":[ { "binary":{ "dataCoding":0, "esmClass":0, "hex":"54 65 73 74 20 6d 65 73 73 61 67 65 2e" }, "callbackData":"DLR callback data", "destinations":[ { "messageId":"MESSAGE-ID-123-xyz", "to":"41793026727" }, { "to":"41793026834" } ], "from":"InfoSMS", "intermediateReport":true, "notifyContentType":"application/json", "notifyUrl":"https://www.example.com/sms/advanced", "validityPeriod":720, "campaignReferenceId":"summersale" }, { "binary":{ "dataCoding":0, "esmClass":0, "hex":"41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E" }, "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ], "from":{ "hour":6, "minute":0 }, "to":{ "hour":15, "minute":30 } }, "destinations":[ { "to":"41793026700" } ], "from":"41793026700", "sendAt":"2021-08-25T16:00:00.000+0000" } ] } }, "Unicode flash binary SMS":{ "summary":"Unicode flash binary SMS", "description":"Send Unicode flash SMS m… over binary API method", "value":{ "messages":[ { "binary":{ "dataCoding":8, "esmClass":0, "hex":"0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf" }, "destinations":[ { "to":"41793026727" } ], "flash":true, "from":"InfoSMS" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest" }, "examples":{ "Send fully-featured binary message":{ "summary":"Send fully-featured binary message", "value":"\n BULK-ID-123-xyz\n \n \n \n 0\n 0\n 54 65 73 74 20 6d 65 73 73 61 67 65 2e\n \n DLR callback data\n InfoSMS\n true\n application/json\n https://www.example.com/sms/advanced\n 720\n summersale\n \n \n MESSAGE-ID-123-xyz\n 41793026727\n \n \n 41793026834\n \n \n \n \n \n 0\n 0\n 41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E\n \n \n \n MONDAY\n TUESDAY\n WEDNESDAY\n THURSDAY\n FRIDAY\n SATURDAY\n SUNDAY\n \n \n 6\n 0\n \n \n 15\n 30\n \n \n 41793026700\n 2021-08-25T16:00:00.000+0000\n \n \n 41793026700\n \n \n \n \n\n" }, "Unicode flash binary SMS":{ "summary":"Unicode flash binary SMS", "description":"Send Unicode flash SMS m… over binary API method", "value":"\n \n \n \n 8\n 0\n 0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf\n \n true\n InfoSMS\n \n \n 41793026727\n \n \n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026727" } ] } }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":{ "bulkId":"2034072219640523073", "messages":[ { "messageId":"2033247207850523791", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026727" }, { "messageId":"2033247207850523792", "status":{ "description":"Message sent to next instance", "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED" }, "to":"41793026834" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse" }, "examples":{ "Response for request with one destination":{ "summary":"Response for request with one destination", "value":"\n 2034072219640523072\n \n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026727\n \n \n\n" }, "Response for request with multiple destinations":{ "summary":"Response for request with multiple destinations", "value":"\n 2034072219640523073\n \n \n 2033247207850523791\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026727\n \n \n 2033247207850523792\n \n Message sent to next instance\n 1\n PENDING\n 26\n PENDING_ACCEPTED\n \n 41793026834\n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"send-sms-messages" }, { "versionNumber":2, "latest":false, "operationId":"send-sms-message" }, { "versionNumber":2, "latest":false, "operationId":"send-binary-sms-message" } ] } }, "/sms/1/bulks":{ "get":{ "tags":[ "channels", "sms", "outbound-sms", "manage-scheduled-sms-messages" ], "summary":"Get scheduled SMS messages", "description":"See all [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms) and their scheduled date and time. To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-scheduled-sms-messages", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":true, "style":"form", "explode":true, "schema":{ "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" }, "example":"BULK-ID-123-xyz" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse" }, "examples":{ "Get message schedule info":{ "summary":"Get message schedule info", "value":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-25T16:00:00.000+0000" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse" }, "examples":{ "Get message schedule info":{ "summary":"Get message schedule info", "value":"\n BULK-ID-123-xyz\n 2021-08-25T16:00:00.000+0000\n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Bulk not found responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":"\n \n \n \n \n \n NOT_FOUND\n \n Bulk not found\n \n \n \n \n \n\n" } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:message:send", "sms:manage" ] }, "put":{ "tags":[ "channels", "sms", "outbound-sms", "manage-scheduled-sms-messages" ], "summary":"Reschedule SMS messages", "description":"Change the date and time of already [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"reschedule-sms-messages", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":true, "style":"form", "explode":true, "schema":{ "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" }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest" }, "examples":{ "Reschedule messages":{ "summary":"Reschedule messages", "value":{ "sendAt":"2021-08-25T16:00:00.000+0000" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest" }, "examples":{ "Reschedule messages":{ "summary":"Reschedule messages", "value":"\n 2021-08-25T16:00:00.000+0000\n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse" }, "examples":{ "Get message schedule info":{ "summary":"Get message schedule info", "value":{ "bulkId":"BULK-ID-123-xyz", "sendAt":"2021-08-25T16:00:00.000+0000" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse" }, "examples":{ "Get message schedule info":{ "summary":"Get message schedule info", "value":"\n BULK-ID-123-xyz\n 2021-08-25T16:00:00.000+0000\n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Bulk not found responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":"\n \n \n \n \n \n NOT_FOUND\n \n Bulk not found\n \n \n \n \n \n\n" } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:manage" ] } }, "/sms/1/bulks/status":{ "get":{ "tags":[ "channels", "sms", "outbound-sms", "manage-scheduled-sms-messages" ], "summary":"Get scheduled SMS messages status", "description":"See the status of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-scheduled-sms-messages-status", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":true, "style":"form", "explode":true, "schema":{ "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" }, "example":"BULK-ID-123-xyz" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse" }, "examples":{ "Get message status info":{ "summary":"Get message status info", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"PAUSED" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse" }, "examples":{ "Get message status info":{ "summary":"Get message status info", "value":"\n BULK-ID-123-xyz\n PAUSED\n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Bulk not found responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":"\n \n \n \n \n \n NOT_FOUND\n \n Bulk not found\n \n \n \n \n \n\n" } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:message:send", "sms:manage" ] }, "put":{ "tags":[ "channels", "sms", "outbound-sms", "manage-scheduled-sms-messages" ], "summary":"Update scheduled SMS messages status", "description":"Change the status or completely cancel sending of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"update-scheduled-sms-messages-status", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":true, "style":"form", "explode":true, "schema":{ "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" }, "example":"BULK-ID-123-xyz" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest" }, "examples":{ "Update message status":{ "summary":"Update message status", "value":{ "status":"PAUSED" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest" }, "examples":{ "Update message status":{ "summary":"Update message status", "value":"\n PAUSED\n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse" }, "examples":{ "Get message status info":{ "summary":"Get message status info", "value":{ "bulkId":"BULK-ID-123-xyz", "status":"PAUSED" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse" }, "examples":{ "Get message status info":{ "summary":"Get message status info", "value":"\n BULK-ID-123-xyz\n PAUSED\n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Bulk not found responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Bulk not found" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bulk not found":{ "summary":"Bulk not found", "description":"Bulk not found", "value":"\n \n \n \n \n \n NOT_FOUND\n \n Bulk not found\n \n \n \n \n \n\n" } } } } }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:manage" ] } }, "/ct/1/log/end/{messageId}":{ "post":{ "tags":[ "channels", "sms", "outbound-sms", "confirm-conversion" ], "summary":"Confirm conversion", "description":"Use this endpoint to inform the Infobip platform about the successful conversion on your side. Infobip will use this information to monitor SMS performance and provide you with better service. To enable Conversion Tracking, set up the “tracking” object to “SMS” when [sending a message](https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms) over HTTP API.\nFor more information, see: [Tracking Conversion](https://www.infobip.com/docs/sms/api#track-conversion).", "operationId":"log-end-tag", "parameters":[ { "name":"messageId", "in":"path", "description":"ID of a converted message.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse" } ] }, "examples":{ "Reporting conversion response example":{ "summary":"Reporting conversion response example", "value":{ "processKey":"A37D448C1ACCA02FABA745522558326C" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse" } ] }, "examples":{ "Reporting conversion response example":{ "summary":"Reporting conversion response example", "value":"\n A37D448C1ACCA02FABA745522558326C\n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "4XX":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException" } } } }, "500":{ "$ref":"#/components/responses/ApiException500" }, "5XX":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException" } } } } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-is-early-access":true, "x-scopes":[ "sms:manage" ] } }, "/sms/1/inbox/reports":{ "get":{ "tags":[ "channels", "sms", "inbound-sms" ], "summary":"Get inbound SMS messages", "description":"If you are unable to receive incoming SMS to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request. To use this method, you’d need to:
  1. Buy a number capable of receiving SMS traffic.
  2. Specify a forwarding endpoint for the number and optionally configure other inbound settings.
", "operationId":"get-inbound-sms-messages", "parameters":[ { "name":"limit", "in":"query", "description":"Maximum number of messages to be returned in a response. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access messages for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 }, { "name":"applicationId", "in":"query", "description":"Application id that the message is linked to. 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":"entityId", "in":"query", "description":"Entity id that the message is linked to. 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":"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":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse" }, "examples":{ "Receive SMS":{ "summary":"Receive SMS", "value":{ "results":[ { "messageId":"817790313235066447", "from":"385916242493", "to":"385921004026", "text":"QUIZ Correct answer is Paris", "cleanText":"Correct answer is Paris", "keyword":"QUIZ", "receivedAt":"2019-11-09T16:00:00.000+0000", "smsCount":1, "price":{ "pricePerMessage":0, "currency":"EUR" }, "callbackData":"callbackData" } ], "messageCount":1, "pendingMessageCount":1 } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse" }, "examples":{ "Receive SMS":{ "summary":"Receive SMS", "value":"\n 1\n 1\n \n \n 817790313235066447\n 385916242493\n 385921004026\n QUIZ Correct answer is Paris\n Correct answer is Paris\n QUIZ\n 2019-11-09T16:00:00.000+0000\n 1\n \n 0\n EUR\n \n callbackData\n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "inbound-message:read", "sms:inbound-message:read", "sms:manage" ], "x-additional-versioning-information":{ "latest":false, "versionNumber":1 }, "x-additionalInfo":{ "markdown":"### Related\n- [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)\n" } } }, "/sms/3/reports":{ "get":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Get outbound SMS message delivery reports", "description":"If you are unable to receive real-time message delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of message reports to confirm whether specific messages have been delivered. Each request towards this endpoint returns batches of the latest message reports. The API returns each report only once. If the message status changes again after retrieval, the endpoint returns a new report for the updated status on the next request.", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-outbound-sms-message-delivery-reports-v3", "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":{ "results":[ { "bulkId":"BULK-ID-123-xyz", "price":{ "pricePerMessage":0.01, "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":"MESSAGE-ID-123-xyz", "to":"41793026727", "sender":"InfoSMS", "sentAt":"2019-11-09T16:00:00.000+0100", "doneAt":"2019-11-09T16:00:00.000+0100", "messageCount":1, "callbackData":"callbackData", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } }, { "bulkId":"BULK-ID-123-xyz", "price":{ "pricePerMessage":0.01, "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":"12db39c3-7822-4e72-a3ec-c87442c0ffc5", "to":"41793026834", "sender":"InfoSMS", "sentAt":"2019-11-09T17:00:00.000+0100", "doneAt":"2019-11-09T17:00:00.000+0100", "messageCount":1, "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":"\n \n \n BULK-ID-123-xyz\n \n 0.01\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 MESSAGE-ID-123-xyz\n 41793026727\n InfoSMS\n 2019-11-09T16:00:00.000+0100\n 2019-11-09T16:00:00.000+0100\n 1\n callbackData\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n BULK-ID-123-xyz\n \n 0.01\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 12db39c3-7822-4e72-a3ec-c87442c0ffc5\n 41793026834\n InfoSMS\n 2019-11-09T17:00:00.000+0100\n 2019-11-09T17:00:00.000+0100\n 1\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"get-outbound-sms-message-delivery-reports-v3" }, { "versionNumber":1, "latest":false, "operationId":"get-outbound-sms-message-delivery-reports" } ] } }, "/sms/3/logs":{ "get":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Get outbound SMS message logs", "description":"Use this method to obtain the logs associated with outbound messages. The available logs are limited to those generated in the last 48 hours, and you can retrieve a maximum of only 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports-v3) if your use case is to verify message delivery.", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-outbound-sms-message-logs-v3", "parameters":[ { "name":"mcc", "in":"query", "description":"Mobile Country Code.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Mobile Country Code." } }, { "name":"mnc", "in":"query", "description":"Mobile Network Code. Mobile Country Code is required if this property is used.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Mobile Network Code. Mobile Country Code is required if this property is used." } }, { "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent" }, "examples":{ "Log":{ "summary":"Log", "value":{ "results":[ { "destination":"41793026727", "bulkId":"BULK-ID-123-xyz", "messageId":"MESSAGE-ID-123-xyz", "sentAt":"2019-11-09T16:00:00.000+0100", "doneAt":"2019-11-09T16:00:00.000+0100", "messageCount":1, "price":{ "pricePerMessage":0.01, "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":"This is a sample message" }, "mccMnc":"22801" }, { "destination":"41793026834", "bulkId":"BULK-ID-123-xyz", "messageId":"12db39c3-7822-4e72-a3ec-c87442c0ffc5", "sentAt":"2019-11-09T17:00:00.000+0100", "doneAt":"2019-11-09T17:00:00.000+0100", "messageCount":1, "price":{ "pricePerMessage":0.01, "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":"This is a sample message" }, "mccMnc":"22801" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent" }, "examples":{ "Log":{ "summary":"Log", "value":"\n \n \n 41793026727\n BULK-ID-123-xyz\n MESSAGE-ID-123-xyz\n 2019-11-09T16:00:00.000+0100\n 2019-11-09T16:00:00.000+0100\n 1\n \n 0.01\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 \n promotional-traffic-entity\n marketing-automation-application\n \n \n This is a sample message\n \n 22801\n \n \n 41793026834\n BULK-ID-123-xyz\n 12db39c3-7822-4e72-a3ec-c87442c0ffc5\n 2019-11-09T17:00:00.000+0100\n 2019-11-09T17:00:00.000+0100\n 1\n \n 0.01\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 \n promotional-traffic-entity\n marketing-automation-application\n \n \n This is a sample message\n \n 22801\n \n \n\n" } } } } }, "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":[ "sms:manage", "sms:logs:read" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"get-outbound-sms-message-logs-v3" }, { "versionNumber":1, "latest":false, "operationId":"get-outbound-sms-message-logs" } ] } }, "/sms/1/reports":{ "get":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Get outbound SMS message delivery reports", "description":"If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-outbound-sms-message-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"Unique message ID for which a report is requested.", "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":2 }, { "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":"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":"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":"successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"BULK-ID-123-xyz", "messageId":"MESSAGE-ID-123-xyz", "to":"41793026727", "sentAt":"2019-11-09T16:00:00.000+0000", "doneAt":"2019-11-09T16:00:00.000+0000", "smsCount":1, "callbackData":"callbackData", "price":{ "pricePerMessage":0.01, "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 }, "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" }, { "bulkId":"BULK-ID-123-xyz", "messageId":"12db39c3-7822-4e72-a3ec-c87442c0ffc5", "to":"41793026834", "sentAt":"2019-11-09T17:00:00.000+0000", "doneAt":"2019-11-09T17:00:00.000+0000", "smsCount":1, "price":{ "pricePerMessage":0.01, "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 }, "applicationId":"default" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":"\n \n \n BULK-ID-123-xyz\n MESSAGE-ID-123-xyz\n 41793026727\n 2019-11-09T16:00:00.000+0000\n 2019-11-09T16:00:00.000+0000\n 1\n callbackData\n \n 0.01\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 promotional-traffic-entity\n marketing-automation-application\n \n \n BULK-ID-123-xyz\n 12db39c3-7822-4e72-a3ec-c87442c0ffc5\n 41793026834\n 2019-11-09T17:00:00.000+0000\n 2019-11-09T17:00:00.000+0000\n 1\n \n 0.01\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 default\n \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "sms:message:send", "sms:manage" ], "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"get-outbound-sms-message-delivery-reports-v3" }, { "versionNumber":1, "latest":false, "operationId":"get-outbound-sms-message-delivery-reports" } ] } }, "/sms/1/logs":{ "get":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Get outbound SMS message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery.", "externalDocs":{ "description":"Learn more about SMS channel and use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"get-outbound-sms-message-logs", "parameters":[ { "name":"from", "in":"query", "description":"The sender ID which can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"to", "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", "description":"Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes).", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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":"2015-02-22T17:42:05.390+0100" }, { "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" }, "example":"2015-02-22T19:42:05.390+0100" }, { "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" } }, { "name":"mcc", "in":"query", "description":"Mobile Country Code.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"mnc", "in":"query", "description":"Mobile Network Code. Mobile Country Code is required if this property is used. ", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "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":"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":"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" } ], "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse" }, "examples":{ "SMS logs":{ "summary":"SMS logs", "value":{ "results":[ { "bulkId":"BULK-ID-123-xyz", "messageId":"MESSAGE-ID-123-xyz", "to":"41793026727", "sentAt":"2019-11-09T16:00:00.000+0000", "doneAt":"2019-11-09T16:00:00.000+0000", "smsCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.01, "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 } }, { "bulkId":"BULK-ID-123-xyz", "messageId":"MESSAGE-ID-ijkl-45", "to":"41793026834", "sentAt":"2019-11-09T17:00:00.000+0000", "doneAt":"2019-11-09T17:00:00.000+0000", "smsCount":1, "mccMnc":"22801", "price":{ "pricePerMessage":0.01, "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 } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse" }, "examples":{ "SMS logs":{ "summary":"SMS logs", "value":"\n \n \n BULK-ID-123-xyz\n MESSAGE-ID-123-xyz\n 41793026727\n 2019-11-09T16:00:00.000+0000\n 2019-11-09T16:00:00.000+0000\n 1\n 22801\n \n 0.01\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 \n \n BULK-ID-123-xyz\n MESSAGE-ID-ijkl-45\n 41793026834\n 2019-11-09T17:00:00.000+0000\n 2019-11-09T17:00:00.000+0000\n 1\n 22801\n \n 0.01\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 \n \n\n" } } } } }, "400":{ "description":"Error responses", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "sms:logs:read", "sms:manage" ], "x-deprecationInformation":{ "deprecation":"2024-05-16T12:00:00.00+0000", "successorOperationId":"get-outbound-sms-message-logs-v3" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ], "x-versions":[ { "versionNumber":3, "latest":true, "operationId":"get-outbound-sms-message-logs-v3" }, { "versionNumber":1, "latest":false, "operationId":"get-outbound-sms-message-logs" } ] } } }, "components":{ "schemas":{ "01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest":{ "type":"object", "properties":{ "text":{ "type":"string", "description":"Content of the message being sent." }, "languageCode":{ "type":"string", "description":"[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages.", "pattern":"^(TR|ES|PT|AUTODETECT)$" }, "transliteration":{ "type":"string", "description":"The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.", "pattern":"^(TURKISH|GREEK|CYRILLIC|SERBIAN_CYRILLIC|BULGARIAN_CYRILLIC|CENTRAL_EUROPEAN|BALTIC|PORTUGUESE|COLOMBIAN|NON_UNICODE|NONE|ALL)$" } }, "required":[ "text" ], "title":"PreviewRequest" }, "1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest":{ "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 to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs). Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and 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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSTextualMessage" } }, "sendingSpeedLimit":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SendingSpeedLimit" }, "urlOptions":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions" }, "tracking":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.Tracking" }, "includeSmsCountInResponse":{ "type":"boolean", "default":false, "description":"Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted." } }, "required":[ "messages" ], "title":"SMSTextualRequest" }, "1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsReport" } } }, "title":"SMSReportResponse" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BinaryContent":{ "type":"object", "properties":{ "dataCoding":{ "type":"integer", "format":"int32", "description":"Binary content data coding. The default value is (`0`) for GSM7. Example: (`8`) for Unicode data.", "writeOnly":true }, "esmClass":{ "type":"integer", "format":"int32", "description":"“Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (`0`).", "writeOnly":true }, "hex":{ "type":"string", "description":"Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character (Example: `0f c2 4a bf 34 13 ba`).", "writeOnly":true } }, "required":[ "hex" ], "title":"BinaryContent" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus":{ "type":"string", "description":"The status of the message(s).", "enum":[ "PENDING", "PAUSED", "PROCESSING", "CANCELED", "FINISHED", "FAILED" ], "title":"BulkStatus" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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", "writeOnly":true }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice" }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus" }, "error":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReport" } } }, "title":"DeliveryReports" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeFrom":{ "type":"object", "description":"The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the `to` property with minimum 1 hour difference.", "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, "writeOnly":true }, "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, "writeOnly":true } }, "required":[ "hour", "minute" ], "title":"DeliveryTimeFrom", "writeOnly":true }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeTo":{ "type":"object", "description":"The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the `from` property with minimum 1 hour difference.", "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, "writeOnly":true }, "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, "writeOnly":true } }, "required":[ "hour", "minute" ], "title":"DeliveryTimeTo", "writeOnly":true }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination":{ "type":"object", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "properties":{ "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent. Anything above 200 characters passed in the request will be clipped during processing and returned in response, reports and logs.", "writeOnly":true }, "to":{ "type":"string", "description":"Message destination address. Addresses must be in international format (Example: `41793026727`).", "maxLength":64, "minLength":0, "writeOnly":true } }, "required":[ "to" ], "title":"Destination", "writeOnly":true }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Error":{ "type":"object", "description":"Indicates whether an error occurred during the query execution.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Error group ID." }, "groupName":{ "type":"string", "description":"Error group name." }, "id":{ "type":"integer", "format":"int32", "description":"Error ID." }, "name":{ "type":"string", "description":"Error name." }, "description":{ "type":"string", "description":"Human-readable description of the error.." }, "permanent":{ "type":"boolean", "description":"Tells if the error is permanent." } }, "title":"Error" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.GeoLocationInfoWrapper":{ "type":"object", "description":"Geolocation data such as Country and City.", "properties":{ "countryName":{ "type":"string", "description":"Country where the user action is recorded." }, "city":{ "type":"string", "description":"City where the user action is recorded." } }, "title":"GeoLocationInfoWrapper" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IysRecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"IysRecipientType" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language":{ "type":"object", "properties":{ "languageCode":{ "type":"string", "description":"[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages." } }, "title":"Language" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode":{ "type":"string", "description":"[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages.", "enum":[ "NONE", "TR", "ES", "PT", "AUTODETECT" ], "title":"LanguageCode" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageConfiguration":{ "type":"object", "description":"Sets up additional configuration that changes the original message content you can preview with this call.", "properties":{ "language":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language" }, "transliteration":{ "type":"string", "description":"Conversion of a message text from one script to another. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE` and `ALL`." } }, "title":"LanguageConfiguration" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Log":{ "type":"object", "description":"Collection of logs.", "properties":{ "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.", "readOnly":true }, "messageId":{ "type":"string", "description":"Unique message ID.", "readOnly":true }, "to":{ "type":"string", "description":"The destination address of the message.", "readOnly":true }, "from":{ "type":"string", "description":"Sender ID that can be alphanumeric or numeric.", "readOnly":true }, "text":{ "type":"string", "description":"Content of the message being sent.", "readOnly":true }, "sentAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message was [scheduled](https://www.infobip.com/docs/api#channels/sms/get-scheduled-sms-messages) to be sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "readOnly":true }, "doneAt":{ "type":"string", "format":"date-time", "description":"Date and time when the Infobip services finished processing the message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "readOnly":true }, "smsCount":{ "type":"integer", "format":"int32", "description":"The number of parts the message content was split into.", "readOnly":true }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes.", "readOnly":true }, "price":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogPrice" }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogStatus" }, "error":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogError" }, "applicationId":{ "type":"string", "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)." }, "entityId":{ "type":"string", "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)." }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "readOnly":true, "title":"Log" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogError":{ "type":"object", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Error group ID.", "readOnly":true }, "groupName":{ "type":"string", "description":"Error group name.", "readOnly":true }, "id":{ "type":"integer", "format":"int32", "description":"Error ID.", "readOnly":true }, "name":{ "type":"string", "description":"Error name.", "readOnly":true }, "description":{ "type":"string", "description":"Human-readable description of the error..", "readOnly":true }, "permanent":{ "type":"boolean", "description":"Tells if the error is permanent.", "readOnly":true } }, "title":"LogError" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogPrice":{ "type":"object", "properties":{ "pricePerMessage":{ "type":"number", "format":"double", "description":"Price per one SMS.", "readOnly":true }, "currency":{ "type":"string", "description":"The currency in which the price is expressed.", "readOnly":true } }, "title":"LogPrice" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent" } }, "cursor":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo" } }, "title":"LogResponseSmsLogSmsMessageContent" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogStatus":{ "type":"object", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Status group ID.", "readOnly":true }, "groupName":{ "type":"string", "description":"Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.", "readOnly":true }, "id":{ "type":"integer", "format":"int32", "description":"Status ID.", "readOnly":true }, "name":{ "type":"string", "description":"[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes).", "readOnly":true }, "description":{ "type":"string", "description":"Human-readable description of the status.", "readOnly":true }, "action":{ "type":"string", "description":"Action that should be taken to recover from the error.", "readOnly":true } }, "title":"LogStatus" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageResponseSmsMessageResponseDetails":{ "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageResponseDetails" } }, "title":"MessageResponseSmsMessageResponseDetails" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MoPrice":{ "type":"object", "description":"A price object showing currency and a price per each message.", "properties":{ "pricePerMessage":{ "type":"number", "format":"double", "description":"Price per one SMS." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"MoPrice" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Preview":{ "type":"object", "description":"Allows for previewing the original message content once additional language configuration has been applied to it.", "properties":{ "textPreview":{ "type":"string", "description":"Preview of the message content as it should appear on the recipient’s device." }, "messageCount":{ "type":"integer", "format":"int32", "description":"Number of SMS message parts required to deliver the message." }, "charactersRemaining":{ "type":"integer", "format":"int32", "description":"Number of remaining characters in the last part of the SMS." }, "configuration":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageConfiguration" } }, "title":"Preview" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Price":{ "type":"object", "description":"Sent SMS price.", "properties":{ "pricePerMessage":{ "type":"number", "format":"double", "description":"Price per one SMS." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"Price" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientInfo":{ "type":"object", "description":"Recipient information such as device type, OS, device name.", "properties":{ "deviceType":{ "type":"string", "description":"The type of device used by the recipient to do the user action." }, "os":{ "type":"string", "description":"The type OS present in the device used by the recipient." }, "deviceName":{ "type":"string", "description":"Device name of the action originating device." } }, "title":"RecipientInfo" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSBinaryMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "binary":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BinaryContent" }, "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](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.", "maxLength":4000, "minLength":0, "writeOnly":true }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow" }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination" }, "writeOnly":true }, "flash":{ "type":"boolean", "description":"Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.", "writeOnly":true }, "from":{ "type":"string", "description":"The sender ID which 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).", "writeOnly":true }, "intermediateReport":{ "type":"boolean", "description":"The [real-time intermediate delivery report](https://www.infobip.com/docs/api#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.", "writeOnly":true }, "notifyContentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "writeOnly":true }, "notifyUrl":{ "type":"string", "description":"The URL on your call back server on which the Delivery report will be sent.", "externalDocs":{ "description":"Delivery report format", "url":"#channels/sms/receive-outbound-sms-message-report" }, "writeOnly":true }, "regional":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.RegionalOptions" }, "sendAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](https://www.infobip.com/docs/api#channels/sms/get-scheduled-sms-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.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int64", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).", "writeOnly":true }, "entityId":{ "type":"string", "description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":66, "minLength":0, "writeOnly":true }, "applicationId":{ "type":"string", "description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":66, "minLength":0, "writeOnly":true }, "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 } }, "required":[ "destinations" ], "title":"SMSBinaryMessage" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails":{ "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 passed, it will be automatically generated and returned in a response.", "readOnly":true }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status" }, "to":{ "type":"string", "description":"The destination address of the message.", "readOnly":true }, "smsCount":{ "type":"integer", "format":"int32", "description":"This is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted.", "readOnly":true } }, "readOnly":true, "title":"SMSResponseDetails" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSTextualMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "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](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.", "maxLength":4000, "minLength":0, "writeOnly":true }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow" }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination" }, "writeOnly":true }, "flash":{ "type":"boolean", "default":false, "description":"Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.", "writeOnly":true }, "from":{ "type":"string", "description":"The sender ID which 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).", "writeOnly":true }, "intermediateReport":{ "type":"boolean", "description":"The [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.", "writeOnly":true }, "language":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language" }, "notifyContentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`.", "writeOnly":true }, "notifyUrl":{ "type":"string", "description":"The URL on your call back server on to which a delivery report will be sent. The [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) for when your URL becomes unavailable uses the following formula: `1min + (1min * retryNumber * retryNumber)`.", "externalDocs":{ "description":"Delivery report format", "url":"#channels/sms/receive-sent-sms-report" }, "writeOnly":true }, "regional":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.RegionalOptions" }, "sendAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-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.", "writeOnly":true }, "text":{ "type":"string", "description":"Content of the message being sent.", "writeOnly":true }, "transliteration":{ "type":"string", "description":"The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.", "writeOnly":true }, "validityPeriod":{ "type":"integer", "format":"int64", "description":"The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.", "writeOnly":true }, "entityId":{ "type":"string", "description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":50, "minLength":0, "writeOnly":true }, "applicationId":{ "type":"string", "description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":50, "minLength":0, "writeOnly":true }, "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 } }, "required":[ "destinations" ], "title":"SMSTextualMessage" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent":{ "type":"object", "allOf":[ { "type":"object", "properties":{ "dataCoding":{ "type":"integer", "format":"int32", "default":0, "description":"Binary content data coding. The default value is (`0`) for GSM7. Example: (`8`) for Unicode data.", "example":8 }, "esmClass":{ "type":"integer", "format":"int32", "default":0, "description":"“Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (`0`)." }, "hex":{ "type":"string", "description":"Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character.", "example":"48 65 6c 6c 6f" } } } ], "required":[ "hex" ], "title":"binary content" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage":{ "type":"object", "description":"Sets the language parameters for the message being sent.", "properties":{ "languageCode":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode" }, "singleShift":{ "type":"boolean", "default":false, "description":"Uses a single shift table which enhances only the extension table of the GSM default alphabet. Allows you to selectively improve character support without altering the entire message." }, "lockingShift":{ "type":"boolean", "default":false, "description":"Uses a locking shift table which allows you to represent characters beyond the standard GSM default alphabet. This flexibility enables better language support." } }, "title":"SmsLanguage" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent":{ "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice" }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus" }, "error":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError" }, "platform":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform" }, "content":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes." } }, "title":"SmsLogSmsMessageContent" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessage":{ "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsToDestination" } }, "content":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent" }, "options":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageOptions" }, "webhooks":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Webhooks" } }, "required":[ "content", "destinations" ], "title":"SmsMessage" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent":{ "type":"object", "description":"Message content.", "oneOf":[ { "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent" }, { "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent" } ], "title":"SmsMessageContent" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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 }, "regional":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RegionalOptions" }, "flash":{ "type":"boolean", "description":"Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS." } }, "title":"SmsMessageOptions" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RequestSchedulingSettings" }, "tracking":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions" }, "includeSmsCountInResponse":{ "type":"boolean", "default":false, "description":"Set to true to return `messageCount` in the response. The `messageCount` is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than the limit will be split into multiple SMS. Not compatible with `binary` message content type." }, "conversionTracking":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Tracking" } }, "title":"SmsMessageRequestOptions" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "properties":{ "messageCount":{ "type":"integer", "format":"int32", "description":"Number of SMS message parts required to deliver the message." } }, "title":"SmsMessageResponseDetails" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMoReport":{ "type":"object", "description":"An array of result objects.", "properties":{ "applicationId":{ "type":"string", "description":"Application id linked to the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, "messageId":{ "type":"string", "description":"Unique message ID." }, "from":{ "type":"string", "description":"Sender ID that can be alphanumeric or numeric." }, "to":{ "type":"string", "description":"The destination address of the message." }, "text":{ "type":"string", "description":"Full content of the message." }, "cleanText":{ "type":"string", "description":"Content of the message without a keyword (if a keyword was sent)." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message content." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Indicates when the Infobip platform received the message. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "smsCount":{ "type":"integer", "format":"int32", "description":"The number of parts the message content was split into." }, "price":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MoPrice" }, "callbackData":{ "type":"string", "description":"Custom callback data sent over the notifyUrl." }, "entityId":{ "type":"string", "description":"Entity id linked to the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, "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." } }, "title":"SmsMoReport" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsReport":{ "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." }, "messageId":{ "type":"string", "description":"Unique message ID." }, "to":{ "type":"string", "description":"Message destination address." }, "from":{ "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 [scheduled](#channels/sms/get-scheduled-sms-messages) to be 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, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "smsCount":{ "type":"integer", "format":"int32", "description":"The number of parts the message content was split into." }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "price":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Price" }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status" }, "error":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Error" }, "entityId":{ "type":"string", "description":"The entity used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, "applicationId":{ "type":"string", "description":"The application used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management)." }, "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." } }, "title":"SmsReport" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope":{ "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessage" } }, "options":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageRequestOptions" } }, "required":[ "messages" ], "title":"SmsRequestEnvelope" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope":{ "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageResponseSmsMessageResponseDetails" } } }, "required":[ "messages" ], "title":"SmsResponseEnvelope" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent":{ "type":"object", "allOf":[ { "type":"object", "properties":{ "text":{ "type":"string", "description":"Content of the message being sent." }, "transliteration":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode" }, "language":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage" } } } ], "required":[ "text" ], "title":"text content" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsToDestination":{ "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.", "maxLength":64, "minLength":0 }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent.", "maxLength":200, "minLength":0 }, "networkId":{ "type":"integer", "format":"int32", "description":"Available in US and Canada only if networkId is known for Network Operator of the destination. Returned in [SMS message delivery reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports) and [Inbound SMS](https://www.infobip.com/docs/api/channels/sms/sms-messaging/inbound-sms); contact Infobip Support to enable." } }, "required":[ "to" ], "title":"Destination" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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", "writeOnly":true }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status":{ "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":{ "type":"string", "description":"Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED." }, "id":{ "type":"integer", "format":"int32", "description":"Status ID." }, "name":{ "type":"string", "description":"[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes)." }, "description":{ "type":"string", "description":"Human-readable description of the status." }, "action":{ "type":"string", "description":"Action that should be taken to recover from the error." } }, "title":"Status" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Tracking":{ "type":"object", "description":"Allows you to set up tracking parameters to track conversion metrics. For more details, see: [SMS with conversion tracking](https://www.infobip.com/docs/sms/sms-over-api#send-sms-with-conversion-tracking).", "properties":{ "useConversionTracking":{ "type":"boolean", "description":"Indicates if a message has to be tracked for conversion rates. Default \"false\"." }, "conversionTrackingName":{ "type":"string", "description":"Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`." } }, "title":"Tracking" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode":{ "type":"string", "description":"The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.", "enum":[ "NONE", "TURKISH", "GREEK", "CYRILLIC", "SERBIAN_CYRILLIC", "CENTRAL_EUROPEAN", "BALTIC", "NON_UNICODE", "PORTUGUESE", "COLOMBIAN", "BULGARIAN_CYRILLIC", "ALL" ], "title":"TransliterationCode" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions":{ "type":"object", "description":"Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.", "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" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlTrackingWebhook":{ "type":"object", "properties":{ "notificationType":{ "type":"string", "description":"Tells the type of user event that took place. Possible events: CLICKED" }, "recipient":{ "type":"string", "description":"Recipient of the message." }, "url":{ "type":"string", "description":"The link the recipient has clicked." }, "sendDateTime":{ "type":"integer", "format":"int64", "description":"This is timestamp epoch millis when we received event for CLICK." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent to the recipient." }, "bulkId":{ "type":"string", "description":"The ID that uniquely identifies a list of messages. This is either defined by user in the request or auto generated." }, "callbackData":{ "type":"string", "description":"The callback data sent through the callbackData field in your fully featured message." }, "recipientInfo":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientInfo" }, "geoLocationInfo":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.GeoLocationInfoWrapper" }, "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)." }, "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)." } }, "title":"UrlTrackingWebhook" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Webhooks":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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" }, "2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest":{ "type":"object", "properties":{ "sendAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message is to be sent. Used for scheduled SMS (see [Scheduled SMS endpoints](#channels/sms/get-scheduled-sms-messages) for more details). 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." } }, "required":[ "sendAt" ], "title":"BulkRequest" }, "2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse":{ "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." }, "sendAt":{ "type":"string", "format":"date-time", "description":"Date and time when the message is to be sent. Used for scheduled SMS (see [Scheduled SMS endpoints](#channels/sms/get-scheduled-sms-messages) for more details). 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." } }, "title":"BulkResponse" }, "33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse":{ "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. Typically, used to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs).", "readOnly":true }, "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails" }, "readOnly":true } }, "title":"SMSResponse" }, "578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse":{ "type":"object", "properties":{ "processKey":{ "type":"string", "description":"Process key assigned to account ID.", "readOnly":false, "writeOnly":false } }, "title":"EndTagResponse" }, "7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest":{ "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 to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs). Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and 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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSBinaryMessage" } }, "sendingSpeedLimit":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SendingSpeedLimit" } }, "required":[ "messages" ], "title":"SMSAdvancedBinaryRequest" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow":{ "type":"object", "description":"Sets specific SMS delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent.", "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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryDay" }, "writeOnly":true }, "from":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeFrom" }, "to":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeTo" } }, "required":[ "days" ], "title":"DeliveryTimeWindow", "writeOnly":true }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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.", "writeOnly":true }, "timeUnit":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SouthKoreaOptions":{ "type":"object", "description":"Use case dependent parameters for sending SMS to phone numbers registered in South Korea.", "properties":{ "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":{ "type":"string", "description":"Set the title or subject of a message. South Korea only.", "maxLength":66, "minLength":0 } }, "title":"SouthKoreaOptions" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.Tracking":{ "type":"object", "description":"Sets up tracking parameters to track conversion metrics and type. This is a legacy feature not compatible with the `tracking` feature in latest [Send SMS message](#channels/sms/send-sms-messages) API.", "properties":{ "baseUrl":{ "type":"string", "description":"Custom base URL for shortened links in messages when tracking URL conversions. Legacy - use `urlOptions` instead.", "writeOnly":true }, "processKey":{ "type":"string", "description":"The process key which uniquely identifies conversion tracking.", "writeOnly":true }, "track":{ "type":"string", "description":"Indicates if a message has to be tracked for conversion rates. Values are: `SMS` and `URL`. `URL` is a legacy value. Use `urlOptions` instead. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion).", "writeOnly":true }, "type":{ "type":"string", "description":"Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`.", "writeOnly":true } }, "title":"Tracking" }, "87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IysRecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "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" }, "ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "$ref":"#/components/schemas/ApiRequestErrorDetails" } }, "title":"ApiRequestError" }, "ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error." }, "text":{ "type":"string", "description":"Detailed error description." }, "validationErrors":{ "type":"object", "additionalProperties":{ "type":"array", "description":"Validation errors.", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException":{ "type":"object", "properties":{ "requestError":{ "allOf":[ { "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestError" } ] } }, "title":"ApiException" }, "afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "allOf":[ { "$ref":"#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestErrorDetails" } ] } }, "title":"ApiRequestError" }, "afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error.", "readOnly":false, "writeOnly":false }, "text":{ "type":"string", "description":"Detailed error description.", "readOnly":false, "writeOnly":false } }, "title":"ApiRequestErrorDetails" }, "b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse":{ "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." }, "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus" } }, "title":"BulkStatusResponse" }, "b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of logs.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Log" }, "readOnly":true } }, "title":"LogsResponse" }, "b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse":{ "type":"object", "properties":{ "originalText":{ "type":"string", "description":"Message content supplied in the request." }, "previews":{ "type":"array", "description":"Allows for previewing the original message content once additional language configuration has been applied to it.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Preview" } } }, "title":"PreviewResponse" }, "c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest":{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus" } }, "required":[ "status" ], "title":"UpdateStatusRequest" }, "cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request. Bulk ID will be received only when a message is sent to more than one destination address.", "readOnly":true }, "messages":{ "type":"array", "description":"Array of sent message objects, one object per every message.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails" }, "readOnly":true } }, "title":"QuerySmsResponse" }, "cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of result objects.", "items":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMoReport" } }, "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":"SmsMoReportResponse" } }, "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" } } }, "ApiException401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"UNAUTHORIZED", "text":"Unauthorized" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n" } } }, "ApiException403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"FORBIDDEN", "text":"Forbidden" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n" } } }, "ApiException404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n NOT_FOUND\n Not found\n \n \n\n" } } }, "ApiException429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n" } } }, "ApiException500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"GENERAL_ERROR", "text":"Something went wrong. Please contact support." } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact 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-inbound-sms-messages":{ "post":{ "tags":[ "channels", "sms", "inbound-sms" ], "summary":"Receive inbound SMS messages", "description":"Receive SMS messages from your subscribers and have them delivered to you in real-time. To use this method, you’d need to:
  1. Buy a number capable of receiving SMS traffic.
  2. Specify a forwarding endpoint for the number and optionally configure other inbound settings.
We will then send inbound messages to you as soon as they are delivered to us by a mobile network operator.
The name of a default format or renderer for the inbound SMS messages is `MO_JSON_2`, and is documented in this section.", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"receive-inbound-sms-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse" }, "examples":{ "Successful response":{ "summary":"Successful response", "description":"Received SMS", "value":{ "results":[ { "messageId":"817790313235066447", "from":"385916242493", "to":"385921004026", "text":"QUIZ Correct answer is Paris", "cleanText":"Correct answer is Paris", "keyword":"QUIZ", "receivedAt":"2019-11-09T16:00:00.000+0000", "smsCount":1, "price":{ "pricePerMessage":0, "currency":"EUR" }, "callbackData":"callbackData" } ], "messageCount":1, "pendingMessageCount":1 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-outbound-sms-message-reports-v3":{ "post":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Receive outbound SMS message reports", "description":"For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint URL using the webhooks > delivery > url parameter. Alternatively, you can set the endpoint URL through the [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com. Please note that the default number of delivery reports in a single request is 100. You can customize this value by defining \"maxBucketSize\" using the [Subscription Management API](https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription).\\\nYou'll receive this type of payload for messages sent using [Send SMS message](#channels/sms/send-sms-messages).", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"receive-outbound-sms-message-report-v3", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":{ "results":[ { "bulkId":"BULK-ID-123-xyz", "price":{ "pricePerMessage":0.01, "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":"MESSAGE-ID-123-xyz", "to":"41793026727", "sender":"InfoSMS", "sentAt":"2019-11-09T16:00:00.000+0100", "doneAt":"2019-11-09T16:00:00.000+0100", "messageCount":1, "callbackData":"callbackData", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } }, { "bulkId":"BULK-ID-123-xyz", "price":{ "pricePerMessage":0.01, "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":"12db39c3-7822-4e72-a3ec-c87442c0ffc5", "to":"41793026834", "sender":"InfoSMS", "sentAt":"2019-11-09T17:00:00.000+0100", "doneAt":"2019-11-09T17:00:00.000+0100", "messageCount":1, "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":"\n \n \n BULK-ID-123-xyz\n \n 0.01\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 MESSAGE-ID-123-xyz\n 41793026727\n InfoSMS\n 2019-11-09T16:00:00.000+0100\n 2019-11-09T16:00:00.000+0100\n 1\n callbackData\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n BULK-ID-123-xyz\n \n 0.01\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 12db39c3-7822-4e72-a3ec-c87442c0ffc5\n 41793026834\n InfoSMS\n 2019-11-09T17:00:00.000+0100\n 2019-11-09T17:00:00.000+0100\n 1\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-sms-tracking-notification":{ "post":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Receive SMS tracking notifications", "description":"For every message you send, we offer the option to send you clicked events. To enable this feature, you need to specify your endpoint URL either in the [tracking](https://www.infobip.com/docs/api/channels/sms/outbound-sms/send-sms-messages) or [urlOptions](https://www.infobip.com/docs/api/channels/sms/outbound-sms/send-sms-message) parameters when sending the SMS, or alternatively, configure it through [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com.
Use this data to monitor user engagement, analyze campaign performance, and trigger automated workflows based on user interactions. For more details, visit our dedicated pages on [URL shortening](https://www.infobip.com/docs/url-shortening) and [tracking options](https://www.infobip.com/docs/url-shortening/tracking).", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"receive-sms-tracking-notification", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlTrackingWebhook" }, "examples":{ "UrlTrackingWebhook":{ "summary":"UrlTrackingWebhook", "value":{ "notificationType":"CLICKED", "recipient":"41793026727", "url":"https://www.google.com", "sendDateTime":1704106800000, "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da", "bulkId":"17575032561857950495083", "callbackData":"Callback data", "recipientInfo":{ "deviceType":"Phone", "os":"iOS 12", "deviceName":"Apple" }, "geoLocationInfo":{ "countryName":"United States", "city":"Los Angeles" }, "applicationId":"traffic-application", "entityId":"traffic-entity" } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-outbound-sms-message-reports":{ "post":{ "tags":[ "channels", "sms", "logs-and-status-reports" ], "summary":"Receive outbound SMS message report", "description":"For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint [when sending SMS](#programmable-communications/sms/send-sms-message). Alternatively, you can set the endpoint URL through the [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com. Please note that the default number of delivery reports in a single request is 100. You can customize this value by defining \"maxBucketSize\" using the [Subscription Management API](https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription).\\\nYou'll receive this type of payload for messages sent using [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message).", "externalDocs":{ "description":"Learn more about the SMS channel and its use cases", "url":"https://www.infobip.com/docs/sms" }, "operationId":"receive-outbound-sms-message-report", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"BULK-ID-123-xyz", "messageId":"MESSAGE-ID-123-xyz", "to":"41793026727", "sentAt":"2019-11-09T16:00:00.000+0000", "doneAt":"2019-11-09T16:00:00.000+0000", "smsCount":1, "callbackData":"callbackData", "price":{ "pricePerMessage":0.01, "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 }, "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" }, { "bulkId":"BULK-ID-123-xyz", "messageId":"12db39c3-7822-4e72-a3ec-c87442c0ffc5", "to":"41793026834", "sentAt":"2019-11-09T17:00:00.000+0000", "doneAt":"2019-11-09T17:00:00.000+0000", "smsCount":1, "price":{ "pricePerMessage":0.01, "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 }, "applicationId":"default" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "deprecated":true } } } }