{ "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:57.376121732Z" }, "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":"rcs", "description":"Rich Communication Services (RCS) is a new, visually appealing messaging channel that offers rich functionalities to enable more engaging customer journeys. RCS is sometimes referred to as the “SMS 2.0”. It takes everything users and companies already love about SMS—100% reach, reliability, ease of use, security—and builds on this to create an even better method of communication. Through a rich feature set that allows the creation of branded messages incorporating multimedia, suggested reply buttons, barcode delivery, click-through options and more, brands now have a new way to develop relationships through 2-Way communication.\n\n To utilize RCS in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).", "x-type":"product", "x-displayName":"RCS" }, { "name":"rcs-outbound-messages", "description":"When you send an RCS message to a phone number belonging to an end user's device you are sending an outbound RCS message.\n", "x-type":"module", "x-displayName":"Outbound Messages" }, { "name":"rcs-outbound-events", "description":"When you send an RCS event to a phone number belonging to an end user's device you are sending an outbound RCS event.\n", "x-type":"module", "x-displayName":"Outbound Events" }, { "name":"rcs-inbound-messages", "description":"When the end user sends an RCS message from their device to an RCS sender, they have sent an inbound RCS message.\n", "x-type":"module", "x-displayName":"Inbound Messages" }, { "name":"rcs-inbound-events", "description":"When the end user interacts with an RCS message — such as typing an answer — these actions generate inbound events that are sent back to the RCS sender.\n", "x-type":"module", "x-displayName":"Inbound Events" }, { "name":"rcs-logs-and-status-reports", "description":"Status Reports tell you what happened to the RCS message you have sent, whether it was successfully delivered or failed to be delivered. Logs provide similar information to Status Reports but are available to query for 48hrs.\n", "x-type":"module", "x-displayName":"Logs and Status Reports" }, { "name":"rcs-capability-check", "description":"RCS Capability Check feature gives you the possibility to check if some phone number can receive RCS messages \nfrom the specified sender.\n", "x-type":"module", "x-displayName":"Capability Check" }, { "name":"rcs-service-management", "description":"RCS Service Management allows you to manage your RCS senders, RCS test numbers, and RCS message templates.\n", "x-type":"module", "x-displayName":"Service Management" }, { "name":"rcs-sender-management", "description":"", "x-type":"section", "x-displayName":"Sender Management" }, { "name":"rcs-test-number-management", "description":"", "x-type":"section", "x-displayName":"Test Number Management" }, { "name":"rcs-template-management", "description":"", "x-type":"section", "x-displayName":"Template Management" } ], "paths":{ "/rcs/2/messages":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-messages" ], "summary":"Send RCS messages", "description":"Send RCS messages or RCS template messages to multiple recipients. Maximum request size is 10MB. Including some fields will affect [billing type](https://www.infobip.com/docs/rcs/billing-types).", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"send-rcs-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequest" }, "examples":{ "Basic text message":{ "summary":"Basic text message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Some text", "type":"TEXT" } } ] } }, "Single text message":{ "summary":"Single text message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Some text", "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"TEXT" } } ] } }, "Text message with SMS failover":{ "summary":"Text message with SMS failover", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Some text", "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"TEXT" }, "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" }, "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY" ], "from":{ "hour":9, "minute":0 }, "to":{ "hour":17, "minute":0 } }, "campaignReferenceId":"Example campaign id", "smsFailover":{ "sender":"DemoSender", "text":"Some failover text", "validityPeriod":{ "amount":1, "timeUnit":"HOURS" } } } } ] } }, "Text message with MMS failover":{ "summary":"Text message with MMS failover", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Some text", "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"TEXT" }, "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" }, "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY" ], "from":{ "hour":9, "minute":0 }, "to":{ "hour":17, "minute":0 } }, "campaignReferenceId":"Example campaign id", "mmsFailover":{ "sender":"DemoSender", "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "content":{ "title":"Example failover title", "messageSegments":[ { "text":"Example failover text", "type":"TEXT" } ] } } } } ] } }, "File message":{ "summary":"File message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "file":{ "url":"https://www.example.com/video.mp4" }, "thumbnail":{ "url":"https://www.example.com/thumbnail.jpg" }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"FILE" } } ] } }, "Card message":{ "summary":"Card message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Some title", "description":"Some description", "media":{ "file":{ "url":"https://www.example.com/video.mp4" }, "thumbnail":{ "url":"https://www.example.com/thumbnail.jpg" }, "height":"TALL" }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "url":"https://www.example.com/", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ] }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"CARD" } } ] } }, "Card message with URL tracking":{ "summary":"Card message with URL tracking", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Some title", "description":"Some description", "media":{ "file":{ "url":"https://www.example.com/video.mp4" }, "thumbnail":{ "url":"https://www.example.com/thumbnail.jpg" }, "height":"TALL" }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "url":"https://www.example.com/", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ] }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"CARD" } } ], "options":{ "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://www.example.com/tracking-callback-server", "removeProtocol":false } } } }, "Carousel message":{ "summary":"Carousel message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Some title", "description":"Some description", "media":{ "file":{ "url":"https://www.example.com/video.mp4" }, "thumbnail":{ "url":"https://www.example.com/thumbnail.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "url":"https://www.example.com/", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ] }, { "title":"Another title", "description":"Another description", "media":{ "file":{ "url":"https://www.sample.com/video_2.mp4" }, "thumbnail":{ "url":"https://www.sample.com/thumbnail_2.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Another example text", "postbackData":"Another example postback data", "url":"https://www.sample.com/", "application":"WEBVIEW", "webviewViewMode":"FULL", "type":"OPEN_URL" }, { "text":"Another example text", "postbackData":"Another example postback data", "type":"REPLY" } ] } ], "suggestions":[ { "text":"Example text", "postbackData":"Example postback data", "type":"REPLY" } ], "type":"CAROUSEL" } } ] } }, "Provider template message":{ "summary":"Provider template message", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "templateId":"ExampleTemplateId", "parameters":[ { "name":"param1", "value":"paramValue1" }, { "name":"param2", "value":"paramValue2" } ], "type":"PROVIDER_TEMPLATE" } } ] } }, "Text with different types of suggestions":{ "summary":"Text with different types of suggestions", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Some text", "suggestions":[ { "text":"Example reply", "postbackData":"Example postback data", "type":"REPLY" }, { "text":"Example open URL", "postbackData":"Example postback data", "url":"https://www.example.com/", "application":"WEBVIEW", "webviewViewMode":"TALL", "type":"OPEN_URL" }, { "text":"Example dial phone", "postbackData":"Example postback data", "phoneNumber":"+123456789", "type":"DIAL_PHONE" }, { "text":"Example show location", "postbackData":"Example postback data", "latitude":44.95303944321183, "longitude":13.856468230015984, "label":"Infobip HQ", "type":"SHOW_LOCATION" }, { "text":"Example request of location", "postbackData":"Example postback data", "type":"REQUEST_LOCATION" }, { "text":"Example create calendar event", "postbackData":"Example postback data", "startTime":"2024-06-14T09:00:00.000+0000", "endTime":"2024-06-14T10:00:00.000+0000", "title":"Example title", "description":"Example description", "type":"CREATE_CALENDAR_EVENT" } ], "type":"TEXT" } } ] } }, "Ordered messages with SMS failover":{ "summary":"Ordered messages with SMS failover", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"First message text", "type":"TEXT" }, "options":{ "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "campaignReferenceId":"Example campaign id", "smsFailover":{ "sender":"DemoSender", "text":"Some failover text", "validityPeriod":{ "amount":1, "timeUnit":"HOURS" } } } }, { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Second message text", "type":"TEXT" }, "options":{ "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "campaignReferenceId":"Example campaign id" } } ], "options":{ "messageOrdering":{ "respectOrder":true, "stopOnFailure":true } } } }, "Ordered messages without failover":{ "summary":"Ordered messages without failover", "value":{ "messages":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"First message text", "type":"TEXT" }, "options":{ "validityPeriod":{ "amount":1, "timeUnit":"HOURS" }, "campaignReferenceId":"Example campaign id" } }, { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Second message text", "type":"TEXT" }, "options":{ "validityPeriod":{ "amount":5, "timeUnit":"MINUTES" }, "campaignReferenceId":"Example campaign id" } }, { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "text":"Third message text", "type":"TEXT" }, "options":{ "validityPeriod":{ "amount":5, "timeUnit":"MINUTES" }, "campaignReferenceId":"Example campaign id" } } ], "options":{ "messageOrdering":{ "respectOrder":true, "stopOnFailure":true } } } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Success":{ "summary":"Success", "value":{ "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da", "messages":[ { "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"441134960001" } ] } } } } } }, "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", "rcs:message:send", "rcs:manage" ] } }, "/ott/rcs/1/message":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-messages" ], "summary":"Send RCS message", "description":"Used for sending single RCS messages", "operationId":"send-rcs-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest" }, "examples":{ "Text":{ "summary":"Text", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"TEXT" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } }, "File":{ "summary":"File", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "file":{ "url":"www.example.url" }, "thumbnail":{ "url":"www.thumbnail.example.url" }, "type":"FILE" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } }, "Card":{ "summary":"Card", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } }, "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CARD" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } }, "Carousel":{ "summary":"Carousel", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } } ], "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CAROUSEL" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } }, "SMS failover example":{ "summary":"SMS failover example", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "type":"TEXT" }, "smsFailover":{ "from":"myInfoSmsSender", "text":"We could not reach you over RCS messaging.", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } }, "SMS failover regional example":{ "summary":"SMS failover regional example", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "type":"TEXT" }, "smsFailover":{ "from":"myInfoSmsSender", "text":"We could not reach you over RCS messaging.", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "regional":{ "indiaDlt":{ "contentTemplateId":"myContentTemplateId", "principalEntityId":"myPrincipalEntityId" } } }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse" } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ] } }, "/ott/rcs/1/message/bulk":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-messages" ], "summary":"Send bulk RCS message", "description":"Used for sending bulk RCS messages", "operationId":"send-rcs-bulk-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendRequest" }, "examples":{ "Text":{ "summary":"Text", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"TEXT" }, "notifyUrl":"https://www.example.com/rcs/", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" }, { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"TEXT" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } }, "File":{ "summary":"File", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "file":{ "url":"www.example.url" }, "thumbnail":{ "url":"www.thumbnail.example.url" }, "type":"FILE" }, "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" }, { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "file":{ "url":"www.example.url" }, "thumbnail":{ "url":"www.thumbnail.example.url" }, "type":"FILE" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } }, "Card":{ "summary":"Card", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } }, "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CARD" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" }, { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } }, "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CARD" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } }, "Carousel":{ "summary":"Carousel", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } } ], "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CAROUSEL" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" }, { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"title,", "description":"description", "media":{ "file":{ "url":"url" }, "thumbnail":{ "url":"url" }, "height":"MEDIUM" } } ], "suggestions":[ { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REPLY" }, { "text":"exampleText", "postbackData":"examplePostbackData", "url":"www.example.test", "type":"OPEN_URL" }, { "text":"exampleText", "postbackData":"examplePostbackData", "phoneNumber":"385977666618", "type":"DIAL_PHONE" }, { "text":"exampleText", "postbackData":"examplePostbackData", "latitude":45.793418, "longitude":15.946297, "label":"label", "type":"SHOW_LOCATION" }, { "text":"exampleText", "postbackData":"examplePostbackData", "type":"REQUEST_LOCATION" } ], "type":"CAROUSEL" }, "notifyUrl":"https://www.example.com/rcs/", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } }, "SMS failover example":{ "summary":"SMS failover example", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "type":"TEXT" }, "smsFailover":{ "from":"myInfoSmsSender", "text":"We could not reach you over RCS messaging.", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES" }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } }, "SMS failover regional example":{ "summary":"SMS failover regional example", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "text":"exampleText", "type":"TEXT" }, "smsFailover":{ "from":"myInfoSmsSender", "text":"We could not reach you over RCS messaging.", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "regional":{ "indiaDlt":{ "contentTemplateId":"myContentTemplateId", "principalEntityId":"myPrincipalEntityId" } } }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse" } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ] } }, "/ott/rcs/1/message/template":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-messages" ], "summary":"Send RCS template message", "description":"Used for sending single RCS template messages (only for Vodafone Idea Limited, India)", "operationId":"send-rcs-template-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest" }, "examples":{ "Template":{ "summary":"Template", "value":{ "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "templateName":"myTemplateName", "templateData":{ "price":"100", "promocode":"ABC" } }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse" } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ] } }, "/ott/rcs/1/message/template/bulk":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-messages" ], "summary":"Send bulk RCS template message", "description":"Used for sending bulk RCS template messages (only for Vodafone Idea Limited, India)", "operationId":"send-rcs-bulk-template-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendTemplateRequest" }, "examples":{ "Bulk Template":{ "summary":"Bulk Template", "value":{ "messages":[ { "from":"myRcsSender", "to":"385977666618", "validityPeriod":15, "validityPeriodTimeUnit":"MINUTES", "content":{ "templateName":"myTemplateName", "templateData":{ "price":"100", "promocode":"ABC" } }, "notifyUrl":"https://www.example.com/rcs", "callbackData":"Callback data", "messageId":"externalMessageId", "entityId":"entityId", "applicationId":"applicationId" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse" } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ] } }, "/rcs/1/events":{ "post":{ "tags":[ "channels", "rcs", "rcs-outbound-events" ], "summary":"Send RCS events", "description":"Send RCS events to multiple recipients. Maximum request size is 10MB.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"send-rcs-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventRequest" }, "examples":{ "Typing indicator event":{ "summary":"Typing indicator event", "value":{ "events":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "type":"TYPING_INDICATOR" } } ] } }, "Seen event":{ "summary":"Seen event", "value":{ "events":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da", "type":"SEEN" } } ] } }, "Event with delivery time window":{ "summary":"Event with delivery time window", "value":{ "events":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "type":"TYPING_INDICATOR" }, "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application ID" }, "deliveryTimeWindow":{ "days":[ "MONDAY", "TUESDAY" ], "from":{ "hour":9, "minute":0 }, "to":{ "hour":17, "minute":0 } } } } ] } }, "Multiple events":{ "summary":"Multiple events", "value":{ "events":[ { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "type":"TYPING_INDICATOR" } }, { "sender":"DemoSender", "destinations":[ { "to":"441134960001" } ], "content":{ "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da", "type":"SEEN" } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Success":{ "summary":"Success", "value":{ "bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da", "messages":[ { "messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"441134960001" } ] } } } } } }, "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" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/2/reports":{ "get":{ "tags":[ "channels", "rcs", "rcs-logs-and-status-reports" ], "summary":"Get RCS delivery reports", "description":"If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"get-outbound-rcs-message-delivery-reports", "parameters":[ { "name":"bulkId", "in":"query", "description":"The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"messageId", "in":"query", "description":"The ID that uniquely identifies the message sent.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"limit", "in":"query", "description":"Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":50, "maximum":1000 }, "example":1 }, { "name":"entityId", "in":"query", "description":"Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"applicationId", "in":"query", "description":"Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that was sent in the message.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"summersale" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReports" }, "examples":{ "RCS message delivered":{ "summary":"RCS message delivered", "value":{ "results":[ { "bulkId":"BULK-123456", "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":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS message failed":{ "summary":"RCS message failed", "value":{ "results":[ { "bulkId":"BULK-123456", "status":{ "groupId":2, "groupName":"UNDELIVERABLE", "id":4, "name":"UNDELIVERABLE_REJECTED_OPERATOR", "description":"Message rejected by operator" }, "error":{ "groupId":1, "groupName":"HANDSET_ERRORS", "id":7002, "name":"EC_UNKNOWN_USER", "description":"No matching user found (on platform or on provider)", "permanent":true }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "rcs:message:send", "rcs:manage" ] } }, "/rcs/2/logs":{ "get":{ "tags":[ "channels", "rcs", "rcs-logs-and-status-reports" ], "summary":"Get RCS message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.", "operationId":"get-outbound-rcs-message-logs", "parameters":[ { "name":"sender", "in":"query", "description":"The sender ID which can be alphanumeric or numeric.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"destination", "in":"query", "description":"Message destination address.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } }, { "name":"bulkId", "in":"query", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"BULK-ID-123-xyz" }, { "name":"messageId", "in":"query", "description":"Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } }, "example":"MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz" }, { "name":"generalStatus", "in":"query", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogResponseLogRcsOutboundMessageContent" } } } }, "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":[ "rcs:logs:read", "rcs:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/rcs/2/capability-check/query":{ "post":{ "tags":[ "channels", "rcs", "rcs-capability-check" ], "summary":"Check RCS capability", "description":"Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 500 phone numbers in a single request; however, for improved efficiency, performance, and response time, we recommend using smaller batches of 1 to 10 numbers in a single request. This synchronous API is typically used for routing purposes when verifying a number’s RCS capability immediately before sending a message. This API supports up to a 100 requests per second. For bulk database cleanup, we recommend to use the asynchronous Capability Check (CapCheck) API.\n\nThe response will provide the list of capability statuses for each phone number individually. Ensure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If the sender is not launched on the network, the capability check request will always return a negative status for the tested phone numbers.", "operationId":"capability-check-rcs-destinations-query", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest" }, "examples":{ "RCS capability check request":{ "summary":"RCS capability check request", "value":{ "sender":"DemoSender", "phoneNumbers":[ "441134960001", "441134960002" ], "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest" }, "examples":{ "RCS capability check request":{ "summary":"RCS capability check request", "value":"\n DemoSender\n \n 441134960001\n 441134960002\n \n \n \n Example entity id\n Example application id\n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse" }, "examples":{ "RCS capability check successful response":{ "summary":"RCS capability check successful response", "value":{ "capabilityCheckResults":[ { "messageId":"d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8", "phoneNumber":"441134960001", "code":"ENABLED" }, { "messageId":"b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3", "phoneNumber":"441134960002", "code":"UNREACHABLE" } ], "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse" }, "examples":{ "RCS capability check successful response":{ "summary":"RCS capability check successful response", "value":"\n \n \n d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8\n 441134960001\n ENABLED\n \n \n b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3\n 441134960002\n UNREACHABLE\n \n \n \n \n Example entity id\n Example application id\n \n \n\n" } } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "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":[ "rcs:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":100, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/2/capability-check/notify":{ "post":{ "tags":[ "channels", "rcs", "rcs-capability-check" ], "summary":"Check RCS capability (async)", "description":"Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 10,000 phone numbers in a single request. The [Capability Check result](#channels/rcs/receive-capability-check-result) returns asynchronously and provides the capability status for each phone number individually.\n\nEnsure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If the sender is not launched on the network, the capability check request will always return a negative status for the tested phone numbers.", "operationId":"capability-check-rcs-destinations-notify", "requestBody":{ "description":"The request body contains the sender and a list of phone numbers to check for RCS capability.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "sender":"DemoSender", "phoneNumbers":[ "441134960001", "441134960002" ], "notifyUrl":"http://example.com/notify", "notifyContentType":"application/json", "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":"\n \n DemoSender\n \n \n \n 441134960001\n \n 441134960002\n \n \n \n https://example.com/notify\n \n application/xml\n \n \n \n \n \n Example entity id\n \n Example application id\n \n \n \n \n \n\n" } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse" }, "examples":{ "RCS capability check (async) successful response":{ "summary":"RCS capability check (async) successful response", "value":{ "bulkId":"d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8", "capabilityCheckRequestStates":[ { "messageId":"d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8", "phoneNumber":"441134960001", "status":"PENDING_ENROUTE" }, { "messageId":"b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3", "phoneNumber":"441134960002", "status":"PENDING_ENROUTE" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse" }, "examples":{ "RCS capability check (async) successful response":{ "summary":"RCS capability check (async) successful response", "value":"\n d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8\n \n \n d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8\n 441134960001\n PENDING_ENROUTE\n \n \n b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3\n 441134960002\n PENDING_ENROUTE\n \n \n\n" } } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "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":[ "rcs:manage" ] } }, "/rcs/1/senders":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Get RCS senders", "description":"Retrieve list of RCS senders.", "operationId":"get-rcs-senders", "parameters":[ { "name":"page", "in":"query", "description":"Results page you want to retrieve (0..N). The default value is 0.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":0 }, { "name":"size", "in":"query", "description":"Number of records per page (1..100). The default value is 20.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":20 }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property(,asc|desc). Default sort order is descending by 'updatedAt'. Sortable Properties: 'updatedAt', 'senderName'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"updatedAt,desc" } ], "responses":{ "200":{ "description":"List of RCS senders", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderPageResponse" }, "examples":{ "RCS Senders":{ "summary":"RCS Senders", "value":{ "results":[ { "senderName":"DemoSender", "senderStatus":"READY_FOR_TESTING", "billingCategory":"NON_CONVERSATIONAL", "useCase":"TRANSACTIONAL", "hostingRegion":"NORTH_AMERICA", "brand":{ "brandName":"SomeCompany" }, "googleAgentId":"demosender_axdawe0_agent", "displayName":"Demo Sender", "description":"Sender for demo purposes", "color":"#0B78D0", "bannerUrl":"https://www.somecompany.com/banner.jpg", "logoUrl":"https://www.somecompany.com/logo.jpg", "updatedAt":"2025-02-15T16:38:24.000+0000" }, { "senderName":"InfoSender", "senderStatus":"PENDING_LAUNCH", "billingCategory":"NON_CONVERSATIONAL", "useCase":"MULTI_USE", "hostingRegion":"NORTH_AMERICA", "brand":{ "brandName":"SomeCompany" }, "googleAgentId":"demosender_axdawe0_agent", "displayName":"Info Sender", "description":"Info service sender", "color":"#00756A", "bannerUrl":"https://www.somecompany.com/banner.jpg", "logoUrl":"https://www.somecompany.com/logo.jpg", "updatedAt":"2025-02-19T12:21:37.000+0000" } ], "paging":{ "page":0, "size":2, "totalPages":5, "totalResults":10 } } } } } } }, "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" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Create an RCS sender", "description":"Create an RCS sender. Created RCS sender can immediately be used to send test messages to test numbers. See [Add RCS test number](#channels/rcs/add-rcs-test-number) operation for more details about adding test numbers for sender. Please note that following limits will apply when creating RCS sender:\n* It is allowed to add up to 10 senders in total.\n\nPlease contact your account manager if you need to add more senders.", "operationId":"create-rcs-sender", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsSenderApiRequest" }, "examples":{ "Create RCS Sender request":{ "summary":"Create RCS Sender request", "value":{ "senderName":"DemoSender", "billingCategory":"NON_CONVERSATIONAL", "useCase":"TRANSACTIONAL", "hostingRegion":"NORTH_AMERICA", "brand":{ "brandName":"SomeCompany" }, "displayName":"Demo Sender", "description":"Sender for demo purposes", "color":"#0B78D0", "phones":[ { "phoneNumber":"+441134960002", "label":"Phone" } ], "emails":[ { "address":"john.smith@somecompany.com", "label":"Email" } ], "websites":[ { "url":"https://www.somecompany.com", "label":"Website" } ], "bannerUrl":"https://www.somecompany.com/banner.jpg", "logoUrl":"https://www.somecompany.com/logo.jpg", "privacy":{ "url":"https://www.somecompany.com/privacy", "label":"Privacy Policy" }, "termsOfService":{ "url":"https://www.somecompany.com/terms", "label":"Terms and Conditions" }, "platform":{ "applicationId":"demo-application", "entityId":"demo-entity" } } } } } }, "required":true }, "responses":{ "202":{ "description":"Request has been accepted and result of create sender operation will be sent to webhook", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse" }, "examples":{ "Accepted request":{ "summary":"Accepted request", "value":{ "senderName":"DemoSender", "senderStatus":"PENDING" } } } } } }, "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" }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Conflict":{ "summary":"Conflict", "value":{ "errorCode":"E409", "description":"Request cannot be processed due to conflicts with existing resources", "action":"Check violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message" } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Get RCS sender", "description":"Get a single RCS sender by sender name.", "operationId":"get-rcs-sender", "parameters":[ { "name":"senderName", "in":"path", "description":"Sender identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" } ], "responses":{ "200":{ "description":"RCS sender", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSender" }, "examples":{ "RCS Sender":{ "summary":"RCS Sender", "value":{ "senderName":"DemoSender", "senderStatus":"READY_FOR_TESTING", "billingCategory":"NON_CONVERSATIONAL", "useCase":"TRANSACTIONAL", "hostingRegion":"EUROPE", "brand":{ "brandName":"SomeCompany" }, "googleAgentId":"demosender_axdawe0_agent", "displayName":"Demo Sender", "description":"Sender for demo purposes", "color":"#0B78D0", "phones":[ { "phoneNumber":"+441134960002", "label":"Phone" } ], "emails":[ { "address":"john.smith@somecompany.com", "label":"Email" } ], "websites":[ { "url":"https://www.somecompany.com", "label":"Website" } ], "bannerUrl":"https://www.somecompany.com/banner.jpg", "logoUrl":"https://www.somecompany.com/logo.jpg", "privacy":{ "url":"https://www.somecompany.com/privacy", "label":"Privacy Policy" }, "termsOfService":{ "url":"https://www.somecompany.com/terms", "label":"Terms and Conditions" }, "platform":{ "applicationId":"demo-application", "entityId":"demo-entity" }, "updatedAt":"2025-02-15T16:38:24.000+0000" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Update an RCS sender", "description":"Update an RCS sender. Please note that once sender is locked, it's not possible to update sender data anymore.", "operationId":"update-rcs-sender", "parameters":[ { "name":"senderName", "in":"path", "description":"Sender identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditRcsSenderApiRequest" }, "examples":{ "Update RCS Sender request":{ "summary":"Update RCS Sender request", "value":{ "billingCategory":"NON_CONVERSATIONAL", "useCase":"MULTI_USE", "displayName":"Updated Demo Sender", "description":"Updated sender for demo purposes", "color":"#D0180B", "phones":[ { "phoneNumber":"+441134960003", "label":"Phone" } ], "emails":[ { "address":"john.smith@somenewcompany.com", "label":"Email" } ], "websites":[ { "url":"https://www.somenewcompany.com", "label":"Website" } ], "bannerUrl":"https://www.somenewcompany.com/banner.jpg", "logoUrl":"https://www.somenewcompany.com/logo.jpg", "privacy":{ "url":"https://www.somenewcompany.com/privacy", "label":"Privacy Policy" }, "termsOfService":{ "url":"https://www.somenewcompany.com/terms", "label":"Terms and Conditions" }, "platform":{ "applicationId":"updated-application", "entityId":"updated-entity" } } } } } }, "required":true }, "responses":{ "202":{ "description":"Request has been accepted and result of update sender operation will be sent to webhook", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse" }, "examples":{ "Accepted request":{ "summary":"Accepted request", "value":{ "senderName":"DemoSender", "senderStatus":"PENDING" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Conflict":{ "summary":"Conflict", "value":{ "errorCode":"E409", "description":"Request cannot be processed due to conflicts with existing resources", "action":"Check violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message" } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}/platform-parameters":{ "patch":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Update RCS sender platform parameters", "description":"Update platform parameters associated with RCS sender. These parameters can be edited at any point of time.", "operationId":"update-rcs-sender-platform-parameters", "parameters":[ { "name":"senderName", "in":"path", "description":"Sender identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditPlatformParametersApiRequest" }, "examples":{ "Update RCS Sender platform parameters request":{ "summary":"Update RCS Sender platform parameters request", "value":{ "platform":{ "applicationId":"demo-application", "entityId":"demo-entity" } } } } } }, "required":true }, "responses":{ "202":{ "description":"Request has been accepted and result of update sender operation will be sent to webhook", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse" }, "examples":{ "Accepted request":{ "summary":"Accepted request", "value":{ "senderName":"DemoSender", "senderStatus":"PENDING" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}/launch-status":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Get RCS sender launch status", "description":"Get detailed launch status information for an RCS sender, including coverage details by country and provider. This endpoint provides granular information about the launch progress across different carriers and regions.", "operationId":"get-rcs-sender-launch-status", "parameters":[ { "name":"senderName", "in":"path", "description":"Sender identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" } ], "responses":{ "200":{ "description":"RCS sender launch status with coverage details", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent" }, "examples":{ "RCS Sender Launch Status":{ "summary":"RCS Sender Launch Status", "value":{ "event":"RCS_SENDER_LAUNCH_STATUS_UPDATE", "senderName":"DemoSender", "senderStatus":"LAUNCHED_IN_PROGRESS", "coverage":[ { "countryCode":"US", "providers":[ { "name":"AEGIS_BRAND_VERIFICATION", "status":"COMPLETED", "updatedAt":"2025-02-15T16:38:24.000+0000" }, { "name":"VERIZON", "status":"IN_PROGRESS", "updatedAt":"2025-02-15T16:38:24.000+0000" }, { "name":"T_MOBILE", "status":"COMPLETED", "updatedAt":"2025-02-15T16:38:24.000+0000" }, { "name":"ATT", "status":"REJECTED", "rejectionReason":"Request rejected due to missing information: Privacy policy needs opt-out (\"Text STOP to opt out\"), \"Message and data rates may apply\" disclaimer, and frequency disclosure. Terms must include \"Information will not be sold, rented, or shared\" statement.", "updatedAt":"2025-02-15T16:38:24.000+0000" } ] } ], "updatedAt":"2026-07-22T11:45:08.923+0000" } } } } } }, "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" }, "404":{ "description":"Sender not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "RCS Sender Launch Status":{ "summary":"RCS Sender Launch Status", "value":{ "errorCode":"E404", "description":"Not found - request URL doesn't exist on the API server or resource is not found.", "action":"Check the resources and adjust your request.", "violations":[ { "property":"senderName", "violation":"sender \"DemoSender\" does not exist" } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/providers":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Get RCS available providers", "description":"Retrieve a list of RCS available providers specified by countries.", "operationId":"get-rcs-available-providers", "parameters":[ { "name":"countryCode", "in":"query", "description":"Country code in two-letter ISO 3166-1 alpha 2 standard. If set, only providers available in the specified country will be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"IN" }, { "name":"page", "in":"query", "description":"Results page you want to retrieve (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":0 }, "example":0 }, { "name":"pageSize", "in":"query", "description":"Number of records per page (1..200).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":20 }, "example":20 }, { "name":"sortDirection", "in":"query", "description":"Sorting order by property 'countryCode'. Sorting orders: ASC, DESC.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "default":"ASC" }, "example":"ASC" } ], "responses":{ "200":{ "description":"List of RCS available providers", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsCountryProvidersPageResponse" }, "examples":{ "RCS providers response filtered by country code":{ "summary":"RCS providers response filtered by country code", "value":{ "results":[ { "countryCode":"IN", "providers":[ "JIO", "VODAFONE" ] } ], "paging":{ "page":0, "size":1, "totalPages":1, "totalResults":1 } } }, "All RCS providers response":{ "summary":"All RCS providers response", "value":{ "results":[ { "countryCode":"IN", "providers":[ "JIO", "VODAFONE" ] }, { "countryCode":"US", "providers":[ "AT&T", "VERIZON" ] } ], "paging":{ "page":0, "size":20, "totalPages":1, "totalResults":2 } } } } } } }, "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" }, "404":{ "description":"Not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "RCS no coverage response":{ "summary":"RCS no coverage response", "value":{ "errorCode":"E404", "description":"No Carriers/Providers available for a given country.", "action":"Please try again with a different country code.", "violations":[ { "property":"REQUEST", "violation":"No Carriers/Providers available for country with code IN." } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}/test-numbers":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Get RCS test numbers", "description":"Get RCS test numbers for given sender. Please note that information about status of test number was correct at the moment when test number was last time updated. If latest status for some test number is needed, [Get RCS test number](#channels/rcs/get-rcs-test-number) operation can be used.", "operationId":"get-rcs-test-numbers", "parameters":[ { "name":"senderName", "in":"path", "description":"Identifier of a sender for which test number is requested.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" }, { "name":"page", "in":"query", "description":"Results page you want to retrieve (0..N). The default value is 0.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":0 }, { "name":"size", "in":"query", "description":"Number of records per page (1..100). The default value is 20.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":20 }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property(,asc|desc). Default sort order is descending by 'updatedAt'. Sortable Properties: 'updatedAt'.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"updatedAt,desc" } ], "responses":{ "200":{ "description":"List of RCS test numbers", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberPageResponse" }, "examples":{ "RCS test numbers":{ "summary":"RCS test numbers", "value":{ "results":[ { "testNumber":"+441134960001", "status":"WAITING_FOR_TESTER_ACCEPTANCE", "updatedAt":"2025-02-22T11:13:42.000+0000", "primary":false }, { "testNumber":"+441134960002", "status":"APPROVED", "updatedAt":"2025-02-24T13:18:47.000+0000", "primary":false } ], "paging":{ "page":0, "size":2, "totalPages":5, "totalResults":10 } } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Add RCS test number", "description":"Add test number for given RCS sender. Invitation to become tester will be sent to given number and once user accepts invitation it will be possible to send test traffic to given test number using given sender. Please note that following limits will apply when adding test number for RCS sender:\n* It is allowed to add up to 20 test numbers per sender per day.\n* It is allowed to add up to 200 test number per sender in total.", "operationId":"add-rcs-test-number", "parameters":[ { "name":"senderName", "in":"path", "description":"Identifier of a sender for which test number is requested.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTestNumberApiRequest" }, "examples":{ "Add RCS test number request":{ "summary":"Add RCS test number request", "value":{ "testNumber":"+441134960001", "primary":false } } } } }, "required":true }, "responses":{ "202":{ "description":"Request has been accepted and result of add test number operation will be sent to webhook", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse" }, "examples":{ "Accepted request":{ "summary":"Accepted request", "value":{ "senderName":"DemoSender", "testNumber":"+441134960001", "status":"PENDING" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Conflict":{ "summary":"Conflict", "value":{ "errorCode":"E409", "description":"Request cannot be processed due to conflicts with existing resources", "action":"Check violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message" } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}/test-numbers/{testNumber}":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Get RCS test number", "description":"Get RCS test number. This operation will check current status of given test number and return most up to date result.", "operationId":"get-rcs-test-number", "parameters":[ { "name":"senderName", "in":"path", "description":"Identifier of a sender for which test number is requested.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" }, { "name":"testNumber", "in":"path", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"+441134960001" } ], "responses":{ "200":{ "description":"RCS test number", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber" }, "examples":{ "RCS test number":{ "summary":"RCS test number", "value":{ "testNumber":"+441134960001", "status":"WAITING_FOR_TESTER_ACCEPTANCE", "updatedAt":"2025-02-22T11:13:42.000+0000", "primary":false } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Update primary flag of RCS test number", "description":"Update primary flag of RCS test number.", "operationId":"update-rcs-test-number-primary", "parameters":[ { "name":"senderName", "in":"path", "description":"Identifier of a sender for which test number is requested.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" }, { "name":"testNumber", "in":"path", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"+441134960001" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.UpdateRcsTestNumberPrimaryApiRequest" } } }, "required":true }, "responses":{ "202":{ "description":"RCS test number", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber" } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{senderName}/test-numbers/{testNumber}/refresh":{ "put":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Refresh RCS test number", "description":"Status of RCS test number is automatically refreshed for 24 hours after it was added. If user does not accept invitation to become a tester in that period, test number will be marked as EXPIRED. Use this endpoint in order to start new 24 hours cycle in which system will periodically check if user has accepted to become a tester.", "operationId":"refresh-rcs-test-number", "parameters":[ { "name":"senderName", "in":"path", "description":"Identifier of a sender for which test number is requested.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"DemoSender" }, { "name":"testNumber", "in":"path", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"+441134960001" } ], "responses":{ "202":{ "description":"Request has been accepted and result of refresh test number operation will be sent to webhook", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse" }, "examples":{ "Accepted request":{ "summary":"Accepted request", "value":{ "senderName":"DemoSender", "testNumber":"+441134960001", "status":"PENDING" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Conflict":{ "summary":"Conflict", "value":{ "errorCode":"E409", "description":"Request cannot be processed due to conflicts with existing resources", "action":"Check violations and adjust the request.", "violations":[ { "property":"property.path", "violation":"Violation message" } ], "resources":[] } } } } } }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{sender}/templates":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Get RCS templates", "description":"Retrieve all RCS templates and their statuses for a specified sender. Available only for senders that support templates.", "operationId":"rcs-template-list", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose templates will be retrieved.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"status", "in":"query", "description":"The status used to filter and retrieve templates with the specified state. If the status is not specified, all templates are returned.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus" }, "example":"APPROVED" } ], "responses":{ "200":{ "description":"List of all templates with status for the given sender.", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateListItem" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "name":"Text template name", "type":"TEXT", "status":"APPROVED", "lastUpdate":"2024-07-16T10:30:00.000+0000" }, { "name":"Text template name2", "type":"TEXT", "status":"APPROVED", "lastUpdate":"2024-07-16T12:30:00.000+0000" } ] } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Create an RCS template", "description":"Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates.", "operationId":"rcs-template-create-v2", "parameters":[ { "name":"sender", "in":"path", "description":"The sender for whom the template will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTemplateRequest" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "templateName":"special_offer", "providers":[], "content":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" } } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "templateName":"special_offer_card", "providers":[], "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" } } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "templateName":"special_offer_card", "providers":[], "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" } } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "templateName":"user_agreement_pdf", "providers":[], "content":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" } } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "templateName":"holiday_booking_abc123", "providers":[], "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" } } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "templateName":"template_params", "providers":[], "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" } } } } } }, "required":true }, "responses":{ "200":{ "description":"RCS template created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "name":"special_offer", "type":"TEXT", "status":"PENDING", "content":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "name":"user_agreement_pdf", "type":"TEXT_WITH_PDF", "status":"PENDING", "content":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "name":"holiday_booking_abc123", "type":"CAROUSEL", "status":"PENDING", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "name":"template_params", "type":"CARD", "status":"PENDING", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{sender}/templates/{templateName}":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Get RCS template", "description":"Retrieve a single RCS template with its status for a given sender and template name. Available only for senders that support templates.", "externalDocs":{ "description":"Learn more about the RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"rcs-template-get", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose specific template will be retrieved.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template that will be retrieved for the specified sender.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":20, "minLength":1 }, "example":"demo_template" } ], "responses":{ "200":{ "description":"Template details for the given sender and template name.", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "name":"special_offer", "type":"TEXT", "status":"PENDING", "content":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "name":"user_agreement_pdf", "type":"TEXT_WITH_PDF", "status":"PENDING", "content":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "name":"holiday_booking_abc123", "type":"CAROUSEL", "status":"PENDING", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "name":"template_params", "type":"CARD", "status":"PENDING", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Edit an RCS template", "description":"Edit an RCS template. Only PENDING, SUSPENDED or REJECTED templates can be edited. APPROVED templates cannot be modified. Available only for senders that support templates..", "operationId":"rcs-template-update", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose template will be updated.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template that will be updated for the specified sender.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":20, "minLength":1 }, "example":"demo_template" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" } } } } }, "required":true }, "responses":{ "200":{ "description":"RCS template edited successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "name":"demo_template", "type":"TEXT", "status":"PENDING", "content":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "name":"demo_template", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "name":"demo_template", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "name":"demo_template", "type":"TEXT_WITH_PDF", "status":"PENDING", "content":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "name":"demo_template", "type":"CAROUSEL", "status":"PENDING", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "name":"demo_template", "type":"CARD", "status":"PENDING", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Create an RCS template", "description":"Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates. Please note that this endpoint is deprecated and will be removed in future versions.", "operationId":"rcs-template-create", "parameters":[ { "name":"sender", "in":"path", "description":"The sender for whom the template will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template that will be created for the specified sender. Must contain only alphanumeric characters and underscores.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":20, "minLength":1 }, "example":"demo_template" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" } } } } }, "required":true }, "responses":{ "200":{ "description":"RCS template created successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate" }, "examples":{ "A Text message template example with a single parameter in the message text and a Reply suggestion":{ "summary":"A Text message template example with a single parameter in the message text and a Reply suggestion", "value":{ "name":"special_offer", "type":"TEXT", "status":"PENDING", "content":{ "text":"Hello {{username}}! We've got a special offer for you!", "suggestions":[ { "text":"Thanks, I'm good", "postbackData":"decline", "type":"REPLY" }, { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ], "type":"TEXT" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with an Open url suggestion":{ "summary":"A Card message template example with an Open url suggestion", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop online", "postbackData":"web", "url":"https://google.com", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Card message template example with multiple Open url suggestions":{ "summary":"A Card message template example with multiple Open url suggestions", "value":{ "name":"special_offer_card", "type":"CARD", "status":"PENDING", "content":{ "orientation":"VERTICAL", "alignment":"RIGHT", "content":{ "title":"We wish you a happy holiday!", "description":"We've got a special offer for you!", "media":{ "file":{ "url":"https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Shop now!", "postbackData":"shop_click", "url":"https://google.com", "application":"BROWSER", "type":"OPEN_URL" }, { "text":"Get your personal discount for shopping later", "postbackData":"discount_click", "url":"https://google.com", "application":"WEBVIEW", "webviewViewMode":"HALF", "type":"OPEN_URL" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Text message with PDF template example with Reply suggestions":{ "summary":"A Text message with PDF template example with Reply suggestions", "value":{ "name":"user_agreement_pdf", "type":"TEXT_WITH_PDF", "status":"PENDING", "content":{ "text":"Please read and confirm the User Agreement", "url":"https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf", "messageOrder":"TEXT_MESSAGE_AT_TOP", "suggestions":[ { "text":"I confirm", "postbackData":"confirm", "type":"REPLY" }, { "text":"I decline", "postbackData":"decline", "type":"REPLY" } ], "type":"TEXT_WITH_PDF" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "A Carousel message template example with 2 suggestions per each card":{ "summary":"A Carousel message template example with 2 suggestions per each card", "value":{ "name":"holiday_booking_abc123", "type":"CAROUSEL", "status":"PENDING", "content":{ "cardWidth":"MEDIUM", "contents":[ { "title":"Small cabin in the woods", "description":"the perfect place to start your Shinrin-yoku", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/fff.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_1", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_1", "type":"REPLY" } ] }, { "title":"A big house for a big company", "description":"When the whole family is gathered!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/57b535/000.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Pay online", "postbackData":"pay_online_option_2", "url":"https://google.com/?option=1", "type":"OPEN_URL" }, { "text":"Pay on-site", "postbackData":"pay_onsite_option_2", "type":"REPLY" } ] } ], "type":"CAROUSEL" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } }, "An advanced example: Card message template with parameters in all available fields":{ "summary":"An advanced example: Card message template with parameters in all available fields", "value":{ "name":"template_params", "type":"CARD", "status":"PENDING", "content":{ "orientation":"HORIZONTAL", "alignment":"LEFT", "content":{ "title":"Hello {{username}}! ", "description":"We've got a special discount of {{discount_percent}}% for you!", "media":{ "file":{ "url":"https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg" }, "height":"MEDIUM" }, "suggestions":[ { "text":"Sounds interesting: send me an email to:{{user_email}}", "postbackData":"{{userId}}_email", "type":"REPLY" }, { "text":"Call {{shop_name}}", "postbackData":"{{userId}}_call", "phoneNumber":"{{shop_number}}", "type":"DIAL_PHONE" }, { "text":"For offline shopping find {{shop_name}} here!", "postbackData":"{{usedId}}_offline", "latitude":72.83359188518756, "longitude":19.18467193599901, "label":"We're right here!", "type":"SHOW_LOCATION" }, { "text":"Check if delivery from {{shop_name}} is possible ", "postbackData":"{{usedId}}_delivery", "type":"REQUEST_LOCATION" }, { "text":"Don't forget our next sale on {{next_date}}", "postbackData":"{{usedId}}_next_opt_in", "startTime":"2030-03-03T15:00Z", "endTime":"2030-03-05T15:00Z", "title":"Best prices from {{shop_name}}!", "description":"It's never too late, {{user_title}}. {{user_lastname}}!", "type":"CREATE_CALENDAR_EVENT" } ] }, "type":"CARD" }, "lastUpdate":"2024-11-05T12:00:00.000+0000" } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-deprecationInformation":{ "deprecation":"2025-11-12T12:00:00.000+0000", "successorOperationId":"rcs-template-create-v2" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Delete an RCS template", "description":"Delete an RCS template. Any messages sent using a deleted template will be rejected. Available only for senders that support templates.", "operationId":"rcs-template-delete", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose template will be deleted.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template that will be deleted for the specified sender.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":20, "minLength":1 }, "example":"demo_template" } ], "responses":{ "200":{ "description":"RCS template deleted successfully" }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{sender}/templates/{templateName}/status":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Get RCS template status", "description":"Retrieve the detailed status of a specified RCS template for a given sender. Available only for senders that support templates.", "operationId":"rcs-template-get-status", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose template status will be retrieved.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template for which the status will be retrieved.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"demo_template" } ], "responses":{ "200":{ "description":"RCS Template Status", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiDetailedStatusResponse" }, "examples":{ "the status of the requested template":{ "summary":"the status of the requested template", "description":"The template with the requested templateName is APPROVED", "value":{ "status":"APPROVED", "name":"demo_template", "coverage":[ { "countryCode":"IN", "providers":[ { "providerName":"INDIA_VI", "status":"APPROVED", "updatedAt":"2024-11-05T12:00:00.000+0000" } ] } ] } } } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/senders/{sender}/templates/{templateName}/register":{ "patch":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Register an RCS template", "description":"Registers an RCS template with additional providers. Available only for senders that support templates.", "operationId":"rcs-template-register", "parameters":[ { "name":"sender", "in":"path", "description":"The sender whose template should be registered with additional providers.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"templateName", "in":"path", "description":"The unique name of the template that should be registered with additional providers.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "maxLength":20, "minLength":1 }, "example":"demo_template" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsRegisterTemplateRequest" } } }, "required":true }, "responses":{ "200":{ "description":"RCS template registered successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate" } } } }, "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" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":1, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/rcs/1/templates/template-providers":{ "get":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Get RCS template providers", "description":"Get list of available template providers. List can be filtered by sender and country code.", "operationId":"rcs-template-providers", "parameters":[ { "name":"sender", "in":"query", "description":"The sender for which the list of available template providers should be retrieved.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Demo" }, { "name":"countryCode", "in":"query", "description":"Country code in two-letter ISO standard. If set, only providers available in the specified country will be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"IN" } ], "responses":{ "200":{ "description":"RCS template providers list fetched successfully", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProvidersResponse" }, "examples":{ "RCS template providers":{ "summary":"RCS template providers", "value":{ "providers":[ "INDIA_VI", "INDONESIA_TELKOMSEL" ] } } } } } }, "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" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "rcs:manage", "rcs:provision" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } } }, "components":{ "schemas":{ "7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendRequest":{ "type":"object", "properties":{ "messages":{ "type":"array", "items":{ "$ref":"#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest" } } }, "title":"RcsBulkSendRequest" }, "808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendTemplateRequest":{ "type":"object", "properties":{ "messages":{ "type":"array", "items":{ "$ref":"#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest" } } }, "required":[ "messages" ], "title":"RcsBulkSendTemplateRequest" }, "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", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest":{ "type":"object", "properties":{ "from":{ "type":"string", "description":"Message sender.", "example":"myRcsSender" }, "to":{ "type":"string", "description":"Message destination.", "example":"385977666618" }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"Message validity period.", "example":15 }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent" }, "smsFailover":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest" }, "notifyUrl":{ "type":"string", "description":"The URL on your call back server on which the Delivery report will be sent." }, "callbackData":{ "type":"string", "description":"Custom client data that will be included in Delivery Report." }, "messageId":{ "type":"string", "description":"MessageId data that will be included in Delivery Report." }, "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":255, "minLength":0 }, "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":255, "minLength":0 } }, "required":[ "content", "to" ], "title":"RcsSendRequest" }, "a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest":{ "type":"object", "properties":{ "from":{ "type":"string", "description":"Message sender.", "example":"myRcsSender" }, "to":{ "type":"string", "description":"Message destination.", "example":"385977666618" }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"Message validity period.", "example":15 }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TemplateRcsApiMtContent" }, "smsFailover":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest" }, "notifyUrl":{ "type":"string", "description":"The URL on your call back server on which the Delivery report will be sent." }, "callbackData":{ "type":"string", "description":"Custom client data that will be included in Delivery Report." }, "messageId":{ "type":"string", "description":"MessageId data that will be included in Delivery Report." }, "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":255, "minLength":0 }, "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":255, "minLength":0 } }, "required":[ "content", "to" ], "title":"RcsSendTemplateRequest" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedMessageDeliveryReporting":{ "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." }, "receiveTriggeredFailoverReports":{ "type":"boolean", "description":"Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`." } }, "title":"AdvancedMessageDeliveryReporting" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedWebhooksWithSeen":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedMessageDeliveryReporting" }, "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 }, "seen":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenStatusReporting" } }, "title":"AdvancedWebhooksWithSeen" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Alignment":{ "type":"string", "description":"Image preview alignment for Card message with horizontal layout.", "enum":[ "LEFT", "RIGHT" ], "title":"Alignment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest":{ "type":"object", "properties":{ "sender":{ "type":"string", "description":"Identifier of an RCS sender that will be used to send message." }, "phoneNumbers":{ "type":"array", "description":"A list of phone numbers to check for RCS capability (for example, `[\"441134960001\", \"441134960002\"]`).", "items":{ "type":"string", "xml":{ "name":"phoneNumbers" } }, "maxItems":10000, "minItems":1 }, "notifyUrl":{ "type":"string", "description":"The URL of your callback server where the RCS capability check report will be sent. The schema for this endpoint is documented at [Receive Capability Check result](#channels/rcs/receive-capability-check-result).If notifyUrl is empty, events will be sent to the URL you added via Subscription API. The event name is CapCheck." }, "notifyContentType":{ "type":"string", "description":"The preferred content type for the RCS capability check report. Options are: `application/json` or `application/xml`." }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions" } }, "required":[ "phoneNumbers", "sender" ], "title":"CapabilityCheckAsyncRequest", "xml":{ "name":"CapabilityCheckAsyncRequest" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request. This ID is automatically generated and will be included in the API response." }, "capabilityCheckRequestStates":{ "type":"array", "description":"The sync response from the RCS capability checker for the specified phone numbers. Represents the current status of the requests.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckRequestState" } } }, "required":[ "bulkId", "capabilityCheckRequestStates" ], "title":"CapabilityCheckAsyncResponse", "xml":{ "name":"CapabilityCheckAsyncResponse" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult":{ "type":"object", "properties":{ "capabilityCheckResult":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResult" }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions" } }, "required":[ "capabilityCheckResult" ], "title":"CapabilityCheckAsyncResult", "xml":{ "name":"CapabilityCheckAsyncResult" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions":{ "type":"object", "properties":{ "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" } }, "title":"CapabilityCheckOptions", "xml":{ "name":"CapabilityCheckOptions" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckRequestState":{ "type":"object", "description":"The sync response from the RCS capability checker for the specified phone numbers. Represents the current status of the requests.", "properties":{ "messageId":{ "type":"string", "description":"A unique message ID. This ID is automatically generated and will be included in the API response." }, "phoneNumber":{ "type":"string", "description":"The recipient's phone number that was checked for RCS capability." }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.StatusReason" } }, "required":[ "messageId", "phoneNumber", "status" ], "title":"CapabilityCheckRequestState", "xml":{ "name":"CapabilityCheckRequestState" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2":{ "type":"string", "description":"The result of the RCS capability check for the specified phone number. Following codes are available:\n* `ENABLED`: The number can receive RCS messages from the specified sender.\n* `UNREACHABLE`: The number cannot receive RCS messages from the specified sender.\n* `REJECTED_NETWORK`: Message not sent, network not allowed.\n* `REJECTED_ROUTE_NOT_AVAILABLE`: Route not available for that sender.\n* `REQUEST_FAILED`: External problems during capability check\n* `PROCESSING_ERROR`: The results for the number couldn’t be processed. Please try again.\n* `INVALID_DESTINATION_ADDRESS`: Number provided in wrong format.\n* `UNKNOWN_CODE`: Unknown error. Contact with support.\n", "enum":[ "ENABLED", "UNREACHABLE", "REJECTED_NETWORK", "REJECTED_ROUTE_NOT_AVAILABLE", "REQUEST_FAILED", "PROCESSING_ERROR", "INVALID_DESTINATION_ADDRESS", "UNKNOWN_CODE" ], "title":"CapabilityCheckResponseCodeV2" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResult":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request. This ID is automatically generated and will be included in the API response." }, "messageId":{ "type":"string", "description":"A unique message ID. This ID is automatically generated and will be included in the API response." }, "phoneNumber":{ "type":"string", "description":"The recipient's phone number that was checked for RCS capability." }, "code":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2" } }, "required":[ "bulkId", "code", "messageId", "phoneNumber" ], "title":"CapabilityCheckResult", "xml":{ "name":"CapabilityCheckResult" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest":{ "type":"object", "properties":{ "sender":{ "type":"string", "description":"Identifier of an RCS sender that will be used to send message." }, "phoneNumbers":{ "type":"array", "description":"A list of phone numbers (1 to 5) to check for RCS capability (for example, `[\"441134960001\", \"441134960002\"]`).", "items":{ "type":"string", "xml":{ "name":"phoneNumbers" } }, "maxItems":500, "minItems":1 }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions" } }, "required":[ "phoneNumbers", "sender" ], "title":"CapabilityCheckSyncRequest", "xml":{ "name":"CapabilityCheckSyncRequest" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse":{ "type":"object", "properties":{ "capabilityCheckResults":{ "type":"array", "description":"The result of the RCS capability check for the specified phone numbers.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResult" } }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions" } }, "required":[ "capabilityCheckResults" ], "title":"CapabilityCheckSyncResponse", "xml":{ "name":"CapabilityCheckSyncResponse" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResult":{ "type":"object", "description":"The result of the RCS capability check for the specified phone numbers.", "properties":{ "messageId":{ "type":"string", "description":"A unique message ID. This ID is automatically generated and will be included in the API response." }, "phoneNumber":{ "type":"string", "description":"The recipient's phone number that was checked for RCS capability." }, "code":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2" } }, "required":[ "code", "messageId", "phoneNumber" ], "title":"CapabilityCheckSyncResult", "xml":{ "name":"CapabilityCheckSyncResult" } }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardContent":{ "type":"object", "description":"Object containing contents of an RCS card. Must contain media or title to be valid.", "properties":{ "title":{ "type":"string", "description":"Title of the card, displayed as bolded text.", "example":"Card title", "maxLength":200, "minLength":1 }, "description":{ "type":"string", "description":"Description of the card, displayed as regular text.", "example":"Some supercool, attention-grabbing description", "maxLength":2000, "minLength":1 }, "media":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardMedia" }, "suggestions":{ "type":"array", "description":"List of button suggestions that will be sent in card.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":4, "minItems":0 } }, "title":"CardContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardMedia":{ "type":"object", "description":"Object defining display of card media.", "properties":{ "file":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardResourceSchema" }, "thumbnail":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Resource" }, "height":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Height" } }, "required":[ "file", "height" ], "title":"CardMedia" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardRcsApiMtContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent" }, { "type":"object", "properties":{ "orientation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Orientation" }, "alignment":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Alignment" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardContent" }, "suggestions":{ "type":"array", "description":"List of suggestions", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":10, "minItems":0 } } } ], "required":[ "alignment", "content", "orientation", "type" ], "title":"CardRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardResourceSchema":{ "type":"object", "description":"Resource object describing the main media of the card. ", "properties":{ "url":{ "type":"string", "description":"Specifies the URL of the media resource. For supported file formats and aspect ratios, see documentation:\n\n- [Rich Card](https://www.infobip.com/docs/rcs/rcs-message-types-and-templates#message-types-using-rcs-rich-card)\n- [Carousel](https://www.infobip.com/docs/rcs/rcs-message-types-and-templates#message-types-using-rcs-carousel)\n\nNote that support for specific content types may vary depending on the mobile network operator.\n", "maxLength":2048, "minLength":1 } }, "required":[ "url" ], "title":"CardResourceSchema" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CarouselRcsApiMtContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent" }, { "type":"object", "properties":{ "cardWidth":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Width" }, "contents":{ "type":"array", "description":"An array of cards contained within the carousel", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardContent" }, "maxItems":10, "minItems":2 }, "suggestions":{ "type":"array", "description":"List of suggestions", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":10, "minItems":0 } } } ], "required":[ "cardWidth", "contents", "type" ], "title":"CarouselRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CreateCalendarEventSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 }, "startTime":{ "type":"string", "format":"date-time", "description":"The date and time when the event starts.
It must be in the future and before `endTime`. The required format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ` (for example, `2030-03-03T15:00:00.000+01:00`).
The displayed `startTime` may be affected by the device's default time zone.
For best practices on date formats, refer to our [documentation](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats-backward-compatibility)." }, "endTime":{ "type":"string", "format":"date-time", "description":"The date and time when the event ends.
It must be in the future and after `startTime`. The required format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ` (for example, `2030-03-03T17:00:00.000+01:00`).
The displayed `endTime` may be affected by the device's default time zone.
For best practices on date formats, refer to our [documentation](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats-backward-compatibility)." }, "title":{ "type":"string", "description":"Event title.", "maxLength":100, "minLength":1 }, "description":{ "type":"string", "description":"Event description.", "maxLength":500, "minLength":1 } } } ], "description":"Opens the user's default calendar app and starts the new calendar event flow with the agent-specified event data pre-filled.", "required":[ "endTime", "postbackData", "startTime", "text", "title", "type" ], "title":"CreateCalendarEventSuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DefaultSmsFailover":{ "type":"object", "description":"Failover SMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "text":{ "type":"string", "description":"Content of the message being sent." }, "validityPeriod":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod" }, "regional":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RegionalOptions" } }, "required":[ "text" ], "title":"DefaultSmsFailover" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice" }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus" }, "error":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReport" } } }, "title":"DeliveryReports" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DialPhoneSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 }, "phoneNumber":{ "type":"string", "description":"Valid phone number.", "example":"385977666618", "pattern":"^\\+?[0-9]\\d{1,14}$" } } } ], "description":"Opens the user's default dialer app with the agent-specified phone number filled in.", "required":[ "phoneNumber", "postbackData", "text", "type" ], "title":"DialPhoneSuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FileRcsApiMtContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent" }, { "type":"object", "properties":{ "file":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Resource" }, "thumbnail":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Resource" } } } ], "required":[ "file", "type" ], "title":"FileRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent":{ "type":"object", "description":"Rcs message contents.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TextRcsApiMtContent", "FILE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FileRcsApiMtContent", "CARD":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardRcsApiMtContent", "CAROUSEL":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CarouselRcsApiMtContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContentType" } }, "title":"FreeFormRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContentType":{ "type":"string", "description":"Message type, describing type of message which is going to be sent over RCS", "enum":[ "TEXT", "FILE", "CARD", "CAROUSEL", "TEXT", "FILE", "CARD", "CAROUSEL" ], "title":"FreeFormRcsApiMtContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Height":{ "type":"string", "description":"Height of the card media.", "enum":[ "SHORT", "MEDIUM", "TALL" ], "example":"TALL", "title":"Height" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDlt":{ "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." } }, "required":[ "principalEntityId" ], "title":"IndiaDlt" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogRcsOutboundMessageContent":{ "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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice" }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus" }, "error":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError" }, "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"LogRcsOutboundMessageContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogResponseLogRcsOutboundMessageContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogRcsOutboundMessageContent" } }, "cursor":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CursorPageInfo" } }, "title":"LogResponseLogRcsOutboundMessageContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseMessageResponseDetails":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "messageId":{ "type":"string", "description":"Unique message ID. If not provided, it will be auto-generated and returned in the API response." }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundContent":{ "type":"object", "description":"Content of the failover message being sent.", "properties":{ "title":{ "type":"string", "description":"Message title.", "maxLength":66, "minLength":0 }, "messageSegments":{ "type":"array", "description":"Content of the message being sent.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment" } } }, "required":[ "messageSegments" ], "title":"MmsOutboundContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundLinkSegment":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment" }, { "type":"object", "properties":{ "contentId":{ "type":"string", "description":"Unique identifier within single message. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers." }, "contentType":{ "type":"string", "description":"Content type for media, for example `image/png`." }, "contentUrl":{ "type":"string", "description":"URL of externally hosted content." } } } ], "required":[ "contentUrl", "type" ], "title":"MmsOutboundLinkSegment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment":{ "type":"object", "description":"Content of the message being sent.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundTextSegment", "LINK":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundLinkSegment", "SMIL":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSmilSegment", "UPLOADED_REFERENCE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundUploadedReferenceSegment" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegmentType" } }, "required":[ "type" ], "title":"MmsOutboundSegment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegmentType":{ "type":"string", "enum":[ "TEXT", "LINK", "SMIL", "UPLOADED_REFERENCE" ], "title":"MmsOutboundSegmentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSmilSegment":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment" }, { "type":"object", "properties":{ "contentId":{ "type":"string", "description":"Unique identifier within single message. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers." }, "contentType":{ "type":"string", "description":"Content type for media, for example `application/smil`." }, "smil":{ "type":"string", "description":"Message segment as SMIL format. Be aware that some devices and/or operating systems ignore SMIL, so there is no guarantee that segments will be displayed as specified in SMIL format." } } } ], "required":[ "contentType", "smil", "type" ], "title":"MmsOutboundSmilSegment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundTextSegment":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment" }, { "type":"object", "properties":{ "contentId":{ "type":"string", "description":"Unique identifier within single message. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers." }, "text":{ "type":"string", "description":"Content of the message being sent.", "maxLength":4096, "minLength":0 } } } ], "required":[ "text", "type" ], "title":"MmsOutboundTextSegment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundUploadedReferenceSegment":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment" }, { "type":"object", "properties":{ "contentId":{ "type":"string", "description":"Unique identifier within single message. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers." }, "uploadedContentId":{ "type":"string", "description":"ID of previously uploaded binary content.", "externalDocs":{ "description":"Upload binary content.", "url":"https://www.infobip.com/docs/api/channels/mms/upload-binary" } } } } ], "required":[ "type", "uploadedContentId" ], "title":"MmsOutboundUploadedReferenceSegment" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.OpenUrlApplicationType":{ "type":"string", "description":"Type of the URL open application. It is used to define how URL will be opened on a mobile phone. Following options are available:\n* `BROWSER`: Browser will be used on a mobile phone to open URL. If application not specified or if device does not support webviews, URL will be opened using browser.\n* `WEBVIEW`: Integrated webview window will be used on a mobile phone to open URL.\n", "enum":[ "BROWSER", "WEBVIEW" ], "title":"OpenUrlApplicationType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.OpenUrlSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 }, "url":{ "type":"string", "description":"URL that will be opened on a mobile phone when the suggestion is selected. Must be a valid URI using the http or https scheme as defined in RFC 3986. Other URI schemes are not supported.", "example":"https://www.infobip.com", "maxLength":2048, "minLength":1 }, "application":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.OpenUrlApplicationType" }, "webviewViewMode":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.WebviewViewModeType" } } } ], "description":"Opens the user's default web browser app to the specified URL.", "required":[ "postbackData", "text", "type", "url" ], "title":"OpenUrlSuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Orientation":{ "type":"string", "description":"Orientation type defines orientation in Card message.", "enum":[ "HORIZONTAL", "VERTICAL" ], "title":"Orientation" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Parameter":{ "type":"object", "description":"Parameter to be replaced in the template.", "properties":{ "name":{ "type":"string", "description":"Parameter name." }, "value":{ "type":"string", "description":"Parameter value." } }, "required":[ "name", "value" ], "title":"Parameter" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse":{ "type":"object", "properties":{ "messages":{ "type":"array", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageInfo" } } }, "required":[ "messages" ], "title":"RcsApiResponse" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConvStartedTrafficType":{ "type":"string", "description":"Traffic type applied to the inbound or outbound RCS message. Null for non chargeable RCS messages.", "enum":[ "A2P_CONVERSATION", "INTERACTIVE_SESSION" ], "title":"RcsConvStartedTrafficType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo":{ "type":"object", "description":"Conversation information associated with the message.", "properties":{ "canInitiate":{ "type":"boolean", "description":"Indicates whether this message can initiate or trigger a conversation. If the message already belongs to a conversation, the value is false." }, "id":{ "type":"string", "description":"Unique conversation identifier. Present when the message belongs to a conversation, null otherwise." } }, "required":[ "canInitiate" ], "title":"RcsConversationInfo" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvent":{ "type":"object", "description":"Collection of conversation started events.", "properties":{ "messageId":{ "type":"string", "description":"The ID that uniquely identifies the sent/received message." }, "trafficType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConvStartedTrafficType" }, "event":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventContent" }, "conversation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedInfo" }, "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" } }, "required":[ "conversation", "event", "messageId", "platform" ], "title":"RcsConversationStartedEvent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventContent":{ "type":"object", "description":"Conversation Started event details.", "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventType" } }, "required":[ "type" ], "title":"RcsConversationStartedEventContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventType":{ "type":"string", "description":"Conversation started event type.", "enum":[ "CONVERSATION_STARTED", "CONVERSATION_STARTED" ], "title":"RcsConversationStartedEventType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvents":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of conversation started events.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvent" } }, "eventCount":{ "type":"integer", "format":"int32", "description":"The number of events returned in the results array." }, "pendingEventCount":{ "type":"integer", "format":"int32", "description":"The number of events that have not been pulled in." } }, "required":[ "eventCount", "pendingEventCount", "results" ], "title":"RcsConversationStartedEvents" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedInfo":{ "type":"object", "description":"Conversation details including type, ID, and time window.", "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationType" }, "id":{ "type":"string", "description":"Unique conversation identifier." }, "startTime":{ "type":"string", "format":"date-time", "description":"Conversation start time." }, "endTime":{ "type":"string", "format":"date-time", "description":"Conversation end time." } }, "required":[ "endTime", "id", "startTime", "type" ], "title":"RcsConversationStartedInfo" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationType":{ "type":"string", "description":"Conversation type (Application to Person/Person to Application/Interactive session).", "enum":[ "A2P", "P2A", "INTERACTIVE_SESSION" ], "title":"RcsConversationType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrMessagePrice":{ "type":"object", "description":"Price object with traffic type information.", "properties":{ "trafficType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrTrafficType" }, "pricePerMessage":{ "type":"number", "description":"Price per one message." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"RcsDlrMessagePrice" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrTrafficType":{ "type":"string", "description":"Traffic type applied to the RCS message that the delivery report refers to. Null for not chargeable RCS messages.", "enum":[ "BASIC", "SINGLE", "RICH", "RICH_MEDIA", "P2A_CONVERSATION", "INTERACTIVE_SESSION" ], "title":"RcsDlrTrafficType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEvent":{ "type":"object", "description":"An array of event objects of the events to be sent.", "properties":{ "sender":{ "type":"string", "description":"Identifier of an RCS sender that will be used to send event." }, "destinations":{ "type":"array", "description":"An array of destination objects for where the event is being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination" } }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContent" }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventOptions" } }, "required":[ "content", "destinations", "sender" ], "title":"RcsEvent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventInteractionType":{ "type":"string", "description":"The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.", "enum":[ "EVENT" ], "title":"RcsEventInteractionType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventOptions":{ "type":"object", "description":"Event options.", "properties":{ "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTimeWindow" } }, "title":"RcsEventOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventRequest":{ "type":"object", "properties":{ "events":{ "type":"array", "description":"An array of event objects of the events to be sent.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEvent" } } }, "required":[ "events" ], "title":"RcsEventRequest" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsFailoverOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTimeWindow" }, "campaignReferenceId":{ "type":"string", "description":"ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.", "maxLength":255, "minLength":0 }, "smsFailover":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DefaultSmsFailover" }, "mmsFailover":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMmsFailover" } }, "title":"RcsFailoverOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundContentType":{ "type":"string", "enum":[ "TEXT", "FILE", "LOCATION", "SUGGESTION" ], "title":"RcsInboundContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvent":{ "type":"object", "description":"Collection of mobile originated events.", "properties":{ "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." }, "sender":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "integrationType":{ "type":"string", "description":"Integration type." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "interactionType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventInteractionType" }, "keyword":{ "type":"string", "description":"Keyword extracted from the message text." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "message":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContent" }, "price":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoEventMessagePrice" }, "conversation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo" }, "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo" } }, "required":[ "conversation", "integrationType", "interactionType", "message", "messageId", "platform", "price", "receivedAt", "sender", "to" ], "title":"RcsInboundEvent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "SUGGESTION":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundSuggestionContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContentType" } }, "required":[ "type" ], "title":"RcsInboundEventContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContentType":{ "type":"string", "enum":[ "SUGGESTION" ], "title":"RcsInboundEventContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvents":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of mobile originated events.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvent" } }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of events returned in the results array." }, "pendingMessageCount":{ "type":"integer", "format":"int32", "description":"The number of events that have not been pulled in." } }, "required":[ "messageCount", "pendingMessageCount", "results" ], "title":"RcsInboundEvents" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundFileContent":{ "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the file which is sent in an incoming message." }, "name":{ "type":"string", "description":"Name of a file which is sent in an incoming message." }, "contentType":{ "type":"string", "description":"Content type of a file which is sent in an incoming message." }, "size":{ "type":"integer", "format":"int64", "description":"Size of the file which is sent in an incoming message. Minimum value is 0. Size of file is considered to be expressed in bytes.", "minimum":0 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundContentType" } }, "required":[ "contentType", "name", "size", "type", "url" ], "title":"RcsInboundFileContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundLocationContent":{ "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "description":"Latitude. The value must be between -90 and 90.", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude. The value must be between -180 and 180.", "maximum":180, "minimum":-180 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundContentType" } }, "required":[ "latitude", "longitude", "type" ], "title":"RcsInboundLocationContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessage":{ "type":"object", "description":"Collection of mobile originated messages.", "properties":{ "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." }, "sender":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "integrationType":{ "type":"string", "description":"Integration type." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "interactionType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType" }, "rcsCount":{ "type":"integer", "format":"int32", "description":"A field that informs the client how many segment counts does a MO message contain. Can be received as > 1 for use case of Rich message in USA." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message text." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "message":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContent" }, "price":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoMessagePrice" }, "conversation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo" }, "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo" } }, "required":[ "conversation", "integrationType", "interactionType", "message", "messageId", "platform", "price", "rcsCount", "receivedAt", "sender", "to" ], "title":"RcsInboundMessage" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundTextContent", "FILE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundFileContent", "SUGGESTION":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundSuggestionContent", "LOCATION":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundLocationContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContentType" } }, "required":[ "type" ], "title":"RcsInboundMessageContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContentType":{ "type":"string", "enum":[ "TEXT", "FILE", "SUGGESTION", "LOCATION" ], "title":"RcsInboundMessageContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessages":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of mobile originated messages.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessage" } }, "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." } }, "required":[ "messageCount", "pendingMessageCount", "results" ], "title":"RcsInboundMessages" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundSuggestionContent":{ "type":"object", "properties":{ "text":{ "type":"string", "description":"Incoming suggestion text." }, "postbackData":{ "type":"string", "description":"postbackData of incoming suggestion." }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundContentType" } }, "required":[ "postbackData", "text", "type" ], "title":"RcsInboundSuggestionContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundTextContent":{ "type":"object", "properties":{ "text":{ "type":"string", "description":"The text which is sent in an incoming message." }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundContentType" } }, "required":[ "text", "type" ], "title":"RcsInboundTextContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvent":{ "type":"object", "description":"Collection of typing indicator events.", "properties":{ "sender":{ "type":"string", "description":"Number which sent the event.", "example":"441134960001" }, "to":{ "type":"string", "description":"Sender provided during the activation process.", "example":"DemoSender" }, "receivedAt":{ "type":"string", "description":"Date and time when Infobip received the event. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "example":"2025-02-06T15:35:12.123+0000" }, "event":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventContent" }, "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 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 } }, "required":[ "event", "receivedAt", "sender", "to" ], "title":"RcsIsTypingEvent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventContent":{ "type":"object", "description":"Event content.", "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventType" } }, "required":[ "type" ], "title":"RcsIsTypingEventContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventType":{ "type":"string", "description":"Type of received event.", "enum":[ "TYPING_INDICATOR" ], "example":"TYPING_INDICATOR", "title":"RcsIsTypingEventType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvents":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of typing indicator events.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvent" } }, "eventCount":{ "type":"integer", "format":"int32", "description":"The number of events returned in the results array.", "example":1 }, "pendingEventCount":{ "type":"integer", "format":"int32", "description":"The number of events that have not been pulled in.", "example":42 } }, "required":[ "eventCount", "pendingEventCount", "results" ], "title":"RcsIsTypingEvents" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessage":{ "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":"Identifier of an RCS sender that will be used to send message." }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination" } }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent" }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsFailoverOptions" }, "webhooks":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedWebhooksWithSeen" } }, "required":[ "content", "destinations" ], "title":"RcsMessage" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType":{ "type":"string", "description":"The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.", "enum":[ "BASIC_MESSAGE", "SINGLE_MESSAGE", "RICH_MESSAGE", "RICH_MEDIA_MESSAGE" ], "title":"RcsMessageInteractionType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageOrderingOptions":{ "type":"object", "properties":{ "respectOrder":{ "type":"boolean", "default":true, "description":"If set to `true`, messages will be sent in the same order as they are provided in the request. Following rules must be respected in that case:\n* The `messages` array can contain either 2 messages, where only the first message has failover defined, or between 2 and 10 messages, none of which has failover defined.\n* Following properties must be the same for all messages in the request: `sender`, `destinations`, `options.platform`, `options.deliveryTimeWindow`, `options.campaignReferenceId`, `webhooks.delivery`, `webhooks.contentType`, `webhooks.callbackData`, `webhooks.seen`.\nFor best experience, if message ordering is used, it's recommended to have list of suggestions defined for last message only or have it the same for all messages in the request.", "example":true }, "stopOnFailure":{ "type":"boolean", "default":true, "description":"It can be used in combination with `respectOrder` to stop sending messages if any message fails. It will be respected only if none of the messages from the request has failover defined. If failover is used, the system will, by default, send only the failover message and will not send the second message from the request.", "example":true } }, "title":"RcsMessageOrderingOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequest":{ "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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessage" } }, "options":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequestOptions" } }, "required":[ "messages" ], "title":"RcsMessageRequest" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequestOptions":{ "type":"object", "properties":{ "schedule":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestSchedulingSettings" }, "tracking":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.UrlOptions" }, "messageOrdering":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageOrderingOptions" } }, "title":"RcsMessageRequestOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMmsFailover":{ "type":"object", "description":"Failover MMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.", "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)." }, "validityPeriod":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundContent" } }, "required":[ "content" ], "title":"RcsMmsFailover" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoEventMessagePrice":{ "type":"object", "description":"Price object with traffic type information.", "properties":{ "trafficType":{ "type":"string", "description":"Always will be null, events are not chargeable." }, "pricePerMessage":{ "type":"number", "description":"Price per one message." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"RcsMoEventMessagePrice" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoMessagePrice":{ "type":"object", "description":"Price object with traffic type information.", "properties":{ "trafficType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoTrafficType" }, "pricePerMessage":{ "type":"number", "description":"Price per one message." }, "currency":{ "type":"string", "description":"The currency in which the price is expressed." } }, "title":"RcsMoMessagePrice" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoTrafficType":{ "type":"string", "description":"Traffic type applied to the MO message. Null for not chargeable messages.", "enum":[ "BASIC", "SINGLE", "RICH", "RICH_MEDIA" ], "title":"RcsMoTrafficType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCardContent":{ "type":"object", "properties":{ "orientation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Orientation" }, "alignment":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Alignment" }, "content":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardContent" }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":11, "minItems":0 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "alignment", "content", "orientation", "type" ], "title":"RcsOutboundCardContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCarouselContent":{ "type":"object", "properties":{ "cardWidth":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Width" }, "contents":{ "type":"array", "description":"An array of cards contained within the carousel.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardContent" }, "maxItems":10, "minItems":2 }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":11, "minItems":0 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "cardWidth", "contents", "type" ], "title":"RcsOutboundCarouselContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContent":{ "type":"object", "description":"Event content.", "discriminator":{ "propertyName":"type", "mapping":{ "SEEN":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventSeenContent", "TYPING_INDICATOR":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventTypingIndicatorContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType" } }, "required":[ "type" ], "title":"RcsOutboundEventContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType":{ "type":"string", "enum":[ "SEEN", "TYPING_INDICATOR" ], "title":"RcsOutboundEventContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventSeenContent":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"ID of the message that should be marked as seen." }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType" } }, "required":[ "messageId", "type" ], "title":"RcsOutboundEventSeenContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventTypingIndicatorContent":{ "type":"object", "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType" } }, "required":[ "type" ], "title":"RcsOutboundEventTypingIndicatorContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundFileContent":{ "type":"object", "properties":{ "file":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResourceSchema" }, "thumbnail":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Resource" }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":11, "minItems":0 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "file", "type" ], "title":"RcsOutboundFileContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundTextContent", "FILE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundFileContent", "CARD":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCardContent", "CAROUSEL":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCarouselContent", "PROVIDER_TEMPLATE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundProviderTemplateContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "type" ], "title":"RcsOutboundMessageContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType":{ "type":"string", "enum":[ "TEXT", "FILE", "CARD", "CAROUSEL", "PROVIDER_TEMPLATE" ], "title":"RcsOutboundMessageContentType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundProviderTemplateContent":{ "type":"object", "properties":{ "templateId":{ "type":"string", "description":"Unique Template code. Must match Template name as registered when creating template. Mismatch will result in EC7018." }, "parameters":{ "type":"array", "description":"Template parameters. Parameter names should match ones defined in template and value to be replaced in message. Mismatch will result in EC7018.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Parameter" } }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "templateId", "type" ], "title":"RcsOutboundProviderTemplateContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundTextContent":{ "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":3072, "minLength":0 }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":11, "minItems":0 }, "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType" } }, "required":[ "text", "type" ], "title":"RcsOutboundTextContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo":{ "type":"object", "description":"Platform information associated with the message.", "properties":{ "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 }, "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 } }, "title":"RcsPlatformInfo" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReport":{ "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." }, "channel":{ "type":"string", "description":"The channel used to deliver a message. This property will be present only if the original message was sent with the failover option defined. The property will be included in the delivery report for the original RCS message and for the failover message (in case the failover was triggered).", "enum":[ "RCS", "SMS", "MMS" ] }, "price":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrMessagePrice" }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus" }, "error":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError" }, "conversation":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo" }, "messageId":{ "type":"string", "description":"Unique message ID." }, "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." }, "interactionType":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType" }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of sent messages." }, "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." }, "mccMnc":{ "type":"string", "description":"Mobile country and network codes." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "to":{ "type":"string", "description":"Message destination address." }, "sender":{ "type":"string", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, "platform":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"RcsWebhookDeliveryReport" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReport" } } }, "title":"RcsWebhookDeliveryReports" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Regional":{ "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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDlt" } }, "title":"Regional" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ReplySuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 } } } ], "description":"When tapped, sends the text reply back to the agent.", "required":[ "postbackData", "text", "type" ], "title":"ReplySuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestLocationSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 } } } ], "description":"Opens the RCS app's location chooser so the user can pick a location to send back to the agent.", "required":[ "postbackData", "text", "type" ], "title":"RequestLocationSuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Resource":{ "type":"object", "description":"Resource object describing the thumbnail of the card, applicable to video files only.", "properties":{ "url":{ "type":"string", "description":"URL of the given resource.", "maxLength":2048, "minLength":1 } }, "required":[ "url" ], "title":"Resource" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResourceSchema":{ "type":"object", "description":"Resource object describing the media.", "properties":{ "url":{ "type":"string", "description":"URL of the given resource. The following content types are supported: `image/jpeg`, `image/jpg`, `image/gif`, `image/png`, `audio/aac`, `audio/mp3`, `audio/mpeg`, `audio/mpg`, `audio/mp4`, `audio/mp4-latm`, `audio/3gpp`, `application/ogg`, `audio/ogg`, `video/h263`, `video/m4v`, `video/mp4`, `video/mpeg`, `video/mpeg4`, `video/webm`, `application/pdf`. Should start with `http://` or `https://`. Up to 100 MB.", "maxLength":2048, "minLength":1 } }, "required":[ "url" ], "title":"ResourceSchema" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails":{ "type":"object", "properties":{ "bulkId":{ "type":"string", "description":"Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs." }, "messages":{ "type":"array", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReport":{ "type":"object", "description":"Collection of reports, one per every message.", "properties":{ "messageId":{ "type":"string", "description":"The ID of the sent message." }, "from":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "sentAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was sent." }, "seenAt":{ "type":"string", "format":"date-time", "description":"Tells when the message was seen." }, "applicationId":{ "type":"string", "description":"Application id that the message is linked to." }, "entityId":{ "type":"string", "description":"Entity id that the message is linked to." }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"SeenReport" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReport" } } }, "title":"SeenReports" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenStatusReporting":{ "type":"object", "description":"Provides options for configuring the seen report behavior.", "properties":{ "url":{ "type":"string", "description":"The URL on your call back server where a seen report will be sent." } }, "title":"SeenStatusReporting" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ShowLocationSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Suggestion text.", "example":"Pick one!", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "description":"Value which is going to be sent as a reply to a suggestion.", "example":"REPLY", "maxLength":2024, "minLength":1 }, "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location.", "example":45.793418, "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location.", "example":15.946297, "maximum":180, "minimum":-180 }, "label":{ "type":"string", "description":"Label of the location.", "example":"Navigate to our office", "maxLength":100, "minLength":1 } } } ], "description":"Opens the user's default map app and selects the agent-specified location or searches around the user's location given an agent-specified query.", "required":[ "latitude", "longitude", "postbackData", "text", "type" ], "title":"ShowLocationSuggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageInfo":{ "type":"object", "properties":{ "to":{ "type":"string", "description":"The destination address of the message.", "example":"385977666618" }, "messageCount":{ "type":"integer", "format":"int32", "description":"Number of messages required to deliver.", "example":1 }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.", "example":"06df139a-7eb5-4a6e-902e-40e892210455" }, "status":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageStatus" } }, "title":"SingleMessageInfo" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageStatus":{ "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.", "example":1 }, "groupName":{ "type":"string", "description":"Status group name.", "example":"PENDING" }, "id":{ "type":"integer", "format":"int32", "description":"Status ID.", "example":7 }, "name":{ "type":"string", "description":"Status name.", "example":"PENDING_ENROUTE" }, "description":{ "type":"string", "description":"Human-readable description of the status.", "example":"Message sent to next instance" }, "action":{ "type":"string", "description":"Action that should be taken to eliminate the error." } }, "title":"SingleMessageStatus" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest":{ "type":"object", "description":"Sms failover message contents.", "properties":{ "from":{ "type":"string", "description":"Message failover sender.", "example":"myFailoverRcsSender" }, "text":{ "type":"string", "description":"Message failover text.", "example":"This message was sent over SMS." }, "validityPeriod":{ "type":"integer", "format":"int32", "description":"Message failover validity period.", "example":15 }, "validityPeriodTimeUnit":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange" }, "regional":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Regional" } }, "required":[ "from", "text" ], "title":"SmsFailoverRequest" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.StatusReason":{ "type":"string", "description":"[The status](https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes) of RCS capability check request for the specified phone number.", "enum":[ "PENDING_TIME_VIOLATION", "DELIVERED_TO_OPERATOR", "PENDING_WAITING_DELIVERY", "UNDELIVERABLE_REJECTED_OPERATOR", "DELIVERED_TO_HANDSET", "REJECTED_NETWORK", "PENDING_ENROUTE", "REJECTED_PREFIX_MISSING", "UNDELIVERABLE_NOT_DELIVERED", "REJECTED_DND", "REJECTED_SOURCE", "REJECTED_NOT_ENOUGH_CREDITS", "REJECTED_SENDER", "REJECTED_DESTINATION", "EXPIRED_EXPIRED", "REJECTED_NOT_REACHABLE", "REJECTED_PREPAID_PACKAGE_EXPIRED", "REJECTED_DESTINATION_NOT_REGISTERED", "REJECTED_ROUTE_NOT_AVAILABLE", "REJECTED_FLOODING_FILTER", "REJECTED_SYSTEM_ERROR", "EXPIRED_UNKNOWN", "REJECTED_DUPLICATE_MESSAGE_ID", "REJECTED_INVALID_UDH", "REJECTED_MESSAGE_TOO_LONG", "REJECTED_NOT_SENT", "EXPIRED_DLR_UNKNOWN", "MO_DELIVERED", "UNDELIVERABLE_NOT_SENT", "MISSING_TO", "INVALID_DESTINATION_ADDRESS", "CONCATENATED_MESSAGE_TOO_LONG", "REJECTED_MONTHLY_LIMIT_REACHED", "REJECTED_SMPP_SESSION_CLOSED", "INVALID_SUBACCOUNT_NAME", "REJECTED_GATEWAY_DATA_TOO_LONG", "INVALID_COMPANY_ID", "REJECTED_INVALID_TRACKING_DATA", "REJECTED_INVALID_COUNT", "REJECTED_FREE_TRIAL_EXCEEDED", "REJECTED_SUBSCRIPTION_PLAN_NOT_ACTIVE", "SIM_SWAP_DETECTED", "DEACTIVATED_LIST", "INVALID_CLIENT_NETWORK", "CURRENCY_CHANGE_IN_PROGRESS", "REJECTED_UNREACHABLE_DESTINATION", "SIGNALS_BLOCKED", "VOLUMETRIC_BLOCKED", "REJECTED_BLOCKED_TEMPLATE", "REJECTED_INVALID_PLATFORM_PARAMETERS", "REJECTED_SHORT_DOMAIN_NOT_VERIFIED", "REJECTED_10DLC_LIMIT_REACHED", "REJECTED_INVALID_BYO_EXTERNAL_ID" ], "title":"StatusReason" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion":{ "type":"object", "description":"List of suggestions", "discriminator":{ "propertyName":"type", "mapping":{ "REPLY":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ReplySuggestion", "OPEN_URL":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.OpenUrlSuggestion", "DIAL_PHONE":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DialPhoneSuggestion", "SHOW_LOCATION":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ShowLocationSuggestion", "REQUEST_LOCATION":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestLocationSuggestion", "CREATE_CALENDAR_EVENT":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CreateCalendarEventSuggestion" } }, "properties":{ "type":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SuggestionType" } }, "required":[ "type" ], "title":"Suggestion" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SuggestionType":{ "type":"string", "enum":[ "REPLY", "OPEN_URL", "DIAL_PHONE", "SHOW_LOCATION", "REQUEST_LOCATION", "CREATE_CALENDAR_EVENT" ], "title":"SuggestionType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TemplateRcsApiMtContent":{ "type":"object", "description":"Rcs message contents.", "properties":{ "templateName":{ "type":"string", "description":"Unique template code as visible in the Vi RBM Portal" }, "templateData":{ "type":"object", "additionalProperties":{ "type":"string", "example":"{\"name\":\"John Smith\",\"city\":\"New York\"}" }, "description":"Name-Value pairs of parameters included in the template, as defined in the Vi RBM Portal", "example":{ "name":"John Smith", "city":"New York" } } }, "required":[ "templateName" ], "title":"TemplateRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TextRcsApiMtContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text", "maxLength":1000, "minLength":1 }, "suggestions":{ "type":"array", "description":"List of suggestions", "items":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Suggestion" }, "maxItems":10, "minItems":0 } } } ], "required":[ "text", "type" ], "title":"TextRcsApiMtContent" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange":{ "type":"string", "description":"Message failover validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS", "DAYS" ], "example":"MINUTES", "title":"TimeUnitValueRange" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination":{ "type":"object", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "properties":{ "to":{ "type":"string", "description":"The destination address of the message." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent.", "maxLength":200, "minLength":0 } }, "required":[ "to" ], "title":"Destination" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.WebviewViewModeType":{ "type":"string", "description":"Type of the webview's view mode. It must be defined when `application` is set to `WEBVIEW`. Following options are available:\n* `FULL`: The web page takes up the full screen on a mobile phone.\n* `HALF`: The web page takes up half of the screen on a mobile phone.\n* `TALL`: The web page takes up three quarters of the screen on a mobile phone.\n", "enum":[ "FULL", "HALF", "TALL" ], "title":"WebviewViewModeType" }, "b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Width":{ "type":"string", "description":"Width of cards contained within the carousel", "enum":[ "SMALL", "MEDIUM" ], "example":"MEDIUM", "title":"Width" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Alignment":{ "type":"string", "description":"Image preview alignment for Card message with horizontal layout.", "enum":[ "LEFT", "RIGHT" ], "title":"Alignment" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CardMedia":{ "type":"object", "properties":{ "file":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CardResourceSchema" }, "thumbnail":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Resource" }, "height":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Height" } }, "required":[ "file", "height" ], "title":"CardMedia" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CardResourceSchema":{ "type":"object", "description":"Resource object describing the main media of the card. ", "properties":{ "url":{ "type":"string", "description":"Specifies the URL of the media resource. For supported file formats and aspect ratios, see documentation:\n\n- [Rich Card](https://www.infobip.com/docs/rcs/rcs-message-types-and-templates#message-types-using-rcs-rich-card)\n- [Carousel](https://www.infobip.com/docs/rcs/rcs-message-types-and-templates#message-types-using-rcs-carousel)\n\nNote that support for specific content types may vary depending on the mobile network operator.\n", "maxLength":2048, "minLength":1 } }, "required":[ "url" ], "title":"CardResourceSchema" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryCoverage":{ "type":"object", "description":"Coverage information by country showing launch status for each provider.", "properties":{ "countryCode":{ "type":"string", "description":"Country code where the sender is being launched." }, "providers":{ "type":"array", "description":"List of providers in the country and their launch status.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderSenderLaunchStatus" } } }, "required":[ "countryCode", "providers" ], "title":"CountryCoverage" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryProviders":{ "type":"object", "properties":{ "countryCode":{ "type":"string", "description":"Country code in two-letter ISO 3166-1 alpha 2 standard. If set, only providers available in the specified country will be returned." }, "providers":{ "type":"array", "description":"Name of the provider.", "items":{ "type":"string", "description":"Name of the provider." }, "uniqueItems":true } }, "required":[ "countryCode", "providers" ], "title":"CountryProviders" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsSenderApiRequest":{ "type":"object", "properties":{ "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform. It must be provided when submitting RCS traffic to Infobip platform. It must contain only alphanumeric characters, underscores and hyphens, and must contain at least one letter. It's not editable at any point of time after sender is created.", "maxLength":40, "minLength":3, "pattern":"^(?=.*[a-zA-Z])[a-zA-Z0-9_-]+$" }, "billingCategory":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory" }, "useCase":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase" }, "hostingRegion":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion" }, "brand":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand" }, "displayName":{ "type":"string", "description":"The name of the sender displayed to the user on mobile device.", "maxLength":40, "minLength":1 }, "description":{ "type":"string", "description":"The description of the sender displayed to the user on mobile device.", "maxLength":100, "minLength":1 }, "color":{ "type":"string", "description":"Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.", "pattern":"^#?([A-Fa-f0-9]{6})$" }, "phones":{ "type":"array", "description":"List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone" } }, "emails":{ "type":"array", "description":"List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email" } }, "websites":{ "type":"array", "description":"List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress" } }, "bannerUrl":{ "type":"string", "description":"URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "logoUrl":{ "type":"string", "description":"URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "privacy":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress" }, "termsOfService":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress" }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "bannerUrl", "billingCategory", "brand", "color", "description", "displayName", "hostingRegion", "logoUrl", "privacy", "senderName", "termsOfService", "useCase" ], "title":"CreateRcsSenderApiRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTemplateRequest":{ "type":"object", "properties":{ "templateName":{ "type":"string", "description":"The unique name of the template that will be created for the specified sender. Must contain only alphanumeric characters and underscores.", "example":"demo_template", "maxLength":20, "minLength":1 }, "providers":{ "type":"array", "default":[], "description":"List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that default value is empty array and in that case the template will be registered with all providers available for given sender.", "example":[ "INDIA_VI" ], "items":{ "type":"string", "default":"[]", "description":"List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that default value is empty array and in that case the template will be registered with all providers available for given sender.", "example":"[\"INDIA_VI\"]" }, "uniqueItems":true }, "content":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" } }, "required":[ "content", "providers", "templateName" ], "title":"CreateRcsTemplateRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTestNumberApiRequest":{ "type":"object", "properties":{ "testNumber":{ "type":"string", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.", "pattern":"^\\+?[1-9]\\d{1,14}$" }, "primary":{ "type":"boolean", "default":false, "description":"Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association." } }, "required":[ "testNumber" ], "title":"CreateRcsTestNumberApiRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditPlatformParametersApiRequest":{ "type":"object", "properties":{ "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "platform" ], "title":"EditPlatformParametersApiRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditRcsSenderApiRequest":{ "type":"object", "properties":{ "billingCategory":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory" }, "useCase":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase" }, "displayName":{ "type":"string", "description":"The name of the sender displayed to the user on mobile device.", "maxLength":40, "minLength":1 }, "description":{ "type":"string", "description":"The description of the sender displayed to the user on mobile device.", "maxLength":100, "minLength":1 }, "color":{ "type":"string", "description":"Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.", "pattern":"^#?([A-Fa-f0-9]{6})$" }, "phones":{ "type":"array", "description":"List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone" } }, "emails":{ "type":"array", "description":"List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email" } }, "websites":{ "type":"array", "description":"List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress" } }, "bannerUrl":{ "type":"string", "description":"URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "logoUrl":{ "type":"string", "description":"URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "privacy":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress" }, "termsOfService":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress" }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "bannerUrl", "billingCategory", "color", "description", "displayName", "logoUrl", "privacy", "termsOfService", "useCase" ], "title":"EditRcsSenderApiRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email":{ "type":"object", "description":"List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.", "properties":{ "address":{ "type":"string", "description":"Email address. Must be in valid email format.", "maxLength":100, "minLength":1 }, "label":{ "type":"string", "description":"Label for the email address. Must be plain text (no URLs, HTML or markup).", "maxLength":25, "minLength":1 } }, "required":[ "address", "label" ], "title":"Email" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Height":{ "type":"string", "description":"Height of the card media.", "enum":[ "SHORT", "MEDIUM", "TALL" ], "example":"TALL", "title":"Height" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion":{ "type":"string", "description":"RBM agents can be hosted in one of three regions: North America, Europe, or Asia Pacific, to help businesses comply with regional and regulatory requirements. Select the region based on the country where you plan to launch the sender. Please note that the hosting region cannot be changed once the sender is created.", "enum":[ "NORTH_AMERICA", "EUROPE", "ASIA_PACIFIC" ], "title":"HostingRegion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.MessageOrder":{ "type":"string", "description":"Represent text to pdf order.", "enum":[ "TEXT_MESSAGE_AT_TOP", "PDF_AT_TOP" ], "title":"MessageOrder" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.OpenUrlApplicationType":{ "type":"string", "description":"Type of the URL open application.", "enum":[ "BROWSER", "WEBVIEW" ], "title":"OpenUrlApplicationType" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Orientation":{ "type":"string", "description":"Orientation type defines orientation in Card message.", "enum":[ "HORIZONTAL", "VERTICAL" ], "title":"Orientation" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo":{ "type":"object", "properties":{ "page":{ "type":"integer", "format":"int32", "description":"Requested page number.", "minimum":0 }, "size":{ "type":"integer", "format":"int32", "description":"Requested page size.", "minimum":1 }, "totalPages":{ "type":"integer", "format":"int32", "description":"The total number of pages of the results matching the requested parameters.", "minimum":0 }, "totalResults":{ "type":"integer", "format":"int64", "description":"The total number of the results matching the requested parameters.", "minimum":0 } }, "required":[ "page", "size", "totalPages", "totalResults" ], "title":"PageInfo" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone":{ "type":"object", "description":"List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.", "properties":{ "phoneNumber":{ "type":"string", "description":"Phone number. Can be in E.164 format (e.g. +1234567890) or in local/national format (e.g. 1234567). Numbers starting with “+” are validated as E.164, with a known network prefix and a number length that follows country-specific rules. Numbers without “+” must contain only digits and be 3 to 20 characters long.", "pattern":"^\\+?[0-9 \\-().]{1,30}$" }, "label":{ "type":"string", "description":"Label for the phone number. Must be plain text (no URLs, HTML or markup).", "maxLength":25, "minLength":1 } }, "required":[ "label", "phoneNumber" ], "title":"Phone" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters":{ "type":"object", "description":"Platform parameters that would be associated with the sender. Please note that platform parameters must be created before they can be associated with the sender. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "properties":{ "applicationId":{ "type":"string", "description":"ID of the Application that would be associated with the sender.", "maxLength":255, "minLength":1 }, "entityId":{ "type":"string", "description":"ID of the Entity that would be associated with the sender.", "maxLength":255, "minLength":1 } }, "title":"PlatformParameters" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress":{ "type":"object", "description":"Privacy policy associated with the sender.", "properties":{ "url":{ "type":"string", "description":"A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "label":{ "type":"string", "description":"Label for the URI. Currently accepted but not in use by RCS providers.", "maxLength":25, "minLength":1 } }, "required":[ "url" ], "title":"PrivacyWebAddress" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderLaunchStatus":{ "type":"string", "description":"Launch status for this specific provider. Possible values:\n* `PENDING`: Status returned when the launch request has not yet been submitted to the provider.\n* `IN_PROGRESS`: Status returned when the launch process with the provider has started.\n* `COMPLETED`: Status returned when the launch process with the provider has successfully finished.\n* `REJECTED`: Status returned when the launch process with the provider has finished unsuccessfully.\n* `NOT_REQUESTED`: Status returned when the provider has been excluded from the launch process.\n", "enum":[ "PENDING", "IN_PROGRESS", "COMPLETED", "REJECTED", "NOT_REQUESTED" ], "title":"ProviderLaunchStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderSenderLaunchStatus":{ "type":"object", "description":"List of providers in the country and their launch status.", "properties":{ "name":{ "type":"string", "description":"Name of the provider." }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderLaunchStatus" }, "rejectionReason":{ "type":"string", "description":"Reason for rejection if the sender launch has been rejected by the provider." }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when the provider status was last updated." } }, "required":[ "name", "status", "updatedAt" ], "title":"ProviderSenderLaunchStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand":{ "type":"object", "description":"Brand for which sender is created.", "properties":{ "brandName":{ "type":"string", "description":"Name of the brand.", "maxLength":100, "minLength":1 } }, "required":[ "brandName" ], "title":"RcsBrand" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsCountryProvidersPageResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryProviders" } }, "paging":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo" } }, "required":[ "paging", "results" ], "title":"RcsCountryProvidersPageResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsProviderTemplateApiStatus":{ "type":"string", "description":"Template status for this specific provider. Possible values:\n* `PENDING`: Status indicating that the template has been submitted to the provider and is being under review.\n* `APPROVED`: Status indicating that the template has been approved by the provider.\n* `REJECTED`: Status indicating that the template has been rejected by the provider.\n* `SUSPENDED`: Status indicating that the template has been suspended by the provider.\n\nPlease note that the template must be approved by the provider before it can be used for messaging.", "enum":[ "PENDING", "APPROVED", "REJECTED", "SUSPENDED" ], "title":"RcsProviderTemplateApiStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsRegisterTemplateRequest":{ "type":"object", "properties":{ "providers":{ "type":"array", "description":"List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that only supported providers with which template has not been registered yet should be used.", "example":[ "INDIA_VI" ], "items":{ "type":"string", "description":"List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that only supported providers with which template has not been registered yet should be used.", "example":"[\"INDIA_VI\"]" }, "uniqueItems":true } }, "required":[ "providers" ], "title":"RcsRegisterTemplateRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSender":{ "type":"object", "properties":{ "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" }, "billingCategory":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory" }, "useCase":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase" }, "hostingRegion":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion" }, "brand":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand" }, "googleAgentId":{ "type":"string", "description":"Google Agent ID associated with this sender." }, "displayName":{ "type":"string", "description":"The name of the sender displayed to the user on mobile device." }, "description":{ "type":"string", "description":"The description of the sender displayed to the user on mobile device." }, "color":{ "type":"string", "description":"Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white." }, "phones":{ "type":"array", "description":"List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone" } }, "emails":{ "type":"array", "description":"List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email" } }, "websites":{ "type":"array", "description":"List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress" } }, "bannerUrl":{ "type":"string", "description":"URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.", "maxLength":2048 }, "logoUrl":{ "type":"string", "description":"URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.", "maxLength":2048 }, "privacy":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress" }, "termsOfService":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress" }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when sender has been updated last time." } }, "required":[ "bannerUrl", "billingCategory", "brand", "color", "description", "displayName", "hostingRegion", "logoUrl", "privacy", "senderName", "senderStatus", "termsOfService", "updatedAt", "useCase" ], "title":"RcsSender" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBaseData":{ "type":"object", "properties":{ "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" }, "billingCategory":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory" }, "useCase":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase" }, "hostingRegion":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion" }, "brand":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand" }, "googleAgentId":{ "type":"string", "description":"Google Agent ID associated with this sender." }, "displayName":{ "type":"string", "description":"The name of the sender displayed to the user on mobile device." }, "description":{ "type":"string", "description":"The description of the sender displayed to the user on mobile device." }, "color":{ "type":"string", "description":"Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white." }, "bannerUrl":{ "type":"string", "description":"URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.", "maxLength":2048 }, "logoUrl":{ "type":"string", "description":"URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.", "maxLength":2048 }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when sender has been updated last time." } }, "required":[ "bannerUrl", "billingCategory", "brand", "color", "description", "displayName", "hostingRegion", "logoUrl", "senderName", "senderStatus", "updatedAt", "useCase" ], "title":"RcsSenderBaseData" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory":{ "type":"string", "description":"Billing category for the sender. Following billing categories are available:\n* `NON_CONVERSATIONAL`: Messages billed as standard RCS message that allows richer messaging experience. Never billed as `CONVERSATIONAL`.\n* `CONVERSATIONAL`: Billed as session in which user and agent can exchange a series of messages.", "enum":[ "CONVERSATIONAL", "NON_CONVERSATIONAL" ], "title":"RcsSenderBillingCategory" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent":{ "type":"object", "description":"Launch status information for the sender including coverage details by country and provider.", "properties":{ "event":{ "type":"string", "description":"Event type identifier for webhook notifications. Indicates the type of status change that occurred." }, "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" }, "coverage":{ "type":"array", "description":"Coverage information by country showing launch status for each provider.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryCoverage" } }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when launch status has been updated last time." }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "coverage", "event", "senderName", "senderStatus", "updatedAt" ], "title":"RcsSenderLaunchStatusEvent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusWebhookResponse":{ "type":"object", "description":"Webhook response containing RCS sender launch status update events", "properties":{ "results":{ "type":"array", "description":"Collection of RCS sender launch status update events", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent" } } }, "required":[ "results" ], "title":"RcsSenderLaunchStatusWebhookResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderPageResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBaseData" } }, "paging":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo" } }, "required":[ "paging", "results" ], "title":"RcsSenderPageResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse":{ "type":"object", "properties":{ "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" } }, "required":[ "senderName", "senderStatus" ], "title":"RcsSenderRequestAcceptedResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus":{ "type":"string", "description":"Status of the sender. It'll be updated by Infobip platform automatically and notification about sender status update will be sent to client's webhook. Following statuses are available:\n* `DRAFT`: Status returned when the Sender is created in Draft state via the UI.\n* `PENDING`: Status returned while the creation or update of the Sender is being processed.\n* `READY_FOR_TESTING`: Status indicating that the Sender has been created, is unlocked for editing, and testing is allowed on any device. If the launch process finishes unsuccessfully (i.e., all Providers have REJECTED), the Sender reverts to this status.\n* `PENDING_LAUNCH`: Status indicating that a launch has been requested through the Account Manager, RR (future), or CUP UI (future). The Sender is locked and cannot be edited.\n* `SENDER_UPDATE_REQUIRED`: Status indicating that after PENDING_LAUNCH, an update to the Sender is required. The Sender is unlocked for editing.\n* `LAUNCHED_IN_PROGRESS`: Status indicating that at least one Provider has successfully COMPLETED the launch of the Sender. The Sender is locked and ready for sending traffic, but the launch process with all Providers is not yet complete.\n* `LAUNCHED_PARTIAL_SUCCESS`: Status indicating that all Providers have completed their launch process with mixed results — some Providers have COMPLETED successfully, and others have REJECTED. The Sender remains locked and can be used for sending traffic.\n* `LAUNCHED`: Status indicating that all selected Providers have successfully COMPLETED the launch of the Sender.", "enum":[ "DRAFT", "PENDING", "READY_FOR_TESTING", "PENDING_LAUNCH", "SENDER_UPDATE_REQUIRED", "LAUNCHED_IN_PROGRESS", "LAUNCHED_PARTIAL_SUCCESS", "LAUNCHED" ], "title":"RcsSenderStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateEvent":{ "type":"object", "description":"Collection of RCS sender update events", "properties":{ "event":{ "type":"string", "description":"Event type identifier for webhook notifications. Indicates the type of status change that occurred." }, "senderName":{ "type":"string", "description":"Unique identifier of Sender entity for RCS channel within Infobip platform." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" }, "googleAgentId":{ "type":"string", "description":"Google Agent ID associated with this sender. Only included during the first transition to READY_FOR_TESTING status." }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when sender has been updated last time." }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "event", "senderName", "senderStatus", "updatedAt" ], "title":"RcsSenderUpdateEvent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateWebhookResponse":{ "type":"object", "description":"Webhook response containing RCS sender update events", "properties":{ "results":{ "type":"array", "description":"Collection of RCS sender update events", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateEvent" } } }, "required":[ "results" ], "title":"RcsSenderUpdateWebhookResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Template name." }, "type":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType" }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus" }, "content":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"Date and time when the template was updated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." } }, "required":[ "content", "lastUpdate", "name", "status", "type" ], "title":"RcsTemplate" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiCountryCoverage":{ "type":"object", "description":"Coverage information by country showing template status for each provider.", "properties":{ "countryCode":{ "type":"string", "description":"Country code where the template is being registered." }, "providers":{ "type":"array", "description":"List of template providers in the country and their template registration status.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProviderStatusDetails" } } }, "required":[ "countryCode", "providers" ], "title":"RcsTemplateApiCountryCoverage" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiDetailedStatusResponse":{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus" }, "name":{ "type":"string", "description":"The unique name of the template." }, "coverage":{ "type":"array", "description":"Coverage information by country showing template status for each provider.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiCountryCoverage" } } }, "required":[ "coverage", "name", "status" ], "title":"RcsTemplateApiDetailedStatusResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus":{ "type":"string", "description":"The status of a specified RCS template. Possible values:\n* `PENDING`: Status indicating that the template has still not been approved by any provider and that there is at least one more provider reviewing the template.\n* `APPROVED`: Status indicating that the template has been approved by all required providers.\n* `REJECTED`: Status indicating that the template has been rejected by all required providers.\n* `SUSPENDED`: Status indicating that the template has been suspended by all required providers.\n* `APPROVED_IN_PROGRESS`: Status indicating that the template has been approved by at least one provider and that there is at least one more provider reviewing the template.\n* `APPROVED_PARTIALLY`: Status indicating that the template has been approved by at least one provider and that there is no more providers reviewing the template.\n\nPlease note that the template must be approved by the provider before it can be used for messaging. For detailed status per provider please check [Get RCS template status](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-get-status) endpoint.", "enum":[ "PENDING", "APPROVED", "REJECTED", "SUSPENDED", "APPROVED_IN_PROGRESS", "APPROVED_PARTIALLY" ], "title":"RcsTemplateApiStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCardContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, { "type":"object", "properties":{ "orientation":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Orientation" }, "alignment":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Alignment" }, "content":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateInnerCardContent" } } } ], "required":[ "alignment", "content", "orientation", "type" ], "title":"RcsTemplateCardContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCarouselContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, { "type":"object", "properties":{ "cardWidth":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Width" }, "contents":{ "type":"array", "description":"An array of cards contained within the carousel.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateInnerCardContent" }, "maxItems":10, "minItems":2 } } } ], "required":[ "cardWidth", "contents", "type" ], "title":"RcsTemplateCarouselContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent":{ "type":"object", "description":"Template content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextContent", "CARD":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCardContent", "CAROUSEL":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCarouselContent", "TEXT_WITH_PDF":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextWithPdfContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType" } }, "required":[ "type" ], "title":"RcsTemplateContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType":{ "type":"string", "description":"Template content type.", "enum":[ "TEXT", "CARD", "CAROUSEL", "TEXT_WITH_PDF" ], "title":"RcsTemplateContentType" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCreateCalendarEventSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 }, "startTime":{ "type":"object", "description":"The date and time when the event starts.
It must be in the future and before `endTime`. The required format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ` (for example, `2030-03-03T15:00:00.000+01:00`) or a {{placeholder}}.
The displayed `startTime` may be affected by the device's default time zone.
For best practices on date formats, refer to our [documentation](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats-backward-compatibility).", "oneOf":[ { "type":"string", "description":"Event start time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", "example":"2026-01-01T10:00:00.000+01:00", "title":"DateTime" }, { "type":"string", "description":"Event start time as {{placeholder}}.", "example":"{{startTime}}", "title":"Placeholder" } ] }, "endTime":{ "type":"object", "description":"The date and time when the event ends.
It must be in the future and after `startTime`. The required format is `yyyy-MM-dd'T'HH:mm:ss.SSSZ` (for example, `2030-03-03T17:00:00.000+01:00`), or a {{placeholder}}
The displayed `endTime` may be affected by the device's default time zone.
For best practices on date formats, refer to our [documentation](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats-backward-compatibility).", "oneOf":[ { "type":"string", "description":"Event end time in yyyy-MM-dd'T'HH:mm:ss.SSSZ format.", "example":"2026-01-01T11:00:00.000+01:00", "title":"DateTime" }, { "type":"string", "description":"Event end time as {{placeholder}}.", "example":"{{endTime}}", "title":"Placeholder" } ] }, "title":{ "type":"string", "maxLength":100, "minLength":1 }, "description":{ "type":"string", "maxLength":500, "minLength":1 } } } ], "description":"Opens the user's default calendar app and starts the new calendar event flow with the agent-specified event data pre-filled.", "required":[ "endTime", "postbackData", "startTime", "text", "title", "type" ], "title":"RcsTemplateCreateCalendarEventSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateDialPhoneSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 }, "phoneNumber":{ "type":"string", "description":"Valid phone number.", "example":"385977666618", "pattern":"^\\+?[0-9]\\d{1,14}$" } } } ], "description":"Opens the user's default dialer app with the agent-specified phone number filled in.", "required":[ "phoneNumber", "postbackData", "text", "type" ], "title":"RcsTemplateDialPhoneSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateInnerCardContent":{ "type":"object", "description":"An array of cards contained within the carousel.", "properties":{ "title":{ "type":"string", "description":"Title of the card, displayed as bolded text.", "maxLength":200, "minLength":1 }, "description":{ "type":"string", "description":"Description of the card, displayed as regular text.", "maxLength":2000, "minLength":1 }, "media":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CardMedia" }, "suggestions":{ "type":"array", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, "maxItems":4, "minItems":0 } }, "title":"RcsTemplateInnerCardContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateListItem":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Template name." }, "type":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType" }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus" }, "lastUpdate":{ "type":"string", "format":"date-time", "description":"Date and time when the template was updated. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." } }, "required":[ "lastUpdate", "name", "status", "type" ], "title":"RcsTemplateListItem" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateOpenUrlSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 }, "url":{ "type":"string", "description":"URL that will be opened on a mobile phone when the suggestion is selected. Must be a valid URI using the http or https scheme as defined in RFC 3986.", "example":"https://www.infobip.com", "maxLength":2048, "minLength":1 }, "application":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.OpenUrlApplicationType" }, "webviewViewMode":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebviewViewModeType" } } } ], "description":"Opens the user's default web browser app to the specified URL.", "required":[ "postbackData", "text", "type", "url" ], "title":"RcsTemplateOpenUrlSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProviderStatusDetails":{ "type":"object", "description":"List of template providers in the country and their template registration status.", "properties":{ "providerName":{ "type":"string", "description":"Name of the provider." }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsProviderTemplateApiStatus" }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when the status for this specific provider was last time updated." } }, "required":[ "providerName", "status" ], "title":"RcsTemplateProviderStatusDetails" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProvidersResponse":{ "type":"object", "properties":{ "providers":{ "type":"array", "description":"List of available template providers.", "items":{ "type":"string", "description":"List of available template providers." }, "uniqueItems":true } }, "required":[ "providers" ], "title":"RcsTemplateProvidersResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateReplySuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 } } } ], "description":"When tapped, sends the text reply back to the agent.", "required":[ "postbackData", "text", "type" ], "title":"RcsTemplateReplySuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateRequestLocationSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 } } } ], "description":"Opens the RCS app's location chooser so the user can pick a location to send back to the agent.", "required":[ "postbackData", "text", "type" ], "title":"RcsTemplateRequestLocationSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateShowLocationSuggestion":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":25, "minLength":1 }, "postbackData":{ "type":"string", "maxLength":2048, "minLength":1 }, "latitude":{ "type":"object", "description":"Latitude of the location or {{placeholder}}.", "oneOf":[ { "type":"number", "format":"double", "description":"Latitude coordinate of the location.", "example":45.793418, "maximum":90, "minimum":-90, "title":"Latitude number" }, { "type":"string", "description":"Latitude as {{placeholder}}.", "example":"{{latitude}}", "title":"Latitude placeholder" } ] }, "longitude":{ "type":"object", "description":"Longitude of the location or {{placeholder}}.", "oneOf":[ { "type":"number", "format":"double", "description":"Longitude coordinate of the location.", "example":15.946297, "maximum":180, "minimum":-180, "title":"Longitude number" }, { "type":"string", "description":"Longitude as {{placeholder}}.", "example":"{{longitude}}", "title":"Longitude placeholder" } ] }, "label":{ "type":"string", "description":"Label of the location.", "maxLength":100, "minLength":1 } } } ], "description":"Opens the user's default map app and selects the agent-specified location.", "required":[ "latitude", "longitude", "postbackData", "text", "type" ], "title":"RcsTemplateShowLocationSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "REPLY":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateReplySuggestion", "DIAL_PHONE":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateDialPhoneSuggestion", "OPEN_URL":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateOpenUrlSuggestion", "REQUEST_LOCATION":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateRequestLocationSuggestion", "SHOW_LOCATION":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateShowLocationSuggestion", "CREATE_CALENDAR_EVENT":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCreateCalendarEventSuggestion" } }, "properties":{ "type":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestionType" } }, "required":[ "type" ], "title":"RcsTemplateSuggestion" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestionType":{ "type":"string", "enum":[ "REPLY", "DIAL_PHONE", "OPEN_URL", "REQUEST_LOCATION", "SHOW_LOCATION", "CREATE_CALENDAR_EVENT" ], "title":"RcsTemplateSuggestionType" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":2500, "minLength":0 }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, "maxItems":11, "minItems":0 } } } ], "required":[ "text", "type" ], "title":"RcsTemplateTextContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextWithPdfContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":1000, "minLength":0 }, "url":{ "type":"string", "description":"URL of the given document. The following content types are supported: `application/pdf`. Should start with `http://` or `https://`. Up to 100 MB.", "example":"https://infobip.com/document.pdf", "maxLength":1000, "minLength":1 }, "messageOrder":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.MessageOrder" }, "suggestions":{ "type":"array", "description":"List of suggestions.", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateSuggestion" }, "maxItems":11, "minItems":0 } } } ], "required":[ "messageOrder", "text", "type", "url" ], "title":"RcsTemplateTextWithPdfContent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus":{ "type":"string", "description":"Status of the test number. It'll be updated by Infobip platform automatically and notification about test number status update will be sent to client's webhook. Following statuses are available:\n* `PENDING`: Test device registration is pending until 3rd party action will be executed.\n* `WAITING_FOR_TESTER_ACCEPTANCE`: Waiting for user to accept request to become a tester.\n* `APPROVED`: User has accepted to become a tester and test messages can be sent to that number.\n* `EXPIRED`: If user does not accept invitation within 24h, status of test number will be moved to EXPIRED.\n* `UNSUPPORTED`: Test number is not supported for RCS traffic.\n* `FAILED`: Failed mostly because of some internal service error during request processing. Please contact support.", "enum":[ "PENDING", "WAITING_FOR_TESTER_ACCEPTANCE", "APPROVED", "EXPIRED", "UNSUPPORTED", "FAILED" ], "title":"RcsTestDeviceStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber":{ "type":"object", "properties":{ "testNumber":{ "type":"string", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus" }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when test number has been updated last time." }, "primary":{ "type":"boolean", "description":"Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association." } }, "required":[ "primary", "status", "testNumber", "updatedAt" ], "title":"RcsTestNumber" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberPageResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber" } }, "paging":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo" } }, "required":[ "paging", "results" ], "title":"RcsTestNumberPageResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse":{ "type":"object", "properties":{ "senderName":{ "type":"string", "description":"Unique identifier of a sender for which test number is associated." }, "testNumber":{ "type":"string", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." }, "status":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus" } }, "required":[ "senderName", "status", "testNumber" ], "title":"RcsTestNumberRequestAcceptedResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateEvent":{ "type":"object", "description":"Collection of RCS test number update events", "properties":{ "event":{ "type":"string", "description":"Event type identifier for webhook notifications. Indicates the type of status change that occurred." }, "senderName":{ "type":"string", "description":"Unique identifier of a sender for which test number is associated." }, "testNumber":{ "type":"string", "description":"Full number in E.164 format, e.g. +1234567890. Leading '+' is optional." }, "senderStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus" }, "testNumberStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus" }, "updatedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when test number has been updated last time." }, "completedAt":{ "type":"string", "format":"date-time", "description":"Timestamp when request has been completed. It will be null if request is still in progress." }, "platform":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters" } }, "required":[ "event", "senderName", "senderStatus", "testNumber", "testNumberStatus", "updatedAt" ], "title":"RcsTestNumberUpdateEvent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateWebhookResponse":{ "type":"object", "description":"Webhook response containing RCS test number update events", "properties":{ "results":{ "type":"array", "description":"Collection of RCS test number update events", "items":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateEvent" } } }, "required":[ "results" ], "title":"RcsTestNumberUpdateWebhookResponse" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase":{ "type":"string", "description":"Use case for the sender. Following use cases are available:\n* `OTP`: Used for senders that only send one time passwords.\n* `TRANSACTIONAL`: Used for senders that send only essential, necessary and time-sensitive messages.\n* `PROMOTIONAL`: Used for senders that send promotional messages.\n* `MULTI_USE`: Used for senders that have multiple use cases.", "enum":[ "OTP", "TRANSACTIONAL", "PROMOTIONAL", "MULTI_USE" ], "title":"RcsUseCase" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Resource":{ "type":"object", "description":"Resource object describing the thumbnail of the card, applicable to video files only.", "properties":{ "url":{ "type":"string", "description":"URL of the given resource.", "maxLength":2048, "minLength":1 } }, "required":[ "url" ], "title":"Resource" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateStatus":{ "type":"string", "description":"Updated status of the template.", "enum":[ "PENDING", "APPROVED", "REJECTED" ], "example":"APPROVED", "title":"TemplateStatus" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateUpdateEvent":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the template being updated.", "example":"demo_template" }, "templateStatus":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateStatus" }, "comment":{ "type":"string", "description":"Additional comment or notes about the update.", "example":"Approved for testing" }, "updatedAt":{ "type":"string", "description":"Template's last update date and time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.", "example":"2025-02-06T15:35:12.123+0000" } }, "required":[ "comment", "name", "templateStatus", "updatedAt" ], "title":"TemplateUpdateEvent" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress":{ "type":"object", "description":"Terms and conditions associated with the sender.", "properties":{ "url":{ "type":"string", "description":"A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "label":{ "type":"string", "description":"Label for the URI. Currently accepted but not in use by RCS providers.", "maxLength":25, "minLength":1 } }, "required":[ "url" ], "title":"TermsWebAddress" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.UpdateRcsTestNumberPrimaryApiRequest":{ "type":"object", "properties":{ "primary":{ "type":"boolean", "default":false, "description":"Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association." } }, "required":[ "primary" ], "title":"UpdateRcsTestNumberPrimaryApiRequest" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress":{ "type":"object", "description":"List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.", "properties":{ "url":{ "type":"string", "description":"A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.", "maxLength":2048, "minLength":1 }, "label":{ "type":"string", "description":"Label for the URI. Must be plain text (no URLs, HTML or markup).", "maxLength":25, "minLength":1 } }, "required":[ "label", "url" ], "title":"WebsiteWebAddress" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebviewViewModeType":{ "type":"string", "description":"Type of the webview's view mode.", "enum":[ "FULL", "HALF", "TALL" ], "title":"WebviewViewModeType" }, "c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Width":{ "type":"string", "description":"Width of cards contained within the carousel.", "enum":[ "SMALL", "MEDIUM" ], "example":"MEDIUM", "title":"Width" } }, "responses":{ "ApiError400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n" } } }, "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" } } }, "ApiError404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E404", "description":"Not found - request URL doesn't exist on the API server or resource is not found.", "action":"Check the resources and adjust your request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\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" } } }, "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-rcs-messages":{ "post":{ "tags":[ "channels", "rcs", "rcs-inbound-messages" ], "summary":"Receive RCS inbound message", "description":"Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-incoming-rcs", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessages" }, "examples":{ "TEXT message response":{ "summary":"TEXT message response", "value":{ "results":[ { "campaignReferenceId":"CAMP-2026-Q1", "sender":"385911234567", "to":"DemoSender", "integrationType":"RCS", "receivedAt":"2026-03-03T14:22:30.000+0000", "interactionType":"BASIC_MESSAGE", "rcsCount":1, "keyword":"START", "messageId":"msg-abc123", "pairedMessageId":"msg-xyz456", "callbackData":"custom-user-data", "message":{ "text":"Hello, world!", "type":"TEXT" }, "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "currency":"EUR" }, "conversation":{ "canInitiate":true, "id":null }, "platform":{ "applicationId":"ext-app-001", "entityId":"ext-entity-001" } } ], "messageCount":1, "pendingMessageCount":0 } }, "FILE message response":{ "summary":"FILE message response", "value":{ "results":[ { "campaignReferenceId":"CAMP-2026-Q1", "sender":"385911234567", "to":"DemoSender", "integrationType":"RCS", "receivedAt":"2026-03-03T14:22:30.000+0000", "interactionType":"SINGLE_MESSAGE", "rcsCount":1, "keyword":"START", "messageId":"msg-abc123", "pairedMessageId":"msg-xyz456", "callbackData":"custom-user-data", "message":{ "url":"https://example.com/file.pdf", "name":"file.pdf", "contentType":"pdf", "size":123456, "type":"FILE" }, "price":{ "trafficType":"SINGLE", "pricePerMessage":0.005, "currency":"EUR" }, "conversation":{ "canInitiate":false, "id":"conv-xyz789" }, "platform":{ "applicationId":"ext-app-001", "entityId":"ext-entity-001" } } ], "messageCount":1, "pendingMessageCount":0 } }, "SUGGESTION message response":{ "summary":"SUGGESTION message response", "value":{ "results":[ { "campaignReferenceId":"CAMP-2026-Q1", "sender":"385911234567", "to":"DemoSender", "integrationType":"RCS", "receivedAt":"2026-03-03T14:22:30.000+0000", "interactionType":"BASIC_MESSAGE", "rcsCount":1, "keyword":"START", "messageId":"msg-abc123", "pairedMessageId":"msg-xyz456", "callbackData":"custom-user-data", "message":{ "text":"suggestionText", "postbackData":"suggestionPostbackData", "type":"SUGGESTION" }, "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "currency":"EUR" }, "conversation":{ "canInitiate":false, "id":"conv-xyz789" }, "platform":{ "applicationId":"ext-app-001", "entityId":"ext-entity-001" } } ], "messageCount":1, "pendingMessageCount":0 } }, "LOCATION message response":{ "summary":"LOCATION message response", "value":{ "results":[ { "campaignReferenceId":"CAMP-2026-Q1", "sender":"385911234567", "to":"DemoSender", "integrationType":"RCS", "receivedAt":"2026-03-03T14:22:30.000+0000", "interactionType":"BASIC_MESSAGE", "rcsCount":1, "keyword":"START", "messageId":"msg-abc123", "pairedMessageId":"msg-xyz456", "callbackData":"custom-user-data", "message":{ "latitude":37.7749, "longitude":-122.4194, "type":"LOCATION" }, "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "currency":"EUR" }, "conversation":{ "canInitiate":false, "id":"conv-xyz789" }, "platform":{ "applicationId":"ext-app-001", "entityId":"ext-entity-001" } } ], "messageCount":1, "pendingMessageCount":0 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "inbound-events-receive-inbound-rcs-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-inbound-events" ], "summary":"Receive RCS user action event", "description":"Set up logic for processing incoming events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"inbound-events-receive-inbound-rcs-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvents" }, "examples":{ "SUGGESTION event response":{ "summary":"SUGGESTION event response", "value":{ "results":[ { "campaignReferenceId":"CAMP-2026-Q1", "sender":"385911234567", "to":"DemoSender", "integrationType":"RCS", "receivedAt":"2026-03-03T14:22:30.000+0000", "interactionType":"EVENT", "keyword":"START", "messageId":"msg-abc123", "pairedMessageId":"msg-xyz456", "callbackData":"custom-user-data", "message":{ "text":"suggestionText", "postbackData":"suggestionPostbackData", "type":"SUGGESTION" }, "price":{ "trafficType":null, "pricePerMessage":0, "currency":"EUR" }, "conversation":{ "canInitiate":false, "id":"conv-xyz789" }, "platform":{ "applicationId":"ext-app-001", "entityId":"ext-entity-001" } } ], "messageCount":1, "pendingMessageCount":0 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-typing-indicator-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-inbound-events" ], "summary":"Receive RCS typing indicator event", "description":"Set up logic for processing incoming typing indicator events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-typing-indicator-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvents" }, "examples":{ "TYPING_INDICATOR event response":{ "summary":"TYPING_INDICATOR event response", "value":{ "results":[ { "sender":"385911234567", "to":"DemoSender", "receivedAt":"2026-03-03T14:22:30Z", "event":{ "type":"TYPING_INDICATOR" }, "entityId":"ext-entity-001", "applicationId":"ext-app-001" } ], "eventCount":1, "pendingEventCount":0 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-outbound-rcs-message-delivery-reports":{ "post":{ "tags":[ "channels", "rcs", "rcs-logs-and-status-reports" ], "summary":"Receive RCS delivery reports", "description":"For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-outbound-rcs-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports" }, "examples":{ "RCS message delivered":{ "summary":"RCS message delivered", "value":{ "results":[ { "bulkId":"BULK-123456", "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "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 }, "conversation":{ "canInitiate":true, "id":null }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS message failed":{ "summary":"RCS message failed", "value":{ "results":[ { "bulkId":"BULK-123456", "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "currency":"EUR" }, "status":{ "groupId":2, "groupName":"UNDELIVERABLE", "id":4, "name":"UNDELIVERABLE_REJECTED_OPERATOR", "description":"Message rejected by operator" }, "error":{ "groupId":1, "groupName":"HANDSET_ERRORS", "id":7002, "name":"EC_UNKNOWN_USER", "description":"No matching user found (on platform or on provider)", "permanent":true }, "conversation":{ "canInitiate":false, "id":null }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS with failover RCS message delivered":{ "summary":"RCS with failover RCS message delivered", "value":{ "results":[ { "bulkId":"BULK-123456", "channel":"RCS", "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "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 }, "conversation":{ "canInitiate":false, "id":"conv-xyz789" }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS with failover RCS message failed":{ "summary":"RCS with failover RCS message failed", "value":{ "results":[ { "bulkId":"BULK-123456", "channel":"RCS", "price":{ "trafficType":"BASIC", "pricePerMessage":0.005, "currency":"EUR" }, "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "error":{ "groupId":1, "groupName":"HANDSET_ERRORS", "id":7002, "name":"EC_UNKNOWN_USER", "description":"No matching user found (on platform or on provider)", "permanent":true }, "conversation":{ "canInitiate":false, "id":null }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "interactionType":"BASIC_MESSAGE", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"sender", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS with failover SMS message delivered":{ "summary":"RCS with failover SMS message delivered", "value":{ "results":[ { "bulkId":"BULK-123456", "channel":"SMS", "price":{ "pricePerMessage":0.005, "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":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"InfoSMS", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } }, "RCS with failover SMS message failed":{ "summary":"RCS with failover SMS message failed", "value":{ "results":[ { "bulkId":"BULK-123456", "channel":"SMS", "price":{ "pricePerMessage":0.005, "currency":"EUR" }, "status":{ "groupId":2, "groupName":"UNDELIVERABLE", "id":4, "name":"UNDELIVERABLE_REJECTED_OPERATOR", "description":"Message rejected by operator" }, "error":{ "groupId":1, "groupName":"HANDSET_ERRORS", "id":9, "name":"EC_ILLEGAL_SUBSCRIBER", "description":"Illegal Subscriber", "permanent":true }, "messageId":"msg-abc123", "doneAt":"2026-03-03T14:22:35.000+0100", "messageCount":1, "sentAt":"2026-03-03T14:22:30.000+0100", "mccMnc":"21910", "callbackData":"custom-user-data", "to":"385911234567", "sender":"InfoSMS", "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" }, "campaignReferenceId":"CAMP-2026-Q1" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports" }, "examples":{ "RCS message delivered":{ "summary":"RCS message delivered", "value":"\n \n \n BULK-123456\n \n BASIC\n 0.005\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 true\n \n \n msg-abc123\n 2026-03-03T14:22:35.000+0100\n BASIC_MESSAGE\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n sender\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" }, "RCS message failed":{ "summary":"RCS message failed", "value":"\n \n \n BULK-123456\n \n BASIC\n 0.005\n EUR\n \n \n 2\n UNDELIVERABLE\n 4\n UNDELIVERABLE_REJECTED_OPERATOR\n Message rejected by operator\n \n \n 1\n HANDSET_ERRORS\n 7002\n EC_UNKNOWN_USER\n No matching user found (on platform or on provider)\n true\n \n \n false\n \n \n msg-abc123\n 2026-03-03T14:22:35.000+0100\n BASIC_MESSAGE\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n sender\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" }, "RCS with failover RCS message delivered":{ "summary":"RCS with failover RCS message delivered", "value":"\n \n \n BULK-123456\n RCS\n \n BASIC\n 0.005\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 false\n conv-xyz789\n \n msg-abc123\n 2026-03-03T14:22:35.000+0100\n BASIC_MESSAGE\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n sender\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" }, "RCS with failover RCS message failed":{ "summary":"RCS with failover RCS message failed", "value":"\n \n \n BULK-123456\n RCS\n \n BASIC\n 0.005\n EUR\n \n \n 1\n PENDING\n 7\n PENDING_ENROUTE\n Message sent to next instance\n \n \n 1\n HANDSET_ERRORS\n 7002\n EC_UNKNOWN_USER\n No matching user found (on platform or on provider)\n true\n \n \n false\n \n \n msg-abc123\n 2026-03-03T14:22:35.000+0100\n BASIC_MESSAGE\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n sender\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" }, "RCS with failover SMS message delivered":{ "summary":"RCS with failover SMS message delivered", "value":"\n \n \n BULK-123456\n SMS\n \n 0.005\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 msg-abc123\n 2026-03-03T14:22:35.000+0100\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n InfoSMS\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" }, "RCS with failover SMS message failed":{ "summary":"RCS with failover SMS message failed", "value":"\n \n \n BULK-123456\n SMS\n \n 0.005\n EUR\n \n \n 2\n UNDELIVERABLE\n 4\n UNDELIVERABLE_REJECTED_OPERATOR\n Message rejected by operator\n \n \n 1\n HANDSET_ERRORS\n 9\n EC_ILLEGAL_SUBSCRIBER\n Illegal Subscriber\n true\n \n msg-abc123\n 2026-03-03T14:22:35.000+0100\n 1\n 2026-03-03T14:22:30.000+0100\n 21910\n custom-user-data\n 385911234567\n InfoSMS\n \n ext-entity-001\n ext-app-001\n \n CAMP-2026-Q1\n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-seen-reports":{ "post":{ "tags":[ "channels", "rcs", "rcs-logs-and-status-reports" ], "summary":"Receive seen reports", "description":"For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.", "operationId":"receive-seen-reports-rcs", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReports" } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-conversation-started-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-logs-and-status-reports" ], "summary":"Receive RCS conversation started event", "description":"Webhook notifying that a message's billing model changed from non-conversational to conversational.", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-conversation-started-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvents" }, "examples":{ "CONVERSATION_STARTED event response":{ "summary":"CONVERSATION_STARTED event response", "value":{ "results":[ { "messageId":"msg-abc123", "trafficType":"A2P_CONVERSATION", "event":{ "type":"CONVERSATION_STARTED" }, "conversation":{ "type":"A2P", "id":"conv-xyz789", "startTime":"2026-06-14T09:12:00.000+0000", "endTime":"2026-06-15T09:12:00.000+0000" }, "platform":{ "entityId":"ext-entity-001", "applicationId":"ext-app-001" } } ], "eventCount":1, "pendingEventCount":0 } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-capability-check-result":{ "post":{ "tags":[ "channels", "rcs", "rcs-capability-check" ], "summary":"Receive Capability Check result", "description":"Receive the results requested by [Check RCS capability (async)](#channels/rcs/capability-check-rcs-destinations-notify). This callback will be invoked once per each phone number with POST method. ", "externalDocs":{ "description":"Learn more about RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-capability-check-result", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult" }, "examples":{ "Capability Check Result":{ "summary":"Capability Check Result", "value":{ "capabilityCheckResult":{ "bulkId":"d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8", "messageId":"b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3", "phoneNumber":"441134960001", "code":"ENABLED" }, "options":{ "platform":{ "entityId":"Example entity id", "applicationId":"Example application id" } } } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult" }, "examples":{ "Capability Check Result":{ "summary":"Capability Check Result", "value":"\n \n d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8\n b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3\n 441134960001\n ENABLED\n \n \n \n Example entity id\n Example application id\n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-sender-update-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Receive an RCS sender update event", "description":"Any time you request some operation to be executed for RCS sender, that operation will be\n executed asynchronously. After operation is executed, an event is sent. Also, some operations for RCS sender\n can be executed by Infobip team (e.g. launching a sender) and for these operations, an event will be sent too.\n If you would like to receive these events, you need to subscribe to this event over 'RCS' channel, and specify the\n 'SENDER_UPDATE' event. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n for additional info.", "externalDocs":{ "description":"Learn more about the RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-sender-update-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateWebhookResponse" }, "examples":{ "RCS Sender update event":{ "summary":"RCS Sender update event", "value":{ "results":[ { "event":"RCS_SENDER_STATUS_UPDATE", "senderName":"DemoSender", "senderStatus":"READY_FOR_TESTING", "googleAgentId":"demosender_axdawe0_agent", "updatedAt":"2025-02-15T16:38:24.000+0000", "platform":{ "applicationId":"application-id", "entityId":"entity-id" } } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-sender-launch-update-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-sender-management" ], "summary":"Receive an RCS sender launch update event", "description":"When a launch request is submitted for a given RCS sender, the launch status is updated\n individually for each provider within the selected country. This webhook delivers real-time updates\n whenever the launch status changes for any provider in any country. To receive these events, you must\n subscribe to the RCS channel and specify the SENDER_LAUNCH_UPDATE event. For more details on managing\n subscriptions, please refer to the [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n documentation.", "externalDocs":{ "description":"Learn more about the RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-sender-launch-update-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusWebhookResponse" }, "examples":{ "RCS provider Launched":{ "summary":"RCS provider Launched", "value":{ "results":[ { "event":"RCS_SENDER_LAUNCH_STATUS_UPDATE", "senderName":"DemoSender", "senderStatus":"PENDING_LAUNCH", "coverage":[ { "countryCode":"US", "providers":[ { "name":"ATT", "status":"COMPLETED", "updatedAt":"2026-01-15T16:38:24.000+0000" } ] } ], "updatedAt":"2026-01-15T16:38:24.000+0000", "platform":{ "applicationId":"application-id", "entityId":"entity-id" } } ] } }, "RCS provider Rejected":{ "summary":"RCS provider Rejected", "value":{ "results":[ { "event":"RCS_SENDER_LAUNCH_STATUS_UPDATE", "senderName":"DemoSender", "senderStatus":"PENDING_LAUNCH", "coverage":[ { "countryCode":"US", "providers":[ { "name":"ATT", "status":"REJECTED", "rejectionReason":"Request rejected due to missing information: Privacy policy needs opt-out (\"Text STOP to opt out\"), \"Message and data rates may apply\" disclaimer, and frequency disclosure. Terms must include \"Information will not be sold, rented, or shared\" statement.", "updatedAt":"2026-01-15T16:38:24.000+0000" } ] } ], "updatedAt":"2026-01-15T16:38:24.000+0000", "platform":{ "applicationId":"application-id", "entityId":"entity-id" } } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-test-number-update-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-test-number-management" ], "summary":"Receive an RCS test number update event", "description":"Any time you request some operation to be executed for RCS test number, that operation will be\n executed asynchronously. After operation is executed, an event is sent. Also, status of test number could be\n changed as a result of end user action (e.g. user has accepted an invitation to become a tester) and in these\n situations, an event will be sent too. If you would like to receive these events, you need to subscribe to this\n event over 'RCS' channel, and specify the 'TEST_NUMBER_UPDATE' event.\n Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.", "externalDocs":{ "description":"Learn more about the RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-test-number-update-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateWebhookResponse" }, "examples":{ "RCS test number update event":{ "summary":"RCS test number update event", "value":{ "results":[ { "event":"RCS_TEST_NUMBER_STATUS_UPDATE", "senderName":"DemoSender", "testNumber":"+441134960002", "senderStatus":"LAUNCHED", "testNumberStatus":"APPROVED", "updatedAt":"2025-02-23T15:11:39.000+0000", "completedAt":"2025-02-23T15:11:39.000+0000", "platform":{ "applicationId":"application-id", "entityId":"entity-id" } } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-rcs-message-template-update-events":{ "post":{ "tags":[ "channels", "rcs", "rcs-service-management", "rcs-template-management" ], "summary":"Receive an RCS template update", "description":"For each message template you create, we can send you updates.\n For this to work you need to configure subscriptions.\n Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n for additional info. Available only for senders that support templates.", "externalDocs":{ "description":"Learn more about the RCS channel and use cases", "url":"https://www.infobip.com/docs/rcs" }, "operationId":"receive-rcs-message-template-update-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateUpdateEvent" } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } } } }