{ "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:53.407286649Z" }, "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":"kakao", "description":"Kakao Talk holds immense value in the Korean market due to its widespread adoption, versatile features, and seamless integration into various aspects of daily life. In South Korea, Kakao Talk has become an integral part of communication. One of its key strengths lies in its dominant market position and extensive user base, encompassing millions of active users. This broad user base has fostered a network effect, making Kakao Talk the primary choice for individuals, businesses, and organizations alike. This expansive user reach offers a unique opportunity for businesses to effectively engage with their target audience, enabling direct and personalized communication. Kakao Talk provides a range of business solutions, allowing companies to harness the platform for various purposes such as sending informative messages using pre-approved templates (Alim), customer service (Sangdam), marketing, and engagement (Chingu). Businesses can engage with customers in real time, sharing updates and offering support, thus enhancing customer satisfaction and fostering loyalty.", "x-type":"product", "x-displayName":"Kakao Talk" }, { "name":"alim", "description":"Kakao Alim, also referred to as Kakao Alimtalk, is a business messaging solution that empowers businesses to send transactional or notification messages using pre-approved templates to their customers via KakaoTalk. These messages encompass various notifications like order confirmations, delivery updates, appointment reminders, and other essential transactional or informational alerts. Kakao Alim provides businesses with an efficient channel to engage with their customers directly, offering a seamless and convenient mode of communication. Widely adopted across diverse industries such as e-commerce, healthcare, finance, and more, Kakao Alim facilitates the timely delivery of relevant messages to users. By leveraging Kakao Alim, businesses can elevate their customer service, streamline operations, and ensure customers are well-informed about significant updates. This, in turn, leads to enhanced customer satisfaction and the establishment of robust relationships with their audience. ", "x-type":"module", "x-displayName":"Alim" }, { "name":"send-kakao-alim", "description":"", "x-type":"section", "x-displayName":"Outbound Message" }, { "name":"logs-and-status-reports-kakao-alim", "description":"", "x-type":"section", "x-displayName":"Logs and Status Reports" }, { "name":"sangdam", "description":"Kakao's Sangdam Talk messaging solution, also known as Consultation Talk, facilitates seamless communication between users on Kakao Talk and a company's designated consultation representatives. Users have the convenience of initiating direct conversations with a company's Kakao Talk channel using their mobile or PC devices. The designated consultation agents can then promptly respond to user inquiries and messages. This streamlined communication process empowers businesses to efficiently address user queries and concerns, contributing to enhanced customer engagement. It's important to emphasize that Sangdam Talk focuses on effective message management and timely responses, optimizing the overall consultation experience. ", "x-type":"module", "x-displayName":"Sangdam" }, { "name":"send-kakao-sangdam", "description":"", "x-type":"section", "x-displayName":"Outbound Message" }, { "name":"logs-and-status-reports-kakao-sangdam", "description":"", "x-type":"section", "x-displayName":"Logs and Status Reports" }, { "name":"incoming-kakao-sangdam-message", "description":"", "x-type":"section", "x-displayName":"Receive kakao sangdam message" }, { "name":"chingu", "description":"Kakao's Brand Message serves as a powerful promotional tool for businesses looking to enhance visibility and boost sales. By integrating seamlessly with KakaoTalk, businesses can harness the platform to deliver promotional content directly to customers' phones, engaging them like never before. With Friend Talk, businesses can easily inform customers about the latest deals or exclusive promo codes and coupons. It's an ideal solution for promoting new products or services, ensuring that your audience stays informed and interested. Whether it's sharing last-minute flight offers or unique promo codes for airline tickets, Friend Talk ensures that your message reaches your customers promptly and effectively. The potential use cases with KakaoTalk over API are expansive. Harness this flexibility to customize your communication strategy, tailoring messages to fit your business needs and enhancing customer relationships. With Brand Message, businesses not only drive engagement but also cultivate lasting customer loyalty by delivering timely, relevant information straight to your audience.", "x-type":"module", "x-displayName":"Brand Message" }, { "name":"send-kakao-chingu", "description":"", "x-type":"section", "x-displayName":"Outbound Message" }, { "name":"logs-and-status-reports-kakao-chingu", "description":"", "x-type":"section", "x-displayName":"Logs and Status Reports" }, { "name":"kakao-brand-template-management", "description":"", "x-type":"section", "x-displayName":"Template Management" } ], "paths":{ "/kakao-alim/1/messages":{ "post":{ "tags":[ "channels", "kakao", "alim", "send-kakao-alim" ], "summary":"Send a Kakao Alim message", "description":"Send one or more messages to multiple recipients.", "externalDocs":{ "description":"Learn more about Kakao Alim channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#alim-talk" }, "operationId":"send-kakao-alim-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimRequest" }, "examples":{ "Send a Kakao Alim message":{ "summary":"Send a Kakao Alim message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "templateCode":"123", "text":"Hello!", "type":"TEMPLATE" } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Kakao Alim message response":{ "summary":"Kakao Alim message response", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "destination":"66855538125" } ] } } } } } }, "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", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-alim/1/reports":{ "get":{ "tags":[ "channels", "kakao", "alim", "logs-and-status-reports-kakao-alim" ], "summary":"Get Kakao Alim 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 Kakao Alim channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#alim-talk" }, "operationId":"get-outbound-kakao-alim-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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"2034072219640523072", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "to":"66855538125", "sender":"44113496000", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-alim/1/logs":{ "get":{ "tags":[ "channels", "kakao", "alim", "logs-and-status-reports-kakao-alim" ], "summary":"Get outbound Kakao Alim 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-kakao-alim-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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogResponseLogKakaoAlimOutboundContent" }, "examples":{ "Log result":{ "summary":"Log result", "value":{ "results":[ { "sender":"44113496000", "destination":"66855538125", "bulkId":"2034072219640523072", "messageId":"105060206592105229", "sentAt":"2023-02-01T23:15:03.379+0000", "doneAt":"2023-02-01T23:16:34.582+0000", "messageCount":1, "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" }, "content":{ "templateCode":"123", "text":"Hello!", "type":"TEMPLATE" } } ] } } } } } }, "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":[ "kakao:logs:read", "kakao:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/kakao-sangdam/1/messages":{ "post":{ "tags":[ "channels", "kakao", "sangdam", "send-kakao-sangdam" ], "summary":"Send a Kakao Sangdam message", "description":"Send one or more messages to multiple recipients.", "externalDocs":{ "description":"Learn more about Kakao Sangdam channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk" }, "operationId":"send-kakao-sangdam-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamRequest" }, "examples":{ "Send a KAKAO SANGDAM message":{ "summary":"Send a KAKAO SANGDAM message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "text":"Hello!", "type":"TEXT" } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "KAKAO SANGDAM message response":{ "summary":"KAKAO SANGDAM message response", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"PENDING_ACCEPTED", "description":"Message sent to next instance" }, "destination":"66855538125" } ] } } } } } }, "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", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-sangdam/1/reports":{ "get":{ "tags":[ "channels", "kakao", "sangdam", "logs-and-status-reports-kakao-sangdam" ], "summary":"Get Kakao Sangdam 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 Kakao Sangdam channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk" }, "operationId":"get-outbound-kakao-sangdam-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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"1688025180464000013", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"1688025180464000014", "to":"66855538125", "sender":"OFFICIAL-ACCOUNT-ID-123", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-sangdam/1/logs":{ "get":{ "tags":[ "channels", "kakao", "sangdam", "logs-and-status-reports-kakao-sangdam" ], "summary":"Get outbound Kakao Sangdam 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-kakao-sangdam-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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogResponseLogKakaoSangdamOutboundContent" }, "examples":{ "Log result":{ "summary":"Log result", "value":{ "results":[ { "sender":"44113496000", "destination":"66855538125", "bulkId":"2034072219640523072", "messageId":"105060206592105229", "sentAt":"2023-02-01T23:15:03.379+0000", "doneAt":"2023-02-01T23:16:34.582+0000", "messageCount":1, "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" }, "content":{ "text":"Hello!", "type":"TEXT" } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "kakao:logs:read", "kakao:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/kakao-chingu/1/messages":{ "post":{ "tags":[ "channels", "kakao", "chingu", "send-kakao-chingu" ], "summary":"Send a brand message", "description":"Send one or more messages to multiple recipients.\nKakao Chingu will be deprecated on January 1, 2026, and Brand Messaging will replace it. Make sure to adjust your API connection to use only new content types that include _FREE_FORM or _VARIABLE in the content type name.", "externalDocs":{ "description":"Learn more about Kakao Chingu channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"send-kakao-chingu-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguRequest" }, "examples":{ "Send a free form text brand message":{ "summary":"Send a free form text brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "text":"Check out our latest offers!", "buttons":[ { "name":"Visit", "urlPc":"https://www.example.com", "urlMobile":"https://m.example.com", "target":"OUT", "type":"URL" }, { "name":"Open App", "schemeAndroid":"myapp://action", "schemeIos":"myapp://action", "urlMobile":"https://m.example.com", "urlPc":"https://www.example.com", "type":"APP_LINK" } ], "type":"TEXT_FREE_FORM" } } ] } }, "Send a free form image brand message":{ "summary":"Send a free form image brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "text":"Check out our new product!", "image":{ "url":"https://www.example.com/image.jpg" }, "buttons":[ { "name":"Shop Now", "urlPc":"https://www.example.com/shop", "urlMobile":"https://m.example.com/shop", "target":"OUT", "type":"URL" }, { "name":"Open App", "schemeAndroid":"myapp://product/123", "schemeIos":"myapp://product/123", "urlMobile":"https://m.example.com/product/123", "urlPc":"https://www.example.com/product/123", "type":"APP_LINK" } ], "type":"IMAGE_FREE_FORM" } } ] } }, "Send a free form wide image brand message":{ "summary":"Send a free form wide image brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "text":"Discover our exclusive collection!", "image":{ "url":"https://www.example.com/wide-image.jpg" }, "buttons":[ { "name":"View", "urlPc":"https://www.example.com/collection", "urlMobile":"https://m.example.com/collection", "target":"OUT", "type":"URL" } ], "type":"IMAGE_WIDE_FREE_FORM" } } ] } }, "Send a free form item list brand message":{ "summary":"Send a free form item list brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "header":"Top Products This Week", "buttons":[ { "name":"Shop All", "urlPc":"https://www.example.com/shop", "urlMobile":"https://m.example.com/shop", "target":"OUT", "type":"URL" } ], "itemList":[ { "title":"Premium Coffee Beans", "url":"https://www.example.com/coffee.jpg", "urlMobile":"https://m.example.com/coffee", "urlPC":"https://www.example.com/coffee" }, { "title":"Organic Green Tea", "url":"https://www.example.com/tea.jpg", "urlMobile":"https://m.example.com/tea", "urlPC":"https://www.example.com/tea" }, { "title":"Artisan Chocolate", "url":"https://www.example.com/chocolate.jpg", "urlMobile":"https://m.example.com/chocolate", "urlPC":"https://www.example.com/chocolate" } ], "type":"ITEM_LIST_FREE_FORM" }, "options":{ "targeting":"ALL_CONSENT" } } ] } }, "Send a commerce free form brand message":{ "summary":"Send a commerce free form brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "commerce":{ "title":"Premium Wireless Headphones", "regularPrice":199000, "discountPrice":159000, "discountFixed":40000, "discountRate":20 }, "buttons":[ { "name":"Buy Now", "urlPc":"https://www.example.com/buy/headphones", "urlMobile":"https://m.example.com/buy/headphones", "target":"OUT", "type":"URL" } ], "image":{ "url":"https://www.example.com/headphones.jpg", "link":"https://www.example.com/product/headphones" }, "additionalContent":"Free shipping on orders over $50", "coupon":{ "title":{ "couponTitleParameter":30, "type":"PERCENTAGE_DISCOUNT_COUPON" }, "description":"Summer Sale", "urlMobile":"https://m.example.com/coupon/summer", "urlPC":"https://www.example.com/coupon/summer" }, "type":"COMMERCE_FREE_FORM" }, "options":{ "targeting":"ALL_CONSENT" } } ] } }, "Send a carousel free form brand message":{ "summary":"Send a carousel free form brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "head":{ "header":"Latest Updates", "content":"Discover our newest features and products", "image":{ "url":"https://www.example.com/carousel-intro.jpg" }, "urlMobile":"https://m.example.com/updates", "urlPc":"https://www.example.com/updates" }, "elements":[ { "header":"Summer Collection", "message":"Explore our vibrant summer styles with up to 30% off on selected items. Limited time offer!", "attachment":{ "image":{ "url":"https://www.example.com/summer.jpg" }, "buttons":[ { "name":"Shop Now", "urlPc":"https://www.example.com/summer", "urlMobile":"https://m.example.com/summer", "target":"OUT", "type":"URL" } ], "coupon":{ "title":{ "couponTitleParameter":30, "type":"PERCENTAGE_DISCOUNT_COUPON" }, "description":"Summer Sale", "urlMobile":"https://m.example.com/coupon/summer", "urlPC":"https://www.example.com/coupon/summer" } } }, { "header":"Winter Preview", "message":"Get ready for the cold season with our cozy winter collection. Pre-order now for early bird discounts!", "attachment":{ "image":{ "url":"https://www.example.com/winter.jpg" }, "buttons":[ { "name":"Pre-order", "urlPc":"https://www.example.com/winter", "urlMobile":"https://m.example.com/winter", "target":"OUT", "type":"URL" } ] } } ], "tail":{ "schemeAndroid":"See More", "urlMobile":"https://m.example.com/all-products", "urlPc":"https://www.example.com/all-products" }, "type":"CAROUSEL_FREE_FORM" }, "options":{ "targeting":"ALL_CONSENT" } } ] } }, "Send a carousel commerce free form brand message":{ "summary":"Send a carousel commerce free form brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "head":{ "header":"Special Offers", "content":"Check out our best deals today!", "imageUrl":"https://www.example.com/carousel-header.jpg", "urlMobile":"https://m.example.com/shop" }, "elements":[ { "attachment":{ "image":{ "url":"https://www.example.com/headphones.jpg", "link":"https://www.example.com/product/headphones" }, "buttons":[ { "name":"Buy Now", "urlPc":"https://www.example.com/buy/headphones", "urlMobile":"https://m.example.com/buy/headphones", "target":"OUT", "type":"URL" } ], "commerce":{ "title":"Premium Wireless Headphones", "regularPrice":199000, "discountPrice":159000, "discountFixed":20 }, "coupon":{ "title":{ "couponTitleParameter":20, "type":"PERCENTAGE_DISCOUNT_COUPON" }, "description":"Save 20%", "urlMobile":"https://m.example.com/coupon", "urlPC":"https://www.example.com/coupon" } }, "additionalContent":"Limited time offer - Free shipping" }, { "attachment":{ "image":{ "url":"https://www.example.com/smartwatch.jpg", "link":"https://www.example.com/product/smartwatch" }, "buttons":[ { "name":"View Now", "urlPc":"https://www.example.com/buy/smartwatch", "urlMobile":"https://m.example.com/buy/smartwatch", "target":"OUT", "type":"URL" } ], "commerce":{ "title":"Smart Watch Series X", "regularPrice":350000, "discountPrice":280000, "discountFixed":20 } }, "additionalContent":"Best seller - Extended warranty" } ], "tail":{ "urlMobile":"https://m.example.com/shop/all" }, "type":"CAROUSEL_COMMERCE_FREE_FORM" }, "options":{ "targeting":"ALL_CONSENT" } } ] } }, "Send a premium video free form brand message":{ "summary":"Send a premium video free form brand message", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "header":"Sample header", "content":"Sample content", "video":{ "videoUrl":"https://www.example.com/premium-video.mp4", "thumbnailUrl":"https://www.example.com/video-thumbnail.jpg" }, "button":{ "name":"Watch", "urlPc":"https://www.example.com/watch", "urlMobile":"https://m.example.com/watch", "target":"OUT", "type":"URL" }, "coupon":{ "title":{ "couponTitleParameter":30, "type":"PERCENTAGE_DISCOUNT_COUPON" }, "description":"Summer Sale", "urlMobile":"https://m.example.com/coupon/summer", "urlPC":"https://www.example.com/coupon/summer" }, "type":"PREMIUM_VIDEO_FREE_FORM" }, "options":{ "targeting":"ALL_CONSENT" } } ] } }, "Send a brand message text variable template":{ "summary":"Send a brand message text variable template", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "templateCode":"templateCode123", "messageData":{ "var1":"name", "var2":"surname" }, "buttonData":{ "buttonVar":"www.example.com" }, "couponData":{ "couponVar":"Big discount" }, "type":"TEXT_VARIABLE" }, "options":{ "targeting":"TARGETED_FRIENDS" } } ] } }, "Send a brand message item list variable template":{ "summary":"Send a brand message item list variable template", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "templateCode":"templateCode123", "messageData":{ "var1":"Header text", "var2":"Item 1", "var3":"Item 2", "var4":"Item 3" }, "buttonData":{ "var5":"Button title", "var6":"https://button.url" }, "couponData":{ "var7":"Coupon description" }, "imageData":[ { "img_url":"https://www.example.com/sample.jpg" }, { "img_url":"https://www.example.com/sample.jpg" } ], "type":"ITEM_LIST_VARIABLE" }, "options":{ "targeting":"TARGETED_FRIENDS" } } ] } }, "Send a brand message image variable template":{ "summary":"Send a brand message image variable template", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "templateCode":"templateCode123", "messageData":{ "var1":"name", "var2":"surname" }, "buttonData":{ "buttonVar":"www.example.com" }, "couponData":{ "couponVar":"Big discount" }, "imageData":[ { "img_url":"https://www.example.com/sample.jpg" } ], "type":"IMAGE_VARIABLE" }, "options":{ "targeting":"TARGETED_FRIENDS" } } ] } }, "Send a brand message wide image variable template":{ "summary":"Send a brand message wide image variable template", "value":{ "messages":[ { "sender":"OFFICIAL-ACCOUNT-ID-123", "destinations":[ { "to":"66855538125" } ], "content":{ "templateCode":"templateCode123", "messageData":{ "var1":"name", "var2":"surname" }, "buttonData":{ "buttonVar":"www.example.com" }, "couponData":{ "couponVar":"Big discount" }, "imageData":[ { "img_url":"https://www.example.com/sample.jpg" } ], "type":"IMAGE_WIDE_VARIABLE" }, "options":{ "targeting":"TARGETED_FRIENDS" } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Brand message response":{ "summary":"Brand message response", "value":{ "bulkId":"2034072219640523072", "messages":[ { "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "status":{ "groupId":1, "groupName":"PENDING", "id":7, "name":"PENDING_ENROUTE", "description":"Message sent to next instance" }, "destination":"66855538125" } ] } } } } } }, "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", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-chingu/1/reports":{ "get":{ "tags":[ "channels", "kakao", "chingu", "logs-and-status-reports-kakao-chingu" ], "summary":"Get brand message 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 brand message and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"get-outbound-kakao-chingu-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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "kakao:message:send", "kakao:manage" ], "x-is-early-access":true } }, "/kakao-chingu/1/logs":{ "get":{ "tags":[ "channels", "kakao", "chingu", "logs-and-status-reports-kakao-chingu" ], "summary":"Get message logs", "description":"Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.", "operationId":"get-outbound-kakao-chingu-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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogResponseLogKakaoChinguOutboundContent" } } } }, "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":[ "kakao:logs:read", "kakao:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":120, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/kakao-brand-messages/1/templates":{ "get":{ "tags":[ "channels", "kakao", "chingu", "kakao-brand-template-management" ], "summary":"Get Brand Message templates", "description":"Get Brand Message templates with an optional time range filter to include only those modified within that period.", "externalDocs":{ "description":"Learn more about Kakao Chingu channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"get-brand-message-templates", "parameters":[ { "name":"senderKey", "in":"query", "description":"Sender profile key.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":40, "minLength":0 }, "example":123456789 }, { "name":"senderGroupKey", "in":"query", "description":"Sender group profile key.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":40, "minLength":0 } }, { "name":"since", "in":"query", "description":"Start date in format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Defaults to 1 hour before the time of the request.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "format":"date-time" }, "example":"2025-09-26T14:52:14.000+0200" }, { "name":"page", "in":"query", "description":"Current page number.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":1 }, "example":5 }, { "name":"size", "in":"query", "description":"Number of items per page.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "default":100, "minimum":1 }, "example":10 } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ModifiedTemplateResponse" }, "examples":{ "Successful response":{ "summary":"Successful response", "value":{ "results":[ { "templateCode":"code_001" }, { "templateCode":"code_002" }, { "templateCode":"code_003" } ] } } } } } }, "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":[ "kakao:manage" ], "x-is-early-access":true }, "post":{ "tags":[ "channels", "kakao", "chingu", "kakao-brand-template-management" ], "summary":"Create Brand Message template", "description":"Create Brand Message template.", "externalDocs":{ "description":"Learn more about Kakao Chingu channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"create-brand-message-template", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest" }, "examples":{ "Text template with URL button":{ "summary":"Text template with URL button", "value":{ "sender":"SENDER123", "name":"Sample name", "isAdult":false, "templateContent":{ "text":"Sample text", "buttons":[ { "name":"ExName", "urlMobile":"https://m.example.com/deals", "urlPc":"https://example.com/deals", "type":"URL" } ], "type":"TEXT" } }, "x-label":{ "template type":[ "TEXT" ] } }, "Text template with multiple buttons":{ "summary":"Text template with multiple buttons", "value":{ "sender":"SENDER123", "name":"Sample name", "templateContent":{ "text":"Sample text", "buttons":[ { "name":"Sample name", "urlMobile":"https://m.example.com", "urlPc":"https://example.com", "type":"URL" }, { "name":"sample name", "schemeAndroid":"myapp://home", "schemeIos":"myapp://home", "urlMobile":"https://m.example.com", "urlPc":"https://example.com", "type":"APP_LINK" }, { "name":"sample name", "type":"BOT_KEYWORD" }, { "name":"Sample name", "type":"MESSAGE_DELIVERY" } ], "type":"TEXT" } }, "x-label":{ "template type":[ "TEXT" ] } }, "Text template with coupon":{ "summary":"Text template with coupon", "value":{ "sender":"SENDER123", "name":"Sample name", "templateContent":{ "text":"Sample coupon", "coupon":{ "title":{ "couponTitle":"Sample", "type":"FREE_COUPON" }, "description":"Sample", "urlMobile":"https://m.example.com/coupon", "urlPc":"https://example.com/coupon", "schemeIos":"myapp://coupon", "schemeAndroid":"myapp://coupon" }, "type":"TEXT" } }, "x-label":{ "template type":[ "TEXT" ] } }, "Image template with button":{ "summary":"Image template with button", "value":{ "sender":"SENDER123", "name":"Sample name", "templateContent":{ "text":"Sample text", "image":{ "url":"https://example.com/images/product.jpg" }, "buttons":[ { "name":"Sample name", "urlMobile":"https://m.shop.example.com/product/123", "urlPc":"https://shop.example.com/product/123", "type":"URL" } ], "type":"IMAGE" } }, "x-label":{ "template type":[ "IMAGE" ] } }, "Image template with multiple buttons":{ "summary":"Image template with multiple buttons", "value":{ "sender":"SENDER123", "name":"Sample name", "templateContent":{ "text":"Sample text", "image":{ "url":"https://example.com/product.jpg" }, "buttons":[ { "name":"Ex Name", "urlMobile":"https://m.shop.example.com/new", "urlPc":"https://shop.example.com/new", "type":"URL" }, { "name":"Ex Name", "type":"BOT_KEYWORD" } ], "type":"IMAGE" } }, "x-label":{ "template type":[ "IMAGE" ] } }, "Image wide template":{ "summary":"Image wide template", "value":{ "sender":"SENDER123", "name":"Wide Image Template", "templateContent":{ "text":"Sample text", "image":{ "url":"https://example.com/images/wide-banner.jpg" }, "buttons":[ { "name":"Sample name", "urlMobile":"https://m.example.com/info", "urlPc":"https://example.com/info", "type":"URL" } ], "type":"IMAGE_WIDE" } }, "x-label":{ "template type":[ "IMAGE_WIDE" ] } }, "Item list template":{ "summary":"Item list template", "value":{ "sender":"SENDER123", "name":"Sample name", "templateContent":{ "header":"Sample item list header text", "wide":{ "title":"Main Element", "imageUrl":"https://example.com/image.jpg", "urlMobile":"https://example.com/main-product" }, "wideList":[ { "title":"Sub element 1", "imageUrl":"https://example.com/image.jpg", "urlMobile":"https://example.com/product1" }, { "title":"Sub element 2", "imageUrl":"https://example.com/image.jpg", "urlMobile":"https://example.com/product2" } ], "buttons":[ { "name":"Sample btn", "urlMobile":"https://m.example.com/catalog", "urlPc":"https://example.com/catalog", "type":"URL" } ], "type":"ITEM_LIST" } }, "x-label":{ "template type":[ "ITEM_LIST" ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateResponse" }, "examples":{ "Successful response":{ "summary":"Successful response", "value":{ "templateCode":"abcdh1234efgh5678" } } } } } }, "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":[ "kakao:manage" ], "x-is-early-access":true, "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"m" } ] } }, "/kakao-brand-messages/1/templates/single":{ "get":{ "tags":[ "channels", "kakao", "chingu", "kakao-brand-template-management" ], "summary":"Get Brand Message template", "description":"Get Brand Message template", "externalDocs":{ "description":"Learn more about Kakao Chingu channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"get-brand-message-template", "parameters":[ { "name":"sender", "in":"query", "description":"Must be provided if senderGroup is not provided.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":40, "minLength":1 }, "example":123456789 }, { "name":"senderGroup", "in":"query", "description":"Must be provided if sender is not provided.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":40, "minLength":1 } }, { "name":"templateCode", "in":"query", "description":"Template code.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "maxLength":50, "minLength":1 }, "example":"abc123dfg345" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GetTemplateResponse" }, "examples":{ "Text template response":{ "summary":"Text template response", "value":{ "name":"Sample name", "templateContent":{ "text":"Sample text", "buttons":[ { "name":"ExName", "urlMobile":"https://example.com/deals", "urlPc":"https://example.com/deals", "type":"URL" } ], "coupon":{ "title":{ "couponTitle":"Sample", "type":"FREE_COUPON" }, "description":"Sample", "urlMobile":"https://m.example.com/coupon", "urlPc":"https://example.com/coupon", "schemeIos":"myapp://coupon", "schemeAndroid":"myapp://coupon" }, "type":"TEXT" } } }, "Image template response":{ "summary":"Image template response", "value":{ "name":"Sample name", "templateContent":{ "text":"Sample text", "image":{ "url":"https://example.com/images/product.jpg" }, "buttons":[ { "name":"ExName", "urlMobile":"https://m.example.com/deals", "urlPc":"https://example.com/deals", "type":"URL" } ], "coupon":{ "title":{ "couponTitle":"Sample", "type":"FREE_COUPON" }, "description":"Sample", "urlMobile":"https://m.example.com/coupon", "urlPc":"https://example.com/coupon", "schemeIos":"myapp://coupon", "schemeAndroid":"myapp://coupon" }, "type":"IMAGE" } } } } } } }, "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":"Template not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "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":"templateCode", "violation":"Template with provided ID does not exist." } ], "resources":[ { "name":"API documentation", "url":"https://www.infobip.com/docs/api/channels/kakao/chingu/kakao-brand-template-management" } ] } } } } } }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "kakao:manage" ], "x-is-early-access":true } }, "/kakao-brand-messages/1/templates/{templateCode}":{ "put":{ "tags":[ "channels", "kakao", "chingu", "kakao-brand-template-management" ], "summary":"Update Brand Message template", "description":"Update an existing Brand Message template by template code.", "externalDocs":{ "description":"Learn more about Kakao Chingu channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"update-brand-message-template", "parameters":[ { "name":"templateCode", "in":"path", "description":"Template code to update.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"TEMPLATE_001" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest" }, "examples":{ "Update text template with URL button":{ "summary":"Update text template with URL button", "value":{ "sender":"SENDER123", "name":"Updated template name", "isAdult":false, "templateContent":{ "text":"Updated template text content", "buttons":[ { "name":"ExName", "urlMobile":"https://example.com/deals", "urlPc":"https://example.com/deals", "type":"URL" } ], "type":"TEXT" } } }, "Update text template with coupon":{ "summary":"Update text template with coupon", "value":{ "sender":"SENDER123", "name":"Updated coupon template", "templateContent":{ "text":"Updated coupon offer", "coupon":{ "title":{ "couponTitle":"Updated Coupon", "type":"FREE_COUPON" }, "description":"Updated coupon description", "urlMobile":"https://m.example.com/updated-coupon", "urlPc":"https://example.com/updated-coupon", "schemeIos":"myapp://updated-coupon", "schemeAndroid":"myapp://updated-coupon" }, "type":"TEXT" } } }, "Update image template with button":{ "summary":"Update image template with button", "value":{ "sender":"SENDER123", "name":"Updated image template", "templateContent":{ "text":"Updated image template text", "image":{ "url":"https://example.com/images/updated-product.jpg" }, "buttons":[ { "name":"Sample name", "urlMobile":"https://shop.example.com/product/123", "urlPc":"https://shop.example.com/product/123", "type":"URL" } ], "type":"IMAGE" } } }, "Update image wide template":{ "summary":"Update image wide template", "value":{ "sender":"SENDER123", "name":"Updated Wide Image Template", "templateContent":{ "text":"Updated wide template text", "image":{ "url":"https://example.com/images/updated-wide-banner.jpg" }, "buttons":[ { "name":"Sample name", "urlMobile":"https://example.com/info", "urlPc":"https://example.com/info", "type":"URL" } ], "type":"IMAGE_WIDE" } } }, "Update item list template":{ "summary":"Update item list template", "value":{ "sender":"SENDER123", "name":"Updated item list template", "templateContent":{ "header":"Updated item list header text", "wide":{ "title":"Updated Main Element", "imageUrl":"https://example.com/updated-image.jpg", "urlMobile":"https://example.com/updated-main-product" }, "wideList":[ { "title":"Updated sub element 1", "imageUrl":"https://example.com/updated-image1.jpg", "urlMobile":"https://example.com/updated-product1" }, { "title":"Updated sub element 2", "imageUrl":"https://example.com/updated-image2.jpg", "urlMobile":"https://example.com/updated-product2" } ], "buttons":[ { "name":"Sample name", "urlMobile":"https://example.com/info", "urlPc":"https://example.com/info", "type":"URL" } ], "type":"ITEM_LIST" } } }, "Update text template with multiple buttons":{ "summary":"Update text template with multiple buttons", "value":{ "sender":"SENDER123", "name":"Updated multi-button template", "templateContent":{ "text":"Updated template with multiple buttons", "buttons":[ { "name":"Sample name", "urlMobile":"https://example.com", "urlPc":"https://example.com", "type":"URL" }, { "name":"sample name", "schemeAndroid":"myapp://home", "schemeIos":"myapp://home", "urlMobile":"https://m.example.com", "urlPc":"https://example.com", "type":"APP_LINK" }, { "name":"Updated keyword", "type":"BOT_KEYWORD" }, { "name":"Updated message", "type":"MESSAGE_DELIVERY" } ], "type":"TEXT" } } }, "Update image template with multiple buttons":{ "summary":"Update image template with multiple buttons", "value":{ "sender":"SENDER123", "name":"Updated image with buttons", "templateContent":{ "text":"Updated image template text", "image":{ "url":"https://example.com/updated-product.jpg" }, "buttons":[ { "name":"Ex Name", "urlMobile":"https://shop.example.com/new", "urlPc":"https://shop.example.com/new", "type":"URL" }, { "name":"Updated Info", "type":"BOT_KEYWORD" } ], "type":"IMAGE" } } } } } }, "required":true }, "responses":{ "204":{ "description":"No Content" }, "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":"Template not found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "examples":{ "Response example":{ "summary":"Response example", "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":"templateCode", "violation":"Template with provided ID does not exist." } ], "resources":[ { "name":"API documentation", "url":"https://www.infobip.com/docs/api/channels/kakao/chingu/kakao-brand-template-management" } ] } } } } } }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "kakao:manage" ], "x-is-early-access":true } } }, "components":{ "schemas":{ "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice" }, "status":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus" }, "error":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReport" } } }, "title":"DeliveryReports" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.FailoverDestinationPair":{ "type":"object", "description":"The SMS failover destination matching.", "properties":{ "initial":{ "type":"string", "description":"The initial destination address specified in the request." }, "failover":{ "type":"string", "description":"The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)" } }, "required":[ "failover", "initial" ], "title":"FailoverDestinationPair" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.InboundMessageKakaoSangdamInboundContent":{ "type":"object", "description":"Collection of mobile originated messages.", "properties":{ "entityId":{ "type":"string", "description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "maxLength":255, "minLength":0 }, "applicationId":{ "type":"string", "description":"Used when specifying an 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 }, "sender":{ "type":"string", "description":"Number which sent the message." }, "to":{ "type":"string", "description":"Sender provided during the activation process." }, "integrationType":{ "type":"string", "description":"Integration type." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message text." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of paired outgoing message if matched by Infobip platform." }, "callbackData":{ "type":"string", "description":"Callback data sent through ‛callbackData‛ field when sending message." }, "message":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, "price":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice" } }, "required":[ "integrationType", "message", "messageId", "price", "receivedAt", "sender", "to" ], "title":"InboundMessageKakaoSangdamInboundContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton":{ "type":"object", "discriminator":{ "propertyName":"type", "mapping":{ "OPEN_APPLICATION":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOpenApplicationButton", "OPEN_URL":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOpenUrlButton", "CHATBOT_SWITCH":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamChatbotSwitchButton", "REPLY":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamReplyButton", "REPLY_WITH_TEXT":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamReplyWithTextButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButtonType" } }, "title":"KakaoSangdamButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButtonType":{ "type":"string", "enum":[ "OPEN_APPLICATION", "OPEN_URL", "CHATBOT_SWITCH", "REPLY", "REPLY_WITH_TEXT" ], "title":"KakaoSangdamButtonType" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamChatbotSwitchButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "maxLength":28, "minLength":0 }, "event":{ "type":"string", "maxLength":100, "minLength":0, "pattern":"[A-Za-z0-9_]{1,100}" } } } ], "required":[ "name" ], "title":"KakaoSangdamChatbotSwitchButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundAudioContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "urlsDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.UrlDetails" } }, "sentAt":{ "type":"string", "format":"date-time" } } } ], "required":[ "sentAt", "url", "urlsDetails" ], "title":"KakaoSangdamInboundAudioContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundTextContent", "IMAGE":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundImageContent", "VIDEO":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundVideoContent", "AUDIO":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundAudioContent", "FILE":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundFileContent", "EXPIRED_SESSION":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundExpiredSessionContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContentType" } }, "title":"KakaoSangdamInboundContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContentType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "VIDEO", "AUDIO", "FILE", "EXPIRED_SESSION" ], "title":"KakaoSangdamInboundContentType" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundExpiredSessionContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "sessionId":{ "type":"string" }, "sentAt":{ "type":"string", "format":"date-time" } } } ], "required":[ "sentAt", "sessionId" ], "title":"KakaoSangdamInboundExpiredSessionContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundFileContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "urlsDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.UrlDetails" } }, "sentAt":{ "type":"string", "format":"date-time" } } } ], "required":[ "sentAt", "url", "urlsDetails" ], "title":"KakaoSangdamInboundFileContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "urlsDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.UrlDetails" } }, "sentAt":{ "type":"string", "format":"date-time" } } } ], "required":[ "sentAt", "url", "urlsDetails" ], "title":"KakaoSangdamInboundImageContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of mobile originated messages.", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.InboundMessageKakaoSangdamInboundContent" } }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of messages returned in the results array." }, "pendingMessageCount":{ "type":"integer", "format":"int32", "description":"The number of messages that have not been pulled in." } }, "title":"KakaoSangdamInboundResponse" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":4000, "minLength":0 }, "sentAt":{ "type":"string", "format":"date-time" }, "attachmentUrl":{ "type":"string" }, "extra":{ "type":"string" } } } ], "required":[ "sentAt", "text" ], "title":"KakaoSangdamInboundTextContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundVideoContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string" }, "urlsDetails":{ "type":"array", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.UrlDetails" } }, "sentAt":{ "type":"string", "format":"date-time" } } } ], "required":[ "sentAt", "url", "urlsDetails" ], "title":"KakaoSangdamInboundVideoContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ToDestination" } }, "content":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" }, "options":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnMessageFailoverOptions" }, "webhooks":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Webhooks" } }, "required":[ "content", "destinations", "sender" ], "title":"KakaoSangdamMessage" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessageRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RequestSchedulingSettings" } }, "title":"KakaoSangdamMessageRequestOptions" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOpenApplicationButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "maxLength":28, "minLength":0 }, "schemeAndroid":{ "type":"string" }, "schemeIos":{ "type":"string" }, "fallbackUrlMobile":{ "type":"string" }, "fallbackUrlPc":{ "type":"string" } } } ], "required":[ "name", "schemeAndroid", "schemeIos" ], "title":"KakaoSangdamOpenApplicationButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOpenUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "maxLength":28, "minLength":0 }, "urlMobile":{ "type":"string" }, "urlPc":{ "type":"string" } } } ], "required":[ "name", "urlMobile", "urlPc" ], "title":"KakaoSangdamOpenUrlButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundButtonListContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":1000, "minLength":0 }, "buttons":{ "type":"array", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, "maxItems":5, "minItems":1 } } } ], "required":[ "buttons", "text" ], "title":"KakaoSangdamOutboundButtonListContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTextContent", "IMAGE":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundImageContent", "BUTTON_LIST":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundButtonListContent", "TERMINATE_SESSION":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTerminateSessionContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContentType" } }, "title":"KakaoSangdamOutboundContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContentType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "BUTTON_LIST", "TERMINATE_SESSION" ], "title":"KakaoSangdamOutboundContentType" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "maxLength":1000, "minLength":0 } } } ], "required":[ "url" ], "title":"KakaoSangdamOutboundImageContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTerminateSessionContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" } ], "title":"KakaoSangdamOutboundTerminateSessionContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "maxLength":1000, "minLength":0 } } } ], "required":[ "text" ], "title":"KakaoSangdamOutboundTextContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamReplyButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "maxLength":28, "minLength":0 }, "extra":{ "type":"string", "maxLength":100, "minLength":0 } } } ], "required":[ "name" ], "title":"KakaoSangdamReplyButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamReplyWithTextButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "maxLength":28, "minLength":0 }, "extra":{ "type":"string", "maxLength":100, "minLength":0 } } } ], "required":[ "name" ], "title":"KakaoSangdamReplyWithTextButton" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamRequest":{ "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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessage" } }, "options":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessageRequestOptions" } }, "required":[ "messages" ], "title":"KakaoSangdamRequest" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogKakaoSangdamOutboundContent":{ "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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice" }, "status":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus" }, "error":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageError" }, "platform":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform" }, "content":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"LogKakaoSangdamOutboundContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogResponseLogKakaoSangdamOutboundContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogKakaoSangdamOutboundContent" } }, "cursor":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.CursorPageInfo" } }, "title":"LogResponseLogKakaoSangdamOutboundContent" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageDeliveryReporting":{ "type":"object", "description":"Provides options for configuring the delivery report behavior.", "properties":{ "url":{ "type":"string", "description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`." }, "intermediateReport":{ "type":"boolean", "description":"The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`." }, "notify":{ "type":"boolean", "description":"Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply." } }, "title":"MessageDeliveryReporting" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnMessageFailoverOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnSmsFailover" } }, "title":"NonMsisdnMessageFailoverOptions" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnSmsFailover":{ "type":"object", "description":"Failover SMS message to be sent if the original message could not be delivered.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "text":{ "type":"string", "description":"Content of the message being sent." }, "validityPeriod":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriod" }, "regional":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RegionalOptions" }, "destinationMatching":{ "type":"array", "description":"The SMS failover destination matching.", "items":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.FailoverDestinationPair" } } }, "required":[ "text" ], "title":"NonMsisdnSmsFailover" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.UrlDetails":{ "type":"object", "properties":{ "url":{ "type":"string" }, "comment":{ "type":"string" } }, "required":[ "url" ], "title":"UrlDetails" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.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/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Webhooks":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageDeliveryReporting" }, "contentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`." }, "callbackData":{ "type":"string", "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.", "maxLength":4000, "minLength":0 } }, "title":"Webhooks" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.AddChannelButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 } } } ], "description":"Button that adds the Kakao channel as a friend.", "required":[ "name" ], "title":"AddChannelButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.AppLinkButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 }, "schemeAndroid":{ "type":"string", "description":"At least two of schemeAndroid, schemeIos, and urlMobile must be provided.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"At least two of schemeAndroid, schemeIos, and urlMobile must be provided.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"At least two of schemeAndroid, schemeIos, and urlMobile must be provided.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to open on PC.", "maxLength":500, "minLength":1 } } } ], "description":"Button that opens a mobile application via a custom URI scheme. Falls back to a URL if the app is not installed.", "required":[ "name" ], "title":"AppLinkButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.BotKeywordButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 } } } ], "description":"Button that triggers a bot keyword when tapped.", "required":[ "name" ], "title":"BotKeywordButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button":{ "type":"object", "description":"List of buttons attached to the message.", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.AppLinkButton", "DELIVERY_TRACKING":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTrackingButton", "URL":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.UrlButton", "CHATBOT_SWITCH":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ChatbotSwitchButton", "BOT_KEYWORD":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.BotKeywordButton", "MESSAGE_DELIVERY":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryButton", "ADD_CHANNEL":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.AddChannelButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ButtonType" } }, "title":"Button" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ButtonType":{ "type":"string", "enum":[ "APP_LINK", "DELIVERY_TRACKING", "URL", "CHATBOT_SWITCH", "BOT_KEYWORD", "MESSAGE_DELIVERY", "ADD_CHANNEL" ], "title":"ButtonType" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ChatbotSwitchButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 }, "chatExtra":{ "type":"string", "description":"Additional metadata passed to the chatbot.", "maxLength":50, "minLength":0 }, "chatEvent":{ "type":"string", "description":"Chatbot event name to trigger.", "maxLength":50, "minLength":0 } } } ], "description":"Button that switches the conversation to a chatbot.", "required":[ "name" ], "title":"ChatbotSwitchButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ClientPriority":{ "type":"string", "description":"Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.", "enum":[ "HIGH", "STANDARD", "LOW" ], "title":"ClientPriority" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DefaultSmsFailover":{ "type":"object", "description":"Failover SMS message to be sent if the original message could not be delivered.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "text":{ "type":"string", "description":"Content of the message being sent." }, "validityPeriod":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriod" }, "regional":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RegionalOptions" } }, "required":[ "text" ], "title":"DefaultSmsFailover" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice" }, "status":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus" }, "error":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReport" } } }, "title":"DeliveryReports" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTrackingButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 } } } ], "description":"Button that opens a delivery tracking page.", "required":[ "name" ], "title":"DeliveryTrackingButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "sender":{ "type":"string" }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ToDestination" } }, "content":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent" }, "options":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MsisdnMessageFailoverOptions" }, "webhooks":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Webhooks" } }, "required":[ "content", "destinations", "sender" ], "title":"KakaoAlimMessage" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessageRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RequestSchedulingSettings" }, "priority":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ClientPriority" } }, "title":"KakaoAlimMessageRequestOptions" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEMPLATE":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundTemplateContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContentType" } }, "title":"KakaoAlimOutboundContent" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContentType":{ "type":"string", "enum":[ "TEMPLATE" ], "title":"KakaoAlimOutboundContentType" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundTemplateContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent" }, { "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Template code registered in KakaoTalk channel.", "maxLength":30, "minLength":0 }, "text":{ "type":"string", "description":"Message text content.", "maxLength":1000, "minLength":0 }, "title":{ "type":"string", "description":"Message title.", "maxLength":50, "minLength":0 }, "buttons":{ "type":"array", "description":"List of buttons attached to the message.", "items":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, "maxItems":5, "minItems":0 }, "groupKey":{ "type":"string", "description":"Key associated with a group." } } } ], "description":"Template message content.", "required":[ "templateCode", "text" ], "title":"KakaoAlimOutboundTemplateContent" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimRequest":{ "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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessage" } }, "options":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessageRequestOptions" } }, "required":[ "messages" ], "title":"KakaoAlimRequest" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogKakaoAlimOutboundContent":{ "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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice" }, "status":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus" }, "error":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageError" }, "platform":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform" }, "content":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"LogKakaoAlimOutboundContent" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogResponseLogKakaoAlimOutboundContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogKakaoAlimOutboundContent" } }, "cursor":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.CursorPageInfo" } }, "title":"LogResponseLogKakaoAlimOutboundContent" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 } } } ], "description":"Button that triggers delivery of a pre-configured message when tapped.", "required":[ "name" ], "title":"MessageDeliveryButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryReporting":{ "type":"object", "description":"Provides options for configuring the delivery report behavior.", "properties":{ "url":{ "type":"string", "description":"The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`." }, "intermediateReport":{ "type":"boolean", "description":"The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`." }, "notify":{ "type":"boolean", "description":"Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to 'true' or not defined, your Subscription settings will apply." } }, "title":"MessageDeliveryReporting" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MsisdnMessageFailoverOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DefaultSmsFailover" } }, "title":"MsisdnMessageFailoverOptions" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.UrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Button" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button label displayed to the user.", "maxLength":28, "minLength":0 }, "urlMobile":{ "type":"string", "description":"URL to open on mobile devices.", "maxLength":500, "minLength":0 }, "urlPc":{ "type":"string", "description":"URL to open on PC.", "maxLength":500, "minLength":1 }, "target":{ "type":"string", "description":"Target window for the URL (e.g., _self, _blank).", "maxLength":3, "minLength":0 } } } ], "description":"Button that opens a URL in the user's browser when tapped.", "required":[ "name", "urlMobile" ], "title":"UrlButton" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Webhooks":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryReporting" }, "contentType":{ "type":"string", "description":"Preferred delivery report content type, `application/json` or `application/xml`." }, "callbackData":{ "type":"string", "description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.", "maxLength":4000, "minLength":0 } }, "title":"Webhooks" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedWebhooks":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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 } }, "title":"AdvancedWebhooks" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceFreeFormElement":{ "type":"object", "description":" List of carousel elements. Maximum 6.\n If head is present, minimum 1 element is required.\n If head is not present, minimum 2 elements are required.\n", "properties":{ "attachment":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceFreeFormElementAttachment" }, "additionalContent":{ "type":"string", "description":"Additional content of the carousel commerce list element.", "maxLength":34, "minLength":0 } }, "required":[ "attachment" ], "title":"CarouselCommerceFreeFormElement" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceFreeFormElementAttachment":{ "type":"object", "description":"Element attachment content.", "properties":{ "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "buttons":{ "type":"array", "description":" A maximum of 2. Only 1 `ADD_CHANNEL` button allowed across the entire carousel.\n `BUSINESS_FORM` button must be registered before using.\n `ADD_CHANNEL` button can be sent only for M and N targeting.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "maxItems":2, "minItems":1 }, "commerce":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CommerceFreeForm" }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShortDescriptionCoupon" } }, "required":[ "buttons", "image" ], "title":"CarouselCommerceFreeFormElementAttachment" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceHead":{ "type":"object", "description":"Optional carousel head with title and description.", "properties":{ "header":{ "type":"string", "description":"Header of the carousel commerce." }, "content":{ "type":"string", "description":"Content of the carousel commerce head." }, "imageUrl":{ "type":"string", "description":"URL of the image visible in head." }, "urlMobile":{ "type":"string", "description":"URL to redirect when user is in mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPc":{ "type":"string", "description":"URL to redirect when user is in PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme when user operates on Android environment." }, "schemeIos":{ "type":"string", "description":"Custom scheme when user operates on iOS environment." } }, "required":[ "content", "header" ], "title":"CarouselCommerceHead" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormElement":{ "type":"object", "description":"Carousel free form element with header, message, and attachment content.", "properties":{ "header":{ "type":"string", "description":"Header of the carousel element. Maximum 20 characters.", "maxLength":20, "minLength":0 }, "message":{ "type":"string", "description":"Message of the carousel element. Maximum 180 characters.", "maxLength":180, "minLength":0 }, "attachment":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormElementAttachment" } }, "required":[ "attachment", "header", "message" ], "title":"CarouselFreeFormElement" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormElementAttachment":{ "type":"object", "description":"Element attachment content containing image, buttons, and optional coupon.", "properties":{ "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "buttons":{ "type":"array", "description":" A maximum of 2. Only 1 `ADD_CHANNEL` button allowed across the entire carousel.\n `BUSINESS_FORM` button must be registered before using.\n `ADD_CHANNEL` button can be sent only for M and N targeting.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "maxItems":2, "minItems":1 }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShortDescriptionCoupon" } }, "required":[ "buttons", "image" ], "title":"CarouselFreeFormElementAttachment" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormHead":{ "type":"object", "description":"Head of the carousel free form.", "properties":{ "header":{ "type":"string", "description":"Header of the carousel free form head.", "maxLength":20, "minLength":0 }, "content":{ "type":"string", "description":"Content of the carousel free form head.", "maxLength":50, "minLength":0 }, "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment." }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment." } }, "required":[ "content", "header", "image" ], "title":"CarouselFreeFormHead" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselTail":{ "type":"object", "description":"Optional clickable footer displayed at the end of the carousel.", "properties":{ "schemeAndroid":{ "type":"string", "description":"Custom scheme when user operates on Android environment." }, "schemeIos":{ "type":"string", "description":"Custom scheme when user operates on iOS environment." }, "urlMobile":{ "type":"string", "description":"URL to redirect when user is in mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPc":{ "type":"string", "description":"URL to redirect when user is in PC environment. Must be a valid URL starting with `https://` or `http://`." } }, "required":[ "urlMobile" ], "title":"CarouselTail" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CommerceFreeForm":{ "type":"object", "description":"Commerce free form content.", "properties":{ "title":{ "type":"string", "description":"Title of the commerce content.", "maxLength":30, "minLength":1 }, "regularPrice":{ "type":"integer", "format":"int32", "description":"Regular price of the product.", "maximum":99999999, "minimum":0 }, "discountPrice":{ "type":"integer", "format":"int32", "description":"Price of the product after discount applied. If provided should be alongside one of `discountFixed` or `discountRate`.", "maximum":99999999, "minimum":0 }, "discountFixed":{ "type":"integer", "format":"int32", "description":"Fixed discount amount.", "maximum":999999, "minimum":0 }, "discountRate":{ "type":"integer", "format":"int32", "description":"Discount rate in percentage.", "maximum":100, "minimum":0 } }, "required":[ "regularPrice", "title" ], "title":"CommerceFreeForm" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Coupon":{ "type":"object", "description":"Coupon content.", "properties":{ "title":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, "description":{ "type":"string", "description":"Coupon content description." }, "urlMobile":{ "type":"string", "description":"URL to redirect when user is in mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPC":{ "type":"string", "description":"URL to redirect when user is in PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeIOS":{ "type":"string", "description":"Custom scheme when user operates on iOS environment." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme when user operates on Android environment." } }, "required":[ "description", "title", "urlMobile" ], "title":"Coupon" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent":{ "type":"object", "description":"Coupon title.", "discriminator":{ "propertyName":"type", "mapping":{ "PRICE_DISCOUNT_COUPON":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.PriceDiscountCouponTitleContent", "PERCENTAGE_DISCOUNT_COUPON":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.PercentageDiscountCouponTitleContent", "SHIPPING_DISCOUNT_COUPON":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShippingDiscountCouponTitleContent", "FREE_COUPON":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.FreeCouponTitleContent", "UP_COUPON":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UpCouponTitleContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContentType" } }, "required":[ "type" ], "title":"CouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContentType":{ "type":"string", "enum":[ "PRICE_DISCOUNT_COUPON", "PERCENTAGE_DISCOUNT_COUPON", "SHIPPING_DISCOUNT_COUPON", "FREE_COUPON", "UP_COUPON" ], "title":"CouponTitleContentType" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultMessageRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RequestSchedulingSettings" }, "tracking":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UrlOptions" } }, "title":"DefaultMessageRequestOptions" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultSmsFailover":{ "type":"object", "description":"Failover SMS message to be sent if the original message could not be delivered.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "text":{ "type":"string", "description":"Content of the message being sent." }, "validityPeriod":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriod" }, "regional":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RegionalOptions" } }, "required":[ "text" ], "title":"DefaultSmsFailover" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice" }, "status":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus" }, "error":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"DeliveryReport" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReport" } } }, "title":"DeliveryReports" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.FreeCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitleParameter":{ "type":"string", "description":"Title parameter of the selected coupon.", "maxLength":7, "minLength":1 } } } ], "required":[ "couponTitleParameter", "type" ], "title":"FreeCouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.FreeFormVideo":{ "type":"object", "description":"Free form video content.", "properties":{ "videoUrl":{ "type":"string", "description":"URL to video. Must be a valid URL from Kakao TV only.", "maxLength":500, "minLength":0 }, "thumbnailUrl":{ "type":"string", "description":"URL to thumbnail of the video. Must be a valid URL from Kakao image API.", "maxLength":500, "minLength":0 } }, "required":[ "videoUrl" ], "title":"FreeFormVideo" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image":{ "type":"object", "description":"Image content.", "properties":{ "url":{ "type":"string", "description":"URL of an image sent in a Kakao message. Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `PNG`. Maximum image size is 500KB with 400 characters in text or 2MB with 76 characters in text.", "maxLength":250, "minLength":0 }, "link":{ "type":"string", "description":"URL to redirect to when clicking on the image in the message.", "maxLength":250, "minLength":0 } }, "required":[ "url" ], "title":"Image" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ItemListElement":{ "type":"object", "description":"List of 3-5 item list elements. First item title: maximum 25 characters. Remaining items: maximum 30 characters.", "properties":{ "title":{ "type":"string", "description":"List item title. Title of the first element must be shorter than 26 characters.Titles of the following elements must be shorter than 31 characters" }, "url":{ "type":"string", "description":"URL of an image sent in a Kakao list message. Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `PNG`. Maximum image size is 5Mb.The image of the first element has a ratio of 2:1, the subsequent ones 1:1", "maxLength":250, "minLength":0 }, "urlMobile":{ "type":"string", "description":"URL to redirect when user is in mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPC":{ "type":"string", "description":"URL to redirect when user is in PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme when user operates on Android environment." }, "schemeIOS":{ "type":"string", "description":"Custom scheme when user operates on iOS environment." } }, "required":[ "title", "url", "urlMobile" ], "title":"ItemListElement" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguMessage":{ "type":"object", "description":"An array of message objects of a single message or multiple messages sent under one bulk ID.", "properties":{ "sender":{ "type":"string", "description":"The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names)." }, "destinations":{ "type":"array", "description":"An array of destination objects for where messages are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ToDestination" } }, "content":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, "options":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoMessageOptions" }, "webhooks":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedWebhooks" } }, "required":[ "content", "destinations", "sender" ], "title":"KakaoChinguMessage" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselCommerceFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "head":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceHead" }, "elements":{ "type":"array", "description":" List of carousel elements. Maximum 6.\n If head is present, minimum 1 element is required.\n If head is not present, minimum 2 elements are required.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselCommerceFreeFormElement" }, "maxItems":6, "minItems":0 }, "tail":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselTail" } } } ], "required":[ "elements", "type" ], "title":"KakaoChinguOutboundCarouselCommerceFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "head":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormHead" }, "elements":{ "type":"array", "description":" List of carousel elements. Minimum 2, maximum 6 elements are required regardless of head presence.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselFreeFormElement" }, "maxItems":6, "minItems":2 }, "tail":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CarouselTail" } } } ], "required":[ "elements", "type" ], "title":"KakaoChinguOutboundCarouselFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCommerceFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "commerce":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CommerceFreeForm" }, "buttons":{ "type":"array", "description":" A maximum of 2.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "maxItems":2, "minItems":1 }, "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "additionalContent":{ "type":"string", "description":"Additional content or promotional text.", "maxLength":34, "minLength":0 }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShortDescriptionCoupon" } } } ], "description":"Commerce free form content with pricing and product information.", "required":[ "buttons", "commerce", "image", "type" ], "title":"KakaoChinguOutboundCommerceFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent":{ "type":"object", "description":"Message content.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextFreeFormContent", "IMAGE_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageFreeFormContent", "IMAGE_WIDE_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideFreeFormContent", "ITEM_LIST_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListFreeFormContent", "COMMERCE_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCommerceFreeFormContent", "CAROUSEL_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselFreeFormContent", "CAROUSEL_COMMERCE_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselCommerceFreeFormContent", "PREMIUM_VIDEO_FREE_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundPremiumVideoFreeFormContent", "TEXT_VARIABLE":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextVariableContent", "IMAGE_VARIABLE":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageVariableContent", "IMAGE_WIDE_VARIABLE":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideVariableContent", "ITEM_LIST_VARIABLE":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListVariableContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContentType" } }, "required":[ "type" ], "title":"KakaoChinguOutboundContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContentType":{ "type":"string", "enum":[ "TEXT_FREE_FORM", "IMAGE_FREE_FORM", "IMAGE_WIDE_FREE_FORM", "ITEM_LIST_FREE_FORM", "COMMERCE_FREE_FORM", "CAROUSEL_FREE_FORM", "CAROUSEL_COMMERCE_FREE_FORM", "PREMIUM_VIDEO_FREE_FORM", "TEXT_VARIABLE", "IMAGE_VARIABLE", "IMAGE_WIDE_VARIABLE", "ITEM_LIST_VARIABLE" ], "title":"KakaoChinguOutboundContentType" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":1300, "minLength":0 }, "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Coupon" }, "buttons":{ "type":"array", "description":" A maximum of 5 if a coupon is not provided, 4 if provided.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" } } } } ], "required":[ "image", "text", "type" ], "title":"KakaoChinguOutboundImageFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageVariableContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Brand message template code.", "maxLength":50, "minLength":0 }, "messageData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Message placeholder values. Required only if the template contains message placeholders." }, "buttonData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Buttons placeholder values. Required only if the template contains button placeholders." }, "couponData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Coupon placeholder values. Required only if the template contains coupon placeholders." }, "imageData":{ "type":"array", "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value.", "items":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value." } } } } ], "required":[ "templateCode", "type" ], "title":"KakaoChinguOutboundImageVariableContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":76, "minLength":0 }, "image":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Image" }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LongDescriptionCoupon" }, "buttons":{ "type":"array", "description":" `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "maxItems":2, "minItems":1 } } } ], "required":[ "image", "text", "type" ], "title":"KakaoChinguOutboundImageWideFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideVariableContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Brand message template code.", "maxLength":50, "minLength":0 }, "messageData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Message placeholder values. Required only if the template contains message placeholders." }, "buttonData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Buttons placeholder values. Required only if the template contains button placeholders." }, "couponData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Coupon placeholder values. Required only if the template contains coupon placeholders." }, "imageData":{ "type":"array", "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value.", "items":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value." } } } } ], "required":[ "templateCode", "type" ], "title":"KakaoChinguOutboundImageWideVariableContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "header":{ "type":"string", "description":"Item list header text.", "maxLength":20, "minLength":1 }, "buttons":{ "type":"array", "description":" A maximum of 2.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "maxItems":2, "minItems":1 }, "itemList":{ "type":"array", "description":"List of 3-5 item list elements. First item title: maximum 25 characters. Remaining items: maximum 30 characters.", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ItemListElement" }, "maxItems":5, "minItems":3 }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LongDescriptionCoupon" } } } ], "required":[ "header", "itemList", "type" ], "title":"KakaoChinguOutboundItemListFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListVariableContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Brand message template code.", "maxLength":50, "minLength":0 }, "messageData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Message placeholder values." }, "buttonData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Buttons placeholder values." }, "couponData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Coupon placeholder values." }, "imageData":{ "type":"array", "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value.", "items":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Image values to override images from the template. Each entry must contain 'img_url' key with the image URL value." } } } } ], "required":[ "templateCode", "type" ], "title":"KakaoChinguOutboundItemListVariableContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundPremiumVideoFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "header":{ "type":"string", "description":"Header of the message.", "maxLength":20, "minLength":0 }, "content":{ "type":"string", "description":"Text content of the message.", "maxLength":76, "minLength":0 }, "video":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.FreeFormVideo" }, "button":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LongDescriptionCoupon" } } } ], "description":"Premium video free form content.", "required":[ "type", "video" ], "title":"KakaoChinguOutboundPremiumVideoFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextFreeFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Message text.", "maxLength":1300, "minLength":0 }, "coupon":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Coupon" }, "buttons":{ "type":"array", "description":" `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" } } } } ], "required":[ "text", "type" ], "title":"KakaoChinguOutboundTextFreeFormContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextVariableContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, { "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Brand message template code.", "maxLength":50, "minLength":0 }, "messageData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Message placeholder values. Required only if the template contains message placeholders." }, "buttonData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Buttons placeholder values. Required only if the template contains button placeholders." }, "couponData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Coupon placeholder values. Required only if the template contains coupon placeholders." } } } ], "required":[ "templateCode", "type" ], "title":"KakaoChinguOutboundTextVariableContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguRequest":{ "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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguMessage" } }, "options":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultMessageRequestOptions" } }, "required":[ "messages" ], "title":"KakaoChinguRequest" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoMessageOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultSmsFailover" }, "targeting":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoTargeting" } }, "title":"KakaoMessageOptions" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoTargeting":{ "type":"string", "default":"TARGETED_FRIENDS", "description":"Sets the target audience that will receive the message. Targeting types: `ALL_CONSENT` is for messages to marketing-opted users with opt-out notice to non-friends and direct delivery to friends; `NON_FRIENDS` is for messages exclusively to non-friends with opt-out; `TARGETED_FRIENDS` is for channel friends via phone number or list upload (without template variables for uploads).", "enum":[ "ALL_CONSENT", "NON_FRIENDS", "TARGETED_FRIENDS" ], "title":"KakaoTargeting" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogKakaoChinguOutboundContent":{ "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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice" }, "status":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus" }, "error":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageError" }, "platform":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform" }, "content":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "title":"LogKakaoChinguOutboundContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogResponseLogKakaoChinguOutboundContent":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"An array of message log results, one object per each message log entry.", "items":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogKakaoChinguOutboundContent" } }, "cursor":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CursorPageInfo" } }, "title":"LogResponseLogKakaoChinguOutboundContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LongDescriptionCoupon":{ "type":"object", "description":"Coupon for free form content with long description (18 character limit).", "properties":{ "title":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, "description":{ "type":"string", "description":"Coupon content description. Maximum length is 18 characters, minimum length is 1 character.", "maxLength":18, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPC":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeIOS":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment." } }, "required":[ "description", "title", "urlMobile" ], "title":"LongDescriptionCoupon" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.PercentageDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitleParameter":{ "type":"integer", "format":"int32", "description":"Title parameter of the selected coupon.", "maximum":100, "minimum":1 } } } ], "required":[ "couponTitleParameter", "type" ], "title":"PercentageDiscountCouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.PriceDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitleParameter":{ "type":"integer", "format":"int32", "description":"Title parameter of the selected coupon.", "maximum":99999999, "minimum":1 } } } ], "required":[ "couponTitleParameter", "type" ], "title":"PriceDiscountCouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormAddChannelButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" } ], "description":"Add channel button. This button allows users to add the channel to their KakaoTalk channel list. This button type is only available when targeting ALL_CONSENT (M) or NON_FRIENDS (N) audiences in free form messages.", "title":"RichContentFreeFormAddChannelButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormAppLinkButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "description":"2 of schemeAndroid, schemeIos, urlMobile are required.", "required":[ "name" ], "title":"RichContentFreeFormAppLinkButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormBotKeywordButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 } } } ], "required":[ "name" ], "title":"RichContentFreeFormBotKeywordButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormBusinessFormButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name. Must match the name of the registered `BUSINESS_FORM` button.", "maxLength":8, "minLength":1 }, "businessFormKey":{ "type":"string", "description":"ID of a template business form." } } } ], "required":[ "businessFormKey", "name" ], "title":"RichContentFreeFormBusinessFormButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton":{ "type":"object", "description":"`BUSINESS_FORM` button must be registered before using.", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormAppLinkButton", "URL":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormUrlButton", "BOT_KEYWORD":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormBotKeywordButton", "MESSAGE_DELIVERY":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormMessageDeliveryButton", "BUSINESS_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormBusinessFormButton", "ADD_CHANNEL":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormAddChannelButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButtonType" } }, "title":"RichContentFreeFormButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButtonTarget":{ "type":"string", "description":"Button target. Opens the URL in an external browser if set to 'OUT'.", "enum":[ "OUT" ], "title":"RichContentFreeFormButtonTarget" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButtonType":{ "type":"string", "enum":[ "APP_LINK", "URL", "BOT_KEYWORD", "MESSAGE_DELIVERY", "BUSINESS_FORM", "ADD_CHANNEL" ], "title":"RichContentFreeFormButtonType" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormMessageDeliveryButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 } } } ], "required":[ "name" ], "title":"RichContentFreeFormMessageDeliveryButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "target":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RichContentFreeFormButtonTarget" } } } ], "required":[ "name", "urlMobile" ], "title":"RichContentFreeFormUrlButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShippingDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" } ], "required":[ "type" ], "title":"ShippingDiscountCouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ShortDescriptionCoupon":{ "type":"object", "description":"Coupon for free form content with short description (12 character limit).", "properties":{ "title":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, "description":{ "type":"string", "description":"Coupon content description. Maximum length is 12 characters, minimum length is 1 character.", "maxLength":12, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`." }, "urlPC":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`." }, "schemeIOS":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment." }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment." } }, "required":[ "description", "title", "urlMobile" ], "title":"ShortDescriptionCoupon" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormAddChannelButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" } ], "description":"Add channel button. This button allows users to add the channel to their KakaoTalk channel list. This button type is only available when targeting ALL_CONSENT (M) or NON_FRIENDS (N) audiences in free form messages.", "title":"TextAndImageFreeFormAddChannelButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormAppLinkButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":14, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "description":"2 of schemeAndroid, schemeIos, urlMobile are required.", "required":[ "name" ], "title":"TextAndImageFreeFormAppLinkButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormBotKeywordButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":14, "minLength":1 } } } ], "required":[ "name" ], "title":"TextAndImageFreeFormBotKeywordButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormBusinessFormButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name. Must match the name of the registered `BUSINESS_FORM` button.", "maxLength":14, "minLength":1 }, "businessFormKey":{ "type":"string", "description":"ID of a template business form." } } } ], "required":[ "businessFormKey", "name" ], "title":"TextAndImageFreeFormBusinessFormButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton":{ "type":"object", "description":" A maximum of 5 if a coupon is not provided, 4 if provided.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormAppLinkButton", "URL":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormUrlButton", "BOT_KEYWORD":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormBotKeywordButton", "MESSAGE_DELIVERY":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormMessageDeliveryButton", "BUSINESS_FORM":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormBusinessFormButton", "ADD_CHANNEL":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormAddChannelButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButtonType" } }, "title":"TextAndImageFreeFormButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButtonTarget":{ "type":"string", "description":"Button target. Opens the URL in an external browser if set to 'OUT'.", "enum":[ "OUT" ], "title":"TextAndImageFreeFormButtonTarget" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButtonType":{ "type":"string", "enum":[ "APP_LINK", "URL", "BOT_KEYWORD", "MESSAGE_DELIVERY", "BUSINESS_FORM", "ADD_CHANNEL" ], "title":"TextAndImageFreeFormButtonType" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormMessageDeliveryButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":14, "minLength":1 } } } ], "required":[ "name" ], "title":"TextAndImageFreeFormMessageDeliveryButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":14, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "target":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TextAndImageFreeFormButtonTarget" } } } ], "required":[ "name", "urlMobile" ], "title":"TextAndImageFreeFormUrlButton" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UpCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitleParameter":{ "type":"string", "description":"Title parameter of the selected coupon.", "maxLength":7, "minLength":1 } } } ], "required":[ "couponTitleParameter", "type" ], "title":"UpCouponTitleContent" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AddChannelGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" } ], "required":[ "type" ], "title":"AddChannelGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AddChannelTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" } ], "required":[ "type" ], "title":"AddChannelTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AppLinkGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Android custom scheme when the user is using Android.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"iOS custom scheme when the user is using iOS.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "description":"2 of schemeAndroid, schemeIos, urlMobile are required.", "required":[ "name", "type" ], "title":"AppLinkGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AppLinkTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name.", "maxLength":14, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Android custom scheme when the user is using Android.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"iOS custom scheme when the user is using iOS.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "description":"2 of schemeAndroid, schemeIos, urlMobile are required.", "required":[ "name", "type" ], "title":"AppLinkTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BotKeywordGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"BotKeywordGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BotKeywordTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name.", "maxLength":14, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"BotKeywordTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent":{ "type":"object", "description":"Template content details.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextTemplate", "IMAGE":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageTemplate", "IMAGE_WIDE":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageWideTemplate", "ITEM_LIST":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ItemListTemplate" } }, "properties":{ "type":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateTypes" } }, "required":[ "type" ], "title":"BrandMessagesTemplateContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateTypes":{ "type":"string", "enum":[ "TEXT", "IMAGE", "IMAGE_WIDE", "ITEM_LIST" ], "title":"BrandMessagesTemplateTypes" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BusinessFormGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name. Must match the name of the registered `BUSINESS_FORM` button.", "maxLength":14, "minLength":1 }, "businessFormId":{ "type":"integer", "format":"int32", "description":"ID of a template business form.", "maximum":99999999 } } } ], "required":[ "businessFormId", "name", "type" ], "title":"BusinessFormGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BusinessFormTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name. Must match the name of the registered `BUSINESS_FORM` button.", "maxLength":14, "minLength":1 }, "businessFormId":{ "type":"integer", "format":"int32", "description":"ID of a template business form.", "maximum":99999999 } } } ], "required":[ "businessFormId", "name", "type" ], "title":"BusinessFormTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent":{ "type":"object", "description":"Coupon title.", "discriminator":{ "propertyName":"type", "mapping":{ "PRICE_DISCOUNT_COUPON":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.PriceDiscountCouponTitleContent", "PERCENTAGE_DISCOUNT_COUPON":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.PercentageDiscountCouponTitleContent", "SHIPPING_DISCOUNT_COUPON":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ShippingDiscountCouponTitleContent", "FREE_COUPON":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.FreeCouponTitleContent", "UP_COUPON":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UpCouponTitleContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContentType" } }, "required":[ "type" ], "title":"CouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContentType":{ "type":"string", "enum":[ "PRICE_DISCOUNT_COUPON", "PERCENTAGE_DISCOUNT_COUPON", "SHIPPING_DISCOUNT_COUPON", "FREE_COUPON", "UP_COUPON" ], "title":"CouponTitleContentType" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest":{ "type":"object", "properties":{ "sender":{ "type":"string", "description":"Must be provided if senderGroup is not provided.", "maxLength":40, "minLength":1 }, "senderGroup":{ "type":"string", "description":"Must be provided if sender is not provided.", "maxLength":40, "minLength":1 }, "name":{ "type":"string", "description":"Template name.", "maxLength":200, "minLength":1 }, "isAdult":{ "type":"boolean", "default":false, "description":"Indicates whether the recipient is an adult." }, "templateContent":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" } }, "required":[ "name", "templateContent" ], "title":"CreateTemplateRequest" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateResponse":{ "type":"object", "properties":{ "templateCode":{ "type":"string", "description":"Template code registered in system." } }, "required":[ "templateCode" ], "title":"CreateTemplateResponse" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.FreeCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitle":{ "type":"string", "description":"Title parameter of the selected coupon.", "maxLength":7, "minLength":1 } } } ], "required":[ "couponTitle", "type" ], "title":"FreeCouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton":{ "type":"object", "description":" A maximum of 2.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AppLinkGeneralButton", "URL":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UrlGeneralButton", "BOT_KEYWORD":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BotKeywordGeneralButton", "MESSAGE_DELIVERY":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MessageDeliveryGeneralButton", "ADD_CHANNEL":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AddChannelGeneralButton", "BUSINESS_FORM":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BusinessFormGeneralButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButtonType" } }, "required":[ "type" ], "title":"GeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButtonType":{ "type":"string", "enum":[ "APP_LINK", "URL", "BOT_KEYWORD", "MESSAGE_DELIVERY", "ADD_CHANNEL", "BUSINESS_FORM" ], "title":"GeneralButtonType" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralTemplateCoupon":{ "type":"object", "description":"Coupon content.", "properties":{ "title":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, "description":{ "type":"string", "description":"Coupon content description. Line breaks are not allowed.", "maxLength":12, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 } }, "required":[ "description", "title", "urlMobile" ], "title":"GeneralTemplateCoupon" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GetTemplateResponse":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Template name." }, "templateContent":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" } }, "required":[ "name", "templateContent" ], "title":"GetTemplateResponse" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.Image":{ "type":"object", "description":"Image content.", "properties":{ "url":{ "type":"string", "description":"URL of an image sent in a template registered with the image upload API.\nSupported image types are `JPG`, `PNG`.\n", "maxLength":500, "minLength":0 }, "link":{ "type":"string", "description":"URL to redirect to when clicking on the image in the template.", "maxLength":500, "minLength":0 } }, "required":[ "url" ], "title":"Image" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageTemplate":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Template text.", "maxLength":1300, "minLength":1 }, "image":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.Image" }, "buttons":{ "type":"array", "description":" A maximum of 5 if a coupon is not provided, 4 if provided.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" } }, "coupon":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralTemplateCoupon" } } } ], "required":[ "image", "text", "type" ], "title":"ImageTemplate" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageWideTemplate":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Template text.", "maxLength":76, "minLength":1 }, "image":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.Image" }, "buttons":{ "type":"array", "description":" A maximum of 2.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, "maxItems":2, "minItems":1 }, "coupon":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.WideAndVideoTemplateCoupon" } } } ], "required":[ "image", "text", "type" ], "title":"ImageWideTemplate" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ItemListTemplate":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" }, { "type":"object", "properties":{ "header":{ "type":"string", "description":"Header text. Line breaks not allowed.", "maxLength":20, "minLength":1 }, "wide":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MainItemListElement" }, "wideList":{ "type":"array", "description":"2nd–5th images in the wide image list. Aspect ratio must be 1:1.", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.SubItemListElement" }, "maxItems":4, "minItems":2 }, "buttons":{ "type":"array", "description":" A maximum of 2.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the last button used. In all other cases, the `BUSINESS_FORM` button must be used as the last button.\n", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, "maxItems":2, "minItems":1 }, "coupon":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.WideAndVideoTemplateCoupon" } } } ], "required":[ "header", "type", "wide", "wideList" ], "title":"ItemListTemplate" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MainItemListElement":{ "type":"object", "description":"First wide list image. Aspect ratio: must be 2:1", "properties":{ "title":{ "type":"string", "description":"Template list item title.", "maxLength":25, "minLength":1 }, "imageUrl":{ "type":"string", "description":"Template image URL. The image has a ratio of 1:1.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 } }, "required":[ "imageUrl", "title", "urlMobile" ], "title":"MainItemListElement" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MessageDeliveryGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"MessageDeliveryGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MessageDeliveryTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name.", "maxLength":14, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"MessageDeliveryTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ModifiedTemplateResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TemplateResult" } } }, "title":"ModifiedTemplateResponse" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.PercentageDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitle":{ "type":"integer", "format":"int32", "description":"Percentage value for the price discount coupon.", "maximum":100, "minimum":1 } } } ], "required":[ "couponTitle", "type" ], "title":"PercentageDiscountCouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.PriceDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitle":{ "type":"integer", "format":"int32", "description":"Price value for the price discount coupon.", "maximum":99999999, "minimum":1 } } } ], "required":[ "couponTitle", "type" ], "title":"PriceDiscountCouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ShippingDiscountCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" } ], "required":[ "type" ], "title":"ShippingDiscountCouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.SubItemListElement":{ "type":"object", "description":"2nd–5th images in the wide image list. Aspect ratio must be 1:1.", "properties":{ "title":{ "type":"string", "description":"Template list item title.", "maxLength":30, "minLength":1 }, "imageUrl":{ "type":"string", "description":"Template image URL. The image has a ratio of 2:1.", "maxLength":500, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 } }, "required":[ "imageUrl", "title", "urlMobile" ], "title":"SubItemListElement" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TemplateResult":{ "type":"object", "properties":{ "templateCode":{ "type":"string" } }, "required":[ "templateCode" ], "title":"TemplateResult" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton":{ "type":"object", "description":" A maximum of 5 if a coupon is not provided, 4 if provided.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "discriminator":{ "propertyName":"type", "mapping":{ "APP_LINK":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AppLinkTextAndImageButton", "URL":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UrlTextAndImageButton", "BOT_KEYWORD":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BotKeywordTextAndImageButton", "MESSAGE_DELIVERY":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.MessageDeliveryTextAndImageButton", "ADD_CHANNEL":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.AddChannelTextAndImageButton", "BUSINESS_FORM":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BusinessFormTextAndImageButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButtonType" } }, "required":[ "type" ], "title":"TextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButtonType":{ "type":"string", "enum":[ "APP_LINK", "URL", "BOT_KEYWORD", "MESSAGE_DELIVERY", "ADD_CHANNEL", "BUSINESS_FORM" ], "title":"TextAndImageButtonType" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextTemplate":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Template text.", "maxLength":1300, "minLength":1 }, "buttons":{ "type":"array", "description":" A maximum of 5 if a coupon is not provided, 4 if provided.\n `BUSINESS_FORM` button must be registered before using.\n In case of multiple buttons, if `ADD_CHANNEL` is used together with `BUSINESS_FORM`, the `ADD_CHANNEL` button must be the first button used. In all other cases, the `BUSINESS_FORM` button must be used as the first button.\n", "items":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" } }, "coupon":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralTemplateCoupon" } } } ], "required":[ "text", "type" ], "title":"TextTemplate" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UpCouponTitleContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, { "type":"object", "properties":{ "couponTitle":{ "type":"string", "description":"Title parameter of the selected coupon.", "maxLength":7, "minLength":1 } } } ], "required":[ "couponTitle", "type" ], "title":"UpCouponTitleContent" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UrlGeneralButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GeneralButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Button name.", "maxLength":8, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"UrlGeneralButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.UrlTextAndImageButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextAndImageButton" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Template button name.", "maxLength":14, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 } } } ], "required":[ "name", "type" ], "title":"UrlTextAndImageButton" }, "58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.WideAndVideoTemplateCoupon":{ "type":"object", "description":"Coupon content.", "properties":{ "title":{ "$ref":"#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CouponTitleContent" }, "description":{ "type":"string", "description":"Coupon content description. Line breaks are not allowed.", "maxLength":18, "minLength":1 }, "urlMobile":{ "type":"string", "description":"URL to redirect when a user is in a mobile environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "urlPc":{ "type":"string", "description":"URL to redirect when a user is in a PC environment. Must be a valid URL starting with `https://` or `http://`.", "maxLength":500, "minLength":1 }, "schemeIos":{ "type":"string", "description":"Custom scheme for users operating in an iOS environment.", "maxLength":500, "minLength":1 }, "schemeAndroid":{ "type":"string", "description":"Custom scheme for users operating in an Android environment.", "maxLength":500, "minLength":1 } }, "required":[ "description", "title", "urlMobile" ], "title":"WideAndVideoTemplateCoupon" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" } }, "responses":{ "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} }, "webhooks":{ "receive-outbound-kakao-alim-message-delivery-reports":{ "post":{ "tags":[ "channels", "kakao", "alim", "logs-and-status-reports-kakao-alim" ], "summary":"Receive Kakao Alim 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 Kakao Alim channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#alim-talk" }, "operationId":"receive-outbound-kakao-alim-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"2034072219640523072", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2", "to":"66855538125", "sender":"44113496000", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":"\n \n \n 2034072219640523072\n \n 0.15\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n 2250be2d4219-3af1-78856-aabe-1362af1edfd2\n 66855538125\n 44113496000\n 2023-09-26T10:52:15.457+0000\n 2023-09-26T10:52:15.799+0000\n 1\n 22801\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-outbound-kakao-sangdam-message-delivery-reports":{ "post":{ "tags":[ "channels", "kakao", "sangdam", "logs-and-status-reports-kakao-sangdam" ], "summary":"Receive Kakao Sangdam 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 Kakao Sangdam channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk" }, "operationId":"receive-outbound-kakao-sangdam-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":{ "results":[ { "bulkId":"1688025180464000013", "price":{ "pricePerMessage":0.15, "currency":"EUR" }, "status":{ "groupId":3, "groupName":"DELIVERED", "id":5, "name":"DELIVERED_TO_HANDSET", "description":"Message delivered to handset" }, "error":{ "groupId":0, "groupName":"OK", "id":0, "name":"NO_ERROR", "description":"No Error", "permanent":false }, "messageId":"1688025180464000014", "to":"66855538125", "sender":"OFFICIAL-ACCOUNT-ID-123", "sentAt":"2023-09-26T10:52:15.457+0000", "doneAt":"2023-09-26T10:52:15.799+0000", "messageCount":1, "mccMnc":"22801", "platform":{ "entityId":"promotional-traffic-entity", "applicationId":"marketing-automation-application" } } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports" }, "examples":{ "Delivery reports":{ "summary":"Delivery reports", "value":"\n \n \n 1688025180464000013\n \n 0.15\n EUR\n \n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n 1688025180464000014\n 66855538125\n OFFICIAL-ACCOUNT-ID-123\n 2023-09-26T10:52:15.457+0000\n 2023-09-26T10:52:15.799+0000\n 1\n 22801\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-kakao-sangdam-api-incoming-messages":{ "post":{ "tags":[ "channels", "kakao", "sangdam", "incoming-kakao-sangdam-message" ], "summary":"Receive incoming message", "description":"Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.", "externalDocs":{ "description":"Learn more about the Kakao Sangdam and use cases", "url":"https://www.infobip.com/docs/api/channels/kakao/sangdam" }, "operationId":"receive-kakao-sangdam-api-incoming-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundResponse" } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } }, "receive-outbound-kakao-chingu-message-delivery-reports":{ "post":{ "tags":[ "channels", "kakao", "chingu", "logs-and-status-reports-kakao-chingu" ], "summary":"Receive brand message 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 brand message channel and use cases", "url":"https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk" }, "operationId":"receive-outbound-kakao-chingu-message-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports" } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports" } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } }, "x-is-early-access":true } } } }