{
"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":"
**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":"
**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":"