{
"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:51.810082311Z"
},
"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":"viber",
"description":"Viber offers businesses a dynamic duo of tools - Viber Business Messages and Viber Bots. \nThese solutions are designed to revolutionize customer engagement and communication strategies, \nproviding businesses with a direct and effective means of connecting with their audience.\n\nTo utilize Viber Business Messages and Viber Bots in combination with other channels, check out [Messages API](https://www.infobip.com/docs/api/platform/messages-api).\n",
"x-type":"product",
"x-displayName":"Viber"
},
{
"name":"viber-business-messages",
"description":"Viber Business Messages provide businesses with a structured channel to convey various messages, from promotions to vital updates. This versatile medium ensures direct interaction with customers at every stage of their journey, aiming to enrich their overall experience. Brands can send transactional, promotional, and conversational messages through a single platform, incorporating engaging elements such as images, videos, files, and URLs. Viber Business Messages are a robust tool for fostering interactive and enriching conversations with customers.",
"x-type":"module",
"x-displayName":"Business Messages"
},
{
"name":"outbound-message",
"description":"",
"x-type":"section",
"x-displayName":"Outbound message"
},
{
"name":"inbound-message",
"description":"",
"x-type":"section",
"x-displayName":"Inbound message"
},
{
"name":"message-status-reports",
"description":"",
"x-type":"section",
"x-displayName":"Message status reports"
},
{
"name":"viber-template-management",
"description":"",
"x-type":"section",
"x-displayName":"Template management"
},
{
"name":"viber_bot",
"description":"Viber Bots solution empowers businesses to automate conversations effectively, handling customer inquiries and guiding users through interactions. They help customers to offer vital information, assist in purchases, and address concerns, ultimately delivering personalized and efficient customer service. With Viber Bots at the helm, brands can provide round-the-clock customer support, leveraging their extensive features. This makes it an ideal solution for brands looking to broaden their reach and engage both new and existing customers effectively. ",
"x-type":"module",
"x-displayName":"Bots"
},
{
"name":"send-viber-bot",
"description":"",
"x-type":"section",
"x-displayName":"Outbound Message"
},
{
"name":"logs-and-status-reports-viber-bot",
"description":"",
"x-type":"section",
"x-displayName":"Logs and Status Reports"
},
{
"name":"incoming-viber-bot-message",
"description":"",
"x-type":"section",
"x-displayName":"Receive viber bot message"
}
],
"paths":{
"/viber/2/messages":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"outbound-message"
],
"summary":"Send Viber messages",
"description":"Send text, image, video or file messages to a multiple recipients.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-messages",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberRequest"
},
"examples":{
"Text message with SMS failover":{
"summary":"Text message with SMS failover",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"type":"TEXT"
},
"options":{
"smsFailover":{
"sender":"441134960000",
"text":"Some failover text"
}
}
}
]
}
},
"Text message":{
"summary":"Text message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"type":"TEXT"
}
}
]
}
},
"Text with button message":{
"summary":"Text with button message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"button":{
"title":"Button title",
"action":"https://www.example.com/action"
},
"type":"TEXT"
}
}
]
}
},
"Text message to primary device only":{
"summary":"Text message to primary device only",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"type":"TEXT"
},
"options":{
"toPrimaryDeviceOnly":true
}
}
]
}
},
"Text with button message to primary device only":{
"summary":"Text with button message to primary device only",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"button":{
"title":"Button title",
"action":"https://www.example.com/action"
},
"type":"TEXT"
},
"options":{
"toPrimaryDeviceOnly":true
}
}
]
}
},
"Image message":{
"summary":"Image message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"mediaUrl":"https://www.example.com/image.jpg",
"showImageInFullScreen":false,
"type":"IMAGE"
}
}
]
}
},
"Image with text message":{
"summary":"Image with text message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"mediaUrl":"https://www.example.com/image.jpg",
"showImageInFullScreen":false,
"type":"IMAGE"
}
}
]
}
},
"Image with text and button message":{
"summary":"Image with text and button message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"mediaUrl":"https://www.example.com/image.jpg",
"showImageInFullScreen":false,
"button":{
"title":"Button title",
"action":"https://www.example.com/action"
},
"type":"IMAGE"
}
}
]
}
},
"Video message":{
"summary":"Video message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"mediaUrl":"https://www.example.com/video.mp4",
"mediaDuration":"PT5S",
"thumbnailUrl":"https://www.example.com/video.jpg",
"type":"VIDEO"
}
}
]
}
},
"Video with text message":{
"summary":"Video with text message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"mediaUrl":"https://www.example.com/video.mp4",
"mediaDuration":"PT5S",
"thumbnailUrl":"https://www.example.com/video.jpg",
"type":"VIDEO"
}
}
]
}
},
"Video with text and action button message":{
"summary":"Video with text and action button message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"mediaUrl":"https://www.example.com/video.mp4",
"mediaDuration":"PT5S",
"thumbnailUrl":"https://www.example.com/video.jpg",
"button":{
"title":"button title",
"action":"https://www.example.com/action"
},
"type":"VIDEO"
}
}
]
}
},
"File message":{
"summary":"File message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"fileName":"file.xlsx",
"mediaUrl":"https://www.example.com/file.xlsx",
"type":"FILE"
}
}
]
}
},
"List message":{
"summary":"List message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Some text",
"options":[
"Option 1",
"Option 2",
"Option 3"
],
"type":"LIST"
}
}
]
}
},
"Template":{
"summary":"Template",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"templateId":"some template id",
"parameters":{
"pin":"123"
},
"language":"en",
"type":"TEMPLATE"
}
}
]
}
},
"Carousel message":{
"summary":"Carousel message",
"value":{
"messages":[
{
"sender":"441134960000",
"destinations":[
{
"to":"441134960001"
}
],
"content":{
"text":"Carousel text",
"cards":[
{
"text":"Card 1 text",
"mediaUrl":"https://www.example.com/card1.jpg",
"buttons":[
{
"title":"Button 1",
"action":"https://www.example.com/action1"
},
{
"title":"Button 2",
"action":"https://www.example.com/action2"
}
]
},
{
"text":"Card 2 text",
"mediaUrl":"https://www.example.com/card2.jpg",
"buttons":[
{
"title":"Button 3",
"action":"https://www.example.com/action3"
}
]
}
],
"type":"CAROUSEL"
}
}
]
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"examples":{
"Success":{
"summary":"Success",
"value":{
"bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
"messages":[
{
"messageId":"a28dd97c-1ffb-4fcf-99f1-0b557ed381da",
"status":{
"groupId":1,
"groupName":"PENDING",
"id":26,
"name":"PENDING_ACCEPTED",
"description":"Message sent to next instance"
},
"destination":"441134960001"
}
]
}
}
}
}
}
},
"400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[
{
"property":"property.path",
"violation":"Violation message."
}
],
"resources":[]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
]
}
},
"/viber/1/message/text":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"outbound-message"
],
"summary":"Send Viber text message(s)",
"description":"Send one or many text message(s) possibly to multiple recipients.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-text-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkTextMessage"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Messages accepted for delivery.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkMessageInfo"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/viber/1/message/image":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"outbound-message"
],
"summary":"Send Viber image message",
"description":"Send an image message to a single recipient.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-image-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberImageMessage"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/viber/1/message/file":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"outbound-message"
],
"summary":"Send Viber file message",
"description":"Send a file message to a single recipient.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-file-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberFileMessage"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/viber/1/message/video":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"outbound-message"
],
"summary":"Send Viber video message",
"description":"Send a video message to a single recipient.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-video-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberVideoMessage"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Message accepted for delivery.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo"
}
}
}
},
"400":{
"description":"Bad request.",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException"
},
"examples":{
"Bad request":{
"summary":"Bad request",
"value":{
"requestError":{
"serviceException":{
"messageId":"BAD_REQUEST",
"text":"Bad request"
}
}
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiException401"
},
"403":{
"$ref":"#/components/responses/ApiException403"
},
"429":{
"$ref":"#/components/responses/ApiException429"
},
"500":{
"$ref":"#/components/responses/ApiException500"
}
},
"deprecated":true,
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":2500,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/viber/2/reports":{
"get":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"message-status-reports"
],
"summary":"Get Viber 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 Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"get-outbound-viber-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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":{
"results":[
{
"bulkId":"1688025180464000013",
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
},
"status":{
"groupId":3,
"groupName":"DELIVERED",
"id":5,
"name":"DELIVERED_TO_HANDSET",
"description":"Message delivered to handset"
},
"error":{
"groupId":0,
"groupName":"OK",
"id":0,
"name":"NO_ERROR",
"description":"No Error",
"permanent":false
},
"messageId":"1688025180464000014",
"to":"a42fa0e0-1d5f-44f6-a321-0e40300f7712",
"sender":"urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=",
"sentAt":"2023-09-26T10:52:15.457+0000",
"doneAt":"2023-09-26T10:52:15.799+0000",
"messageCount":1,
"mccMnc":"22801",
"platform":{
"entityId":"promotional-traffic-entity",
"applicationId":"marketing-automation-application"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"message:send",
"viber-bm:message:send",
"viber-bm:manage"
]
}
},
"/viber/2/logs":{
"get":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"message-status-reports"
],
"summary":"Get Viber 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-viber-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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogResponseLogViberOutboundContent"
}
}
}
},
"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":[
"viber-bm:logs:read",
"viber-bm:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":120,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/viber/1/senders/{sender}/templates":{
"get":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"viber-template-management"
],
"summary":"Get Viber templates",
"description":"Retrieve Viber templates available for specific sender.",
"operationId":"get-viber-templates",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Sender id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Sender id."
}
},
{
"name":"page",
"in":"query",
"description":"Current page number.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":0,
"minimum":0
}
},
{
"name":"size",
"in":"query",
"description":"Number of items per page.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"integer",
"format":"int32",
"default":20,
"maximum":100,
"minimum":1
}
},
{
"name":"orderBy",
"in":"query",
"description":"Sorting criteria in the format `property,direction`. Can be ascending (ASC) or descending (DESC). Available properties: id, sender, channel, templateId, name, createdAt.",
"required":false,
"style":"form",
"explode":true,
"schema":{
"type":"string",
"default":"createdAt,ASC"
},
"example":"name,ASC"
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.GetViberTemplatesResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"viber-bm:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
},
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"viber-template-management"
],
"summary":"Create Viber template",
"description":"Create a new Viber template for a given sender. Templates must be approved by Viber before they can be used for sending messages.",
"operationId":"create-viber-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Sender id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Sender id."
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateRequest"
},
"examples":{
"OTP template":{
"summary":"OTP template",
"value":{
"category":"OTP",
"body":[
{
"language":"en",
"template":"Your verification code is {{pin}}. Valid for 10 minutes."
}
],
"params":[
{
"type":"TEXT",
"name":"pin",
"example":"123456"
}
]
}
},
"Transactional template":{
"summary":"Transactional template",
"value":{
"category":"TRANSACTIONAL",
"body":[
{
"language":"en",
"template":"Booking confirmation #{{bookingNumber}} for {{customerName}}. Come join us!"
}
],
"params":[
{
"type":"TEXT",
"name":"bookingNumber",
"example":"K999"
},
{
"type":"TEXT",
"name":"customerName",
"example":"Luke"
}
]
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Created",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse"
}
}
}
},
"400":{
"$ref":"#/components/responses/ApiError400"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"viber-bm:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":25,
"numberOfTimeUnits":0,
"timeUnit":"s"
}
]
}
},
"/viber/1/senders/{sender}/templates/{templateId}":{
"get":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"viber-template-management"
],
"summary":"Get Viber template",
"description":"Retrieve details of a specific Viber template by its ID and associated sender.",
"operationId":"get-viber-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Sender id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Sender id."
}
},
{
"name":"templateId",
"in":"path",
"description":"Id of existing template.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Id of existing template."
}
}
],
"responses":{
"200":{
"description":"OK",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse"
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"viber-bm:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
},
"delete":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"viber-template-management"
],
"summary":"Delete Viber template",
"description":"Delete a specific Viber template. Deleted templates can no longer be used for sending messages.",
"operationId":"delete-viber-template",
"parameters":[
{
"name":"sender",
"in":"path",
"description":"Sender id.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Sender id."
}
},
{
"name":"templateId",
"in":"path",
"description":"Id of existing template.",
"required":true,
"style":"simple",
"explode":false,
"schema":{
"type":"string",
"description":"Id of existing template."
}
}
],
"responses":{
"204":{
"description":"No Content"
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"404":{
"$ref":"#/components/responses/ApiError404"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"viber-bm:manage"
],
"x-is-early-access":true,
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":10,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/viber-bot/1/messages":{
"post":{
"tags":[
"channels",
"viber",
"viber_bot",
"send-viber-bot"
],
"summary":"Send a Viber Bot message",
"description":"Send one or more messages to multiple recipients.",
"externalDocs":{
"description":"Learn more about Viber Bot channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"send-viber-bot-message",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotRequest"
},
"examples":{
"Send a Viber Bot message":{
"summary":"Send a Viber Bot 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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"examples":{
"Viber Bot message response":{
"summary":"Viber Bot 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",
"viber-bot:message:send",
"viber-bot:manage"
]
}
},
"/viber-bot/1/logs":{
"get":{
"tags":[
"channels",
"viber",
"viber_bot",
"logs-and-status-reports-viber-bot"
],
"summary":"Get outbound Viber bot 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-viber-bot-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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogResponseLogViberBotOutboundContent"
},
"examples":{
"Logs report":{
"summary":"Logs report",
"value":{
"results":[
{
"sender":"44113496000",
"destination":"66855538125",
"bulkId":"2034072219640523072",
"messageId":"2250be2d4219-3af1-78856-aabe-1362af1edfd2",
"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":"Sent text",
"type":"TEXT"
}
}
]
}
}
}
}
}
},
"401":{
"$ref":"#/components/responses/ApiError401"
},
"403":{
"$ref":"#/components/responses/ApiError403"
},
"429":{
"$ref":"#/components/responses/ApiError429"
},
"500":{
"$ref":"#/components/responses/ApiError500"
}
},
"security":[
{
"IBSSOTokenHeader":[]
},
{
"APIKeyHeader":[]
},
{
"Basic":[]
},
{
"OAuth2":[]
}
],
"x-scopes":[
"viber-bot:logs:read",
"viber-bot:manage"
],
"x-throttling-info":[
{
"type":"time",
"numberOfRequests":120,
"numberOfTimeUnits":0,
"timeUnit":"m"
}
]
}
},
"/viber-bot/1/reports":{
"get":{
"tags":[
"channels",
"viber",
"viber_bot",
"logs-and-status-reports-viber-bot"
],
"summary":"Get Viber Bot 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 Viber Bot channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"get-outbound-viber-bot-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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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",
"viber-bot:message:send",
"viber-bot:manage"
]
}
}
},
"components":{
"schemas":{
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedWebhooksWithSeen":{
"type":"object",
"description":"Provides options for configuring message webhooks.",
"properties":{
"delivery":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedMessageDeliveryReporting"
},
"contentType":{
"type":"string",
"description":"Preferred delivery report content type, `application/json` or `application/xml`."
},
"callbackData":{
"type":"string",
"description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.",
"maxLength":4000,
"minLength":0
},
"seen":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SeenStatusReporting"
}
},
"title":"AdvancedWebhooksWithSeen"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Contact":{
"type":"object",
"properties":{
"name":{
"type":"string",
"description":" Name of the contact",
"maxLength":28,
"minLength":0
},
"phoneNumber":{
"type":"string",
"description":"Phone number of the contact",
"maxLength":18,
"minLength":0
}
},
"required":[
"name",
"phoneNumber"
],
"title":"Contact"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"DeliveryReport"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReport"
}
}
},
"title":"DeliveryReports"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryDay"
}
},
"from":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime"
},
"to":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime"
}
},
"required":[
"days"
],
"title":"DeliveryTimeWindow"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InboundMessageViberBotInboundContent":{
"type":"object",
"description":"Collection of mobile originated messages.",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"sender":{
"type":"string",
"description":"Number which sent the message."
},
"to":{
"type":"string",
"description":"Sender provided during the activation process."
},
"integrationType":{
"type":"string",
"description":"Integration type."
},
"receivedAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"keyword":{
"type":"string",
"description":"Keyword extracted from the message text."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the received message."
},
"pairedMessageId":{
"type":"string",
"description":"Message ID of paired outgoing message if matched by Infobip platform."
},
"callbackData":{
"type":"string",
"description":"Callback data sent through ‛callbackData‛ field when sending message."
},
"message":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
"price":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice"
}
},
"required":[
"integrationType",
"message",
"messageId",
"price",
"receivedAt",
"sender",
"to"
],
"title":"InboundMessageViberBotInboundContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InputFieldState":{
"type":"string",
"description":"Customize the keyboard input field",
"enum":[
"REGULAR",
"MINIMIZED",
"HIDDEN"
],
"title":"InputFieldState"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Location":{
"type":"object",
"description":"Location coordinates",
"properties":{
"latitude":{
"type":"number",
"format":"double"
},
"longitude":{
"type":"number",
"format":"double"
},
"address":{
"type":"string"
}
},
"title":"Location"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogResponseLogViberBotOutboundContent":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"An array of message log results, one object per each message log entry.",
"items":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogViberBotOutboundContent"
}
},
"cursor":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.CursorPageInfo"
}
},
"title":"LogResponseLogViberBotOutboundContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogViberBotOutboundContent":{
"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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageError"
},
"platform":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform"
},
"content":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"LogViberBotOutboundContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseDetails":{
"type":"object",
"description":"Other details of the message.",
"title":"MessageResponseDetails"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus"
},
"destination":{
"type":"string",
"description":"The destination address of the message, i.e., its recipient."
},
"details":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseDetails"
}
},
"title":"MessageResponseMessageResponseDetails"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnMessageFailoverOptions":{
"type":"object",
"description":"Message options.",
"properties":{
"platform":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform"
},
"validityPeriod":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriod"
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnSmsFailover"
}
},
"title":"NonMsisdnMessageFailoverOptions"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriod"
},
"regional":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RegionalOptions"
},
"destinationMatching":{
"type":"array",
"description":"The SMS failover destination matching.",
"items":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.FailoverDestinationPair"
}
}
},
"required":[
"text"
],
"title":"NonMsisdnSmsFailover"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RecipientType":{
"type":"string",
"description":"Recipient Type must be `TACIR` or `BIREYSEL`.",
"enum":[
"BIREYSEL",
"TACIR"
],
"title":"RecipientType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.IndiaDltOptions"
},
"turkeyIys":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.TurkeyIysOptions"
},
"southKorea":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SouthKoreaOptions"
}
},
"title":"RegionalOptions"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SendingSpeedLimit"
}
},
"title":"RequestSchedulingSettings"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseMessageResponseDetails"
}
}
},
"required":[
"messages"
],
"title":"ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SeenStatusReporting":{
"type":"object",
"description":"Provides options for configuring the seen report behavior.",
"properties":{
"url":{
"type":"string",
"description":"The URL on your call back server where a seen report will be sent."
}
},
"title":"SeenStatusReporting"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SpeedLimitTimeUnit"
}
},
"required":[
"amount"
],
"title":"SendingSpeedLimit"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RecipientType"
}
},
"required":[
"recipientType"
],
"title":"TurkeyIysOptions"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"ValidityPeriod"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriodTimeUnit":{
"type":"string",
"default":"MINUTES",
"description":"Message validity period time unit.",
"enum":[
"SECONDS",
"MINUTES",
"HOURS"
],
"title":"ValidityPeriodTimeUnit"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotActionType":{
"type":"string",
"enum":[
"REPLY",
"OPEN_URL",
"OPEN_MAP",
"LOCATION_PICKER",
"SHARE_PHONE",
"NONE"
],
"title":"ViberBotActionType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotBackgroundMediaType":{
"type":"string",
"enum":[
"IMAGE",
"GIF"
],
"title":"ViberBotBackgroundMediaType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButton":{
"type":"object",
"properties":{
"action":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonAction"
},
"columns":{
"type":"integer",
"format":"int32",
"maximum":6,
"minimum":1
},
"rows":{
"type":"integer",
"format":"int32",
"minimum":1
},
"text":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonText"
},
"background":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonBackground"
},
"media":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonMedia"
}
},
"required":[
"action"
],
"title":"ViberBotButton"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonAction":{
"type":"object",
"properties":{
"actionBody":{
"type":"string"
},
"actionType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotActionType"
},
"silent":{
"type":"boolean"
},
"openUrlSettings":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettings"
},
"openMapLocation":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenMapLocation"
}
},
"title":"ViberBotButtonAction"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonBackground":{
"type":"object",
"properties":{
"color":{
"type":"string",
"pattern":"^[#]([A-Fa-f0-9]{6})$"
},
"frame":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonBackgroundFrame"
},
"mediaUrl":{
"type":"string"
},
"mediaType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotBackgroundMediaType"
},
"mediaScaleType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMediaScaleType"
},
"gifLoop":{
"type":"boolean"
}
},
"title":"ViberBotButtonBackground"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonBackgroundFrame":{
"type":"object",
"properties":{
"borderWidth":{
"type":"integer",
"format":"int32",
"maximum":10,
"minimum":0
},
"borderColor":{
"type":"string",
"pattern":"^[#]([A-Fa-f0-9]{6})$"
},
"cornerRadius":{
"type":"integer",
"format":"int32",
"maximum":10,
"minimum":0
}
},
"title":"ViberBotButtonBackgroundFrame"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonGrid":{
"type":"object",
"description":"Grid of buttons",
"properties":{
"buttons":{
"type":"array",
"items":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButton"
},
"maxItems":2147483647,
"minItems":1
},
"buttonsGroupColumns":{
"type":"integer",
"format":"int32",
"maximum":6,
"minimum":1
},
"buttonsGroupRows":{
"type":"integer",
"format":"int32",
"minimum":1
}
},
"required":[
"buttons"
],
"title":"ViberBotButtonGrid"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonMedia":{
"type":"object",
"properties":{
"imageUrl":{
"type":"string"
},
"imageScaleType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMediaScaleType"
}
},
"title":"ViberBotButtonMedia"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonText":{
"type":"object",
"properties":{
"opacity":{
"type":"integer",
"format":"int32",
"maximum":100,
"minimum":0
},
"backgroundGradientColor":{
"type":"string",
"pattern":"^[#]([A-Fa-f0-9]{6})$"
},
"paddings":{
"type":"array",
"items":{
"type":"integer",
"format":"int32"
}
},
"text":{
"type":"string"
},
"verticalAlign":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextVerticalAlign"
},
"horizontalAlign":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextHorizontalAlign"
},
"size":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextSize"
},
"shouldFit":{
"type":"boolean"
}
},
"title":"ViberBotButtonText"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotContact":{
"type":"object",
"properties":{
"phoneNumber":{
"type":"string",
"description":"Contact’s phone number"
},
"name":{
"type":"string",
"description":"Contact’s username"
},
"avatar":{
"type":"string",
"description":"Avatar URL"
}
},
"title":"ViberBotContact"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotContactNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"contact":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotContact"
},
"text":{
"type":"string",
"description":"The message text"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotContactNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotFileNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the message file"
},
"fileName":{
"type":"string"
},
"size":{
"type":"integer",
"format":"int32",
"description":"File size in bytes"
},
"text":{
"type":"string",
"description":"The message text"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotFileNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotImageNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the message image"
},
"thumbnailUrl":{
"type":"string",
"description":"URL of a reduced size image"
},
"fileName":{
"type":"string"
},
"size":{
"type":"integer",
"format":"int32",
"description":"File size in bytes"
},
"text":{
"type":"string",
"description":"The message text"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotImageNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"MESSAGE":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundMessageContent",
"DELIVERED":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundDeliveredContent",
"SUBSCRIBED":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundSubscribedContent",
"UNSUBSCRIBED":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundUnsubscribedContent",
"CONVERSATION_STARTED":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundConversationStartedContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContentType"
}
},
"title":"ViberBotInboundContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContentType":{
"type":"string",
"enum":[
"MESSAGE",
"DELIVERED",
"SUBSCRIBED",
"UNSUBSCRIBED",
"CONVERSATION_STARTED"
],
"title":"ViberBotInboundContentType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundConversationStartedContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
{
"type":"object",
"properties":{
"timestamp":{
"type":"integer",
"format":"int64",
"description":"Time of the event that triggered the callback"
},
"messageToken":{
"type":"string",
"description":"Unique ID of the message"
},
"user":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotUser"
},
"conversationType":{
"type":"string",
"description":"The specific type of conversation_started event"
},
"context":{
"type":"string",
"description":"Any additional parameters added to the deep link used to access the conversation passed as a string"
},
"subscribed":{
"type":"boolean",
"description":"indicated whether a user is already subscribed"
}
}
}
],
"required":[
"messageToken",
"timestamp"
],
"title":"ViberBotInboundConversationStartedContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundDeliveredContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
{
"type":"object",
"properties":{
"timestamp":{
"type":"integer",
"format":"int64",
"description":"Time of the event that triggered the callback"
},
"userId":{
"type":"string",
"description":"Unique Viber user id"
},
"messageToken":{
"type":"string",
"description":"Unique ID of the message"
}
}
}
],
"required":[
"messageToken",
"timestamp",
"userId"
],
"title":"ViberBotInboundDeliveredContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundMessageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
{
"type":"object",
"properties":{
"timestamp":{
"type":"integer",
"format":"int64",
"description":"Time of the event that triggered the callback"
},
"messageToken":{
"type":"string",
"description":"Unique ID of the message"
},
"message":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
"chatHostname":{
"type":"string"
},
"sender":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotUser"
},
"silent":{
"type":"boolean"
}
}
}
],
"required":[
"messageToken",
"timestamp"
],
"title":"ViberBotInboundMessageContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundMessageType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"STICKER",
"FILE",
"CONTACT",
"LOCATION"
],
"title":"ViberBotInboundMessageType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundResponse":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of mobile originated messages.",
"items":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InboundMessageViberBotInboundContent"
}
},
"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":"ViberBotInboundResponse"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundSubscribedContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
{
"type":"object",
"properties":{
"timestamp":{
"type":"integer",
"format":"int64",
"description":"Time of the event that triggered the callback"
},
"messageToken":{
"type":"string",
"description":"Unique ID of the message"
},
"user":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotUser"
},
"chatHostname":{
"type":"string"
}
}
}
],
"required":[
"messageToken",
"timestamp",
"user"
],
"title":"ViberBotInboundSubscribedContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundUnsubscribedContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent"
},
{
"type":"object",
"properties":{
"timestamp":{
"type":"integer",
"format":"int64",
"description":"Time of the event that triggered the callback"
},
"messageToken":{
"type":"string",
"description":"Unique ID of the message"
},
"userId":{
"type":"string",
"description":"Unique Viber user id"
}
}
}
],
"required":[
"messageToken",
"timestamp",
"userId"
],
"title":"ViberBotInboundUnsubscribedContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard":{
"type":"object",
"description":"Replaces device’s native keyboard. The client will always display the last keyboard that was sent to it.",
"properties":{
"buttonGrid":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonGrid"
},
"backgroundColor":{
"type":"string",
"description":"Background color of the keyboard",
"pattern":"^[#]([A-Fa-f0-9]{6})$"
},
"keyboardDisplay":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboardDisplay"
},
"actionBarState":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InputFieldState"
}
},
"required":[
"buttonGrid"
],
"title":"ViberBotKeyboard"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboardDisplay":{
"type":"object",
"properties":{
"nativeKeyboardHeight":{
"type":"boolean",
"description":"When true - the keyboard will always be displayed with the same height as the native keyboard"
},
"percentageOfKeyboardOccupancy":{
"type":"integer",
"format":"int32",
"description":"How much percent of free screen space in chat should be taken by keyboard",
"maximum":70,
"minimum":40
}
},
"title":"ViberBotKeyboardDisplay"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotLocationNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"location":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Location"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotLocationNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMediaScaleType":{
"type":"string",
"enum":[
"CROP",
"FILL",
"FIT"
],
"title":"ViberBotMediaScaleType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessage":{
"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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ToDestination"
}
},
"content":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
"options":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnMessageFailoverOptions"
},
"webhooks":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedWebhooksWithSeen"
}
},
"required":[
"content",
"destinations",
"sender"
],
"title":"ViberBotMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessageRequestOptions":{
"type":"object",
"description":"Options applicable to all messages in the request.",
"properties":{
"schedule":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RequestSchedulingSettings"
}
},
"title":"ViberBotMessageRequestOptions"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage":{
"type":"object",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextNestedInboundMessage",
"IMAGE":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotImageNestedInboundMessage",
"VIDEO":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotVideoNestedInboundMessage",
"STICKER":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotStickerNestedInboundMessage",
"FILE":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotFileNestedInboundMessage",
"CONTACT":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotContactNestedInboundMessage",
"LOCATION":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotLocationNestedInboundMessage"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundMessageType"
}
},
"title":"ViberBotNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenMapLocation":{
"type":"object",
"description":"Location coordinates",
"properties":{
"latitude":{
"type":"number",
"format":"double",
"maximum":90,
"minimum":-90
},
"longitude":{
"type":"number",
"format":"double",
"maximum":180,
"minimum":-180
}
},
"required":[
"latitude",
"longitude"
],
"title":"ViberBotOpenMapLocation"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlMediaType":{
"type":"string",
"enum":[
"BROWSER_MEDIA",
"VIDEO",
"GIF",
"IMAGE"
],
"title":"ViberBotOpenUrlMediaType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettings":{
"type":"object",
"properties":{
"actionPredefinedUrl":{
"type":"string",
"maxLength":2147483647,
"minLength":1
},
"customTitle":{
"type":"string",
"maxLength":15,
"minLength":0
},
"mediaPlayer":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsMediaPlayer"
},
"titleType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsTitleType"
},
"actionButton":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsActionButton"
},
"browserDisplayMode":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsMode"
},
"footerType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsFooterType"
},
"actionReplyData":{
"type":"string"
},
"openUrlType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlType"
},
"openUrlMediaType":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlMediaType"
}
},
"title":"ViberBotOpenUrlSettings"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsActionButton":{
"type":"string",
"enum":[
"FORWARD",
"SEND",
"OPEN_EXTERNALLY",
"SEND_TO_BOT",
"NONE"
],
"title":"ViberBotOpenUrlSettingsActionButton"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsFooterType":{
"type":"string",
"enum":[
"DEFAULT",
"HIDDEN"
],
"title":"ViberBotOpenUrlSettingsFooterType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsMediaPlayer":{
"type":"object",
"properties":{
"thumbnailUrl":{
"type":"string"
},
"title":{
"type":"string"
},
"subtitle":{
"type":"string"
},
"loop":{
"type":"boolean"
}
},
"title":"ViberBotOpenUrlSettingsMediaPlayer"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsMode":{
"type":"string",
"enum":[
"FULLSCREEN",
"FULLSCREEN_PORTRAIT",
"FULLSCREEN_LANDSCAPE",
"PARTIAL_SIZE"
],
"title":"ViberBotOpenUrlSettingsMode"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlSettingsTitleType":{
"type":"string",
"enum":[
"DOMAIN",
"DEFAULT"
],
"title":"ViberBotOpenUrlSettingsTitleType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenUrlType":{
"type":"string",
"enum":[
"INTERNAL",
"EXTERNAL"
],
"title":"ViberBotOpenUrlType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundCarouselContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"buttonGrid":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotButtonGrid"
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"heightScale":{
"type":"integer",
"format":"int32",
"maximum":100,
"minimum":20
},
"backgroundColor":{
"type":"string",
"pattern":"^[#]([A-Fa-f0-9]{6})$"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"buttonGrid"
],
"title":"ViberBotOutboundCarouselContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContactContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"contact":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Contact"
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"contact"
],
"title":"ViberBotOutboundContactContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundTextContent",
"IMAGE":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundImageContent",
"VIDEO":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundVideoContent",
"FILE":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundFileContent",
"CAROUSEL":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundCarouselContent",
"LOCATION":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundLocationContent",
"CONTACT":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContactContent",
"STICKER":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundStickerContent",
"URL":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundUrlContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContentType"
}
},
"title":"ViberBotOutboundContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"FILE",
"CAROUSEL",
"LOCATION",
"CONTACT",
"STICKER",
"URL"
],
"title":"ViberBotOutboundContentType"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundFileContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"fileName":{
"type":"string",
"description":"Name of the file",
"maxLength":256,
"minLength":0
},
"url":{
"type":"string",
"description":"URL of the file"
},
"size":{
"type":"integer",
"format":"int32",
"description":"Size of the file in bytes",
"maximum":52428800
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"fileName",
"size",
"url"
],
"title":"ViberBotOutboundFileContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundImageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the image (JPEG, PNG, non-animated GIF)"
},
"text":{
"type":"string",
"description":"Description of the photo",
"maxLength":768,
"minLength":0
},
"thumbnailUrl":{
"type":"string",
"description":"URL of a reduced size image"
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"url"
],
"title":"ViberBotOutboundImageContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundLocationContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"location":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOpenMapLocation"
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"location"
],
"title":"ViberBotOutboundLocationContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundStickerContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"stickerId":{
"type":"integer",
"format":"int64",
"description":"Unique Viber sticker ID"
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"stickerId"
],
"title":"ViberBotOutboundStickerContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundTextContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Message text",
"maxLength":4000,
"minLength":0
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"text"
],
"title":"ViberBotOutboundTextContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundUrlContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"maxLength":2000,
"minLength":0
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"url"
],
"title":"ViberBotOutboundUrlContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundVideoContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the video (MP4, H264)"
},
"text":{
"type":"string",
"maxLength":768,
"minLength":0
},
"thumbnailUrl":{
"type":"string",
"description":"URL of a reduced size image"
},
"size":{
"type":"integer",
"format":"int32",
"description":"Size of the video in bytes",
"maximum":27262976
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Video duration in seconds; will be displayed to the receiver",
"maximum":180
},
"senderDisplayInfo":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo"
},
"keyboard":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotKeyboard"
}
}
}
],
"required":[
"size",
"url"
],
"title":"ViberBotOutboundVideoContent"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotRequest":{
"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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessage"
}
},
"options":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessageRequestOptions"
}
},
"required":[
"messages"
],
"title":"ViberBotRequest"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotSenderDisplayInfo":{
"type":"object",
"description":"Information about the sender",
"properties":{
"name":{
"type":"string",
"description":"The sender’s name to display",
"maxLength":28,
"minLength":0
},
"avatarUrl":{
"type":"string",
"description":"The sender’s avatar URL"
}
},
"title":"ViberBotSenderDisplayInfo"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotStickerNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Viber sticker id"
},
"url":{
"type":"string"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotStickerNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextHorizontalAlign":{
"type":"string",
"enum":[
"LEFT",
"CENTER",
"RIGHT"
],
"title":"ViberBotTextHorizontalAlign"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"The message text"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotTextNestedInboundMessage"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextSize":{
"type":"string",
"enum":[
"SMALL",
"REGULAR",
"LARGE"
],
"title":"ViberBotTextSize"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotTextVerticalAlign":{
"type":"string",
"enum":[
"TOP",
"MIDDLE",
"BOTTOM"
],
"title":"ViberBotTextVerticalAlign"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotUser":{
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"Unique Viber user id"
},
"name":{
"type":"string",
"description":"User’s Viber name"
},
"avatar":{
"type":"string",
"description":"URL of user’s avatar"
},
"language":{
"type":"string",
"description":"User’s phone language. Will be returned according to the device language"
},
"country":{
"type":"string",
"description":"User’s 2 letter country code"
},
"apiVersion":{
"type":"string",
"description":"The maximal Viber version that is supported by all of the user’s devices"
}
},
"title":"ViberBotUser"
},
"14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotVideoNestedInboundMessage":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotNestedInboundMessage"
},
{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of the message video"
},
"duration":{
"type":"integer",
"format":"int32",
"description":"Video length in seconds"
},
"thumbnailUrl":{
"type":"string",
"description":"URL of a reduced size image"
},
"fileName":{
"type":"string"
},
"size":{
"type":"integer",
"format":"int32",
"description":"File size in bytes"
},
"description":{
"type":"string"
},
"trackingData":{
"type":"string",
"description":"Tracking data sent with the last message to the user"
}
}
}
],
"title":"ViberBotVideoNestedInboundMessage"
},
"255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedWebhooksWithSeen":{
"type":"object",
"description":"Provides options for configuring message webhooks.",
"properties":{
"delivery":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedMessageDeliveryReporting"
},
"contentType":{
"type":"string",
"description":"Preferred delivery report content type, `application/json` or `application/xml`."
},
"callbackData":{
"type":"string",
"description":"Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.",
"maxLength":4000,
"minLength":0
},
"seen":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenStatusReporting"
}
},
"title":"AdvancedWebhooksWithSeen"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkMessageInfo":{
"type":"object",
"properties":{
"messages":{
"type":"array",
"description":"Array of sent message objects, one object per every message.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo"
}
},
"bulkId":{
"type":"string",
"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.",
"example":"2034072219640523073"
}
},
"title":"BulkMessageInfo"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkTextMessage":{
"type":"object",
"properties":{
"messages":{
"type":"array",
"description":"An array of messages being sent.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTextMessage"
}
},
"bulkId":{
"type":"string",
"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.",
"maxLength":100,
"minLength":0
}
},
"required":[
"messages"
],
"title":"BulkTextMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction":{
"type":"object",
"description":"Button with action.",
"properties":{
"title":{
"type":"string",
"description":"The text that will appear on the action button.",
"maxLength":30,
"minLength":1
},
"action":{
"type":"string",
"description":"The URL users are directed to or the action performed when pressing the action button.",
"maxLength":1000,
"minLength":0
}
},
"required":[
"action",
"title"
],
"title":"ButtonWithAction"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithOptionalAction":{
"type":"object",
"description":"Button with optional action. Cannot be combined with `buttonTitle`.",
"properties":{
"title":{
"type":"string",
"description":"The text that will appear on the action button.",
"maxLength":30,
"minLength":1
},
"action":{
"type":"string",
"description":"The URL users are directed to or the action performed when pressing the action button.",
"maxLength":1000,
"minLength":0
}
},
"required":[
"title"
],
"title":"ButtonWithOptionalAction"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultMessageRequestOptions":{
"type":"object",
"description":"Options applicable to all messages in the request.",
"properties":{
"schedule":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RequestSchedulingSettings"
},
"tracking":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions"
}
},
"title":"DefaultMessageRequestOptions"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriod"
},
"regional":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RegionalOptions"
}
},
"required":[
"text"
],
"title":"DefaultSmsFailover"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"DeliveryReport"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReport"
}
}
},
"title":"DeliveryReports"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryDay"
}
},
"from":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime"
},
"to":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime"
}
},
"required":[
"days"
],
"title":"DeliveryTimeWindow"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.FileContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"filename":{
"type":"string",
"description":"Name of the file being sent (file extension included).",
"maxLength":25,
"minLength":0,
"pattern":".*\\.(docx?|dotx?|xlsx?|f?ods|f?odt|rtf|odf|txt|info|pdf|xps|pdax|eps|csv|xlsm|xltx)$"
},
"mediaUrl":{
"type":"string",
"description":"URL of the file being sent. Must be a valid URL starting with https:// or http://. Supported file types are .doc, .docx, .rtf, .dot, .dotx, .odt ,.odf, .fodt, .txt, .info, .pdf, .xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx. Maximum file size is 200 MB. "
}
},
"required":[
"filename",
"mediaUrl"
],
"title":"FileContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ImageContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the image. It is required when sending a message with a button and an image.",
"maxLength":1000,
"minLength":1
},
"mediaUrl":{
"type":"string",
"description":"URL of the image being sent. Must be a valid URL starting with https:// or http://. Supported image types are .jpg, .jpeg, .png.Recommended resolution: 800 px x 800 px."
},
"button":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction"
}
},
"required":[
"mediaUrl"
],
"title":"ImageContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.InboundMessageViberInboundMessageContent":{
"type":"object",
"description":"Collection of mobile originated messages.",
"properties":{
"entityId":{
"type":"string",
"description":"Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"applicationId":{
"type":"string",
"description":"Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0
},
"sender":{
"type":"string",
"description":"Number which sent the message."
},
"to":{
"type":"string",
"description":"Sender provided during the activation process."
},
"integrationType":{
"type":"string",
"description":"Integration type."
},
"receivedAt":{
"type":"string",
"format":"date-time",
"description":"Date and time when Infobip received the message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ."
},
"keyword":{
"type":"string",
"description":"Keyword extracted from the message text."
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the received message."
},
"pairedMessageId":{
"type":"string",
"description":"Message ID of paired outgoing message if matched by Infobip platform."
},
"callbackData":{
"type":"string",
"description":"Callback data sent through ‛callbackData‛ field when sending message."
},
"message":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContent"
},
"price":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice"
}
},
"required":[
"integrationType",
"message",
"messageId",
"price",
"receivedAt",
"sender",
"to"
],
"title":"InboundMessageViberInboundMessageContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label":{
"type":"string",
"description":"Indicates character of the content.",
"enum":[
"PROMOTIONAL",
"TRANSACTIONAL"
],
"title":"Label"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogResponseLogViberOutboundContent":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"An array of message log results, one object per each message log entry.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogViberOutboundContent"
}
},
"cursor":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.CursorPageInfo"
}
},
"title":"LogResponseLogViberOutboundContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogViberOutboundContent":{
"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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice"
},
"status":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus"
},
"error":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageError"
},
"platform":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform"
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"LogViberOutboundContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseDetails":{
"type":"object",
"description":"Other details of the message.",
"title":"MessageResponseDetails"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus"
},
"destination":{
"type":"string",
"description":"The destination address of the message, i.e., its recipient."
},
"details":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseDetails"
}
},
"title":"MessageResponseMessageResponseDetails"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RecipientType":{
"type":"string",
"description":"Recipient Type must be `TACIR` or `BIREYSEL`.",
"enum":[
"BIREYSEL",
"TACIR"
],
"title":"RecipientType"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.IndiaDltOptions"
},
"turkeyIys":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TurkeyIysOptions"
},
"southKorea":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SouthKoreaOptions"
}
},
"title":"RegionalOptions"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SendingSpeedLimit"
}
},
"title":"RequestSchedulingSettings"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseMessageResponseDetails"
}
}
},
"required":[
"messages"
],
"title":"ResponseEnvelopeMessageResponseMessageResponseDetails"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReport":{
"type":"object",
"description":"Collection of reports, one per every message.",
"properties":{
"messageId":{
"type":"string",
"description":"The ID of the sent message."
},
"from":{
"type":"string",
"description":"Number which sent the message."
},
"to":{
"type":"string",
"description":"Sender provided during the activation process."
},
"sentAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the message was sent."
},
"seenAt":{
"type":"string",
"format":"date-time",
"description":"Tells when the message was seen."
},
"applicationId":{
"type":"string",
"description":"Application id that the message is linked to."
},
"entityId":{
"type":"string",
"description":"Entity id that the message is linked to."
},
"campaignReferenceId":{
"type":"string",
"description":"ID of a campaign that was sent in the message."
}
},
"title":"SeenReport"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReports":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of reports, one per every message.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReport"
}
}
},
"title":"SeenReports"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenStatusReporting":{
"type":"object",
"description":"Provides options for configuring the seen report behavior.",
"properties":{
"url":{
"type":"string",
"description":"The URL on your call back server where a seen report will be sent."
}
},
"title":"SeenStatusReporting"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SpeedLimitTimeUnit"
}
},
"required":[
"amount"
],
"title":"SendingSpeedLimit"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo":{
"type":"object",
"properties":{
"to":{
"type":"string",
"description":"The destination address of the message.",
"example":"385977666618"
},
"messageCount":{
"type":"integer",
"format":"int32",
"description":"Number of messages required to deliver.",
"example":1
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.",
"example":"06df139a-7eb5-4a6e-902e-40e892210455"
},
"status":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageStatus"
}
},
"title":"SingleMessageInfo"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageStatus":{
"type":"object",
"description":"Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.",
"properties":{
"groupId":{
"type":"integer",
"format":"int32",
"description":"Status group ID.",
"example":1
},
"groupName":{
"type":"string",
"description":"Status group name.",
"example":"PENDING"
},
"id":{
"type":"integer",
"format":"int32",
"description":"Status ID.",
"example":7
},
"name":{
"type":"string",
"description":"Status name.",
"example":"PENDING_ENROUTE"
},
"description":{
"type":"string",
"description":"Human-readable description of the status.",
"example":"Message sent to next instance"
},
"action":{
"type":"string",
"description":"Action that should be taken to eliminate the error."
}
},
"title":"SingleMessageStatus"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover":{
"type":"object",
"description":"SMS message to be sent if the Viber message could not be delivered.",
"properties":{
"from":{
"type":"string",
"description":"SMS sender number. Must be in international format.",
"maxLength":24,
"minLength":1
},
"text":{
"type":"string",
"description":"Content of the SMS that will be sent.",
"maxLength":4096,
"minLength":1
},
"validityPeriod":{
"type":"integer",
"format":"int32",
"description":"Message failover validity period. Required, if 'validityPeriodTimeUnit' is set. Validity period must be between 30 seconds and 2 days.",
"example":15
},
"validityPeriodTimeUnit":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit"
}
},
"required":[
"from",
"text"
],
"title":"SmsFailover"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody":{
"type":"object",
"description":"Template body containing the actual message text for a specific language.",
"properties":{
"language":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateLang"
},
"template":{
"type":"string",
"description":"Template message text with optional placeholders for variables (e.g., {{1}}, {{2}}). Maximum 1000 characters. Last word in the template text cannot be a placeholder.",
"example":"Your order {{orderId}} has been confirmed.",
"maxLength":1000,
"minLength":1
}
},
"required":[
"language",
"template"
],
"title":"TemplateBody"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory":{
"type":"string",
"description":"Business category of the template, used for classification and approval routing.",
"enum":[
"OTP",
"TRANSACTIONAL"
],
"example":"TRANSACTIONAL",
"title":"TemplateCategory"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateLang":{
"type":"string",
"description":"Language code for the template body.",
"enum":[
"ar",
"hy",
"be",
"bs",
"bg",
"my",
"hr",
"cs",
"da",
"nl",
"en",
"fi",
"fr",
"ka",
"de",
"el",
"he",
"hu",
"id",
"it",
"ja",
"ne",
"no",
"fa",
"pl",
"ro",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"th",
"tr",
"uk",
"vi",
"zh-Hans",
"zh-Hant",
"pt_BR",
"pt_PT",
"fr_FR",
"es_ES"
],
"example":"en",
"title":"TemplateLang"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam":{
"type":"object",
"description":"Variable parameter definition for template placeholders.",
"maxLength":8,
"properties":{
"type":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParamType"
},
"name":{
"type":"string",
"description":"Name or identifier of the parameter, used to reference it in the template. Must have the same name as the placeholder in the template content.",
"example":"orderId",
"maxLength":50,
"minLength":0
},
"example":{
"type":"string",
"description":"Example value for the parameter, used for template preview and validation.",
"example":"ORD-12345",
"maxLength":125,
"minLength":0
}
},
"required":[
"example",
"name",
"type"
],
"title":"TemplateParam"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParamType":{
"type":"string",
"description":"Type of template parameter.",
"enum":[
"TEXT"
],
"example":"TEXT",
"title":"TemplateParamType"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateRequest":{
"type":"object",
"description":"Request to create or register a new Viber message template.",
"properties":{
"category":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory"
},
"body":{
"type":"array",
"description":"List of template bodies per language. Currently limited to one body per template.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody"
},
"maxItems":1,
"minItems":0
},
"params":{
"type":"array",
"description":"List of variable parameters used in the template. Maximum 8 parameters allowed. For OTP category, at least one parameter with name '{{pin}}' is required.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam"
},
"maxItems":8,
"maxLength":8,
"minItems":0
}
},
"required":[
"body",
"category"
],
"title":"TemplateRequest"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateStatus":{
"type":"string",
"description":"Current approval status of the template in the review process.",
"enum":[
"PENDING",
"APPROVED",
"DECLINED"
],
"example":"APPROVED",
"title":"TemplateStatus"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TextContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"text":{
"type":"string",
"description":"Content of the message being sent.",
"maxLength":1000,
"minLength":1
},
"button":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction"
}
},
"required":[
"text"
],
"title":"TextContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RecipientType"
}
},
"required":[
"recipientType"
],
"title":"TurkeyIysOptions"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit"
}
},
"required":[
"amount"
],
"title":"ValidityPeriod"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit":{
"type":"string",
"default":"MINUTES",
"description":"Message validity period time unit.",
"enum":[
"SECONDS",
"MINUTES",
"HOURS"
],
"title":"ValidityPeriodTimeUnit"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberCarouselButton":{
"type":"object",
"description":"List of buttons that will be sent in card.",
"properties":{
"title":{
"type":"string",
"description":"The text that will appear on the action button. For first button maximum allowed length is 10 characters, for second 12."
},
"action":{
"type":"string",
"description":"The URL users are directed to or the action performed when pressing the action button.",
"maxLength":1000,
"minLength":0
}
},
"required":[
"action",
"title"
],
"title":"ViberCarouselButton"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberCarouselCard":{
"type":"object",
"description":"An array of cards contained within the carousel.",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the card.",
"maxLength":38,
"minLength":2
},
"mediaUrl":{
"type":"string",
"description":"URL of the image being sent. Must be a valid URL starting with https:// or http://. Supported image types are .jpg, .jpeg, .png. Recommended resolution: 696 px x 600 px.",
"maxLength":1000,
"minLength":0
},
"buttons":{
"type":"array",
"description":"List of buttons that will be sent in card.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberCarouselButton"
},
"maxItems":2,
"minItems":0
}
},
"required":[
"mediaUrl",
"text"
],
"title":"ViberCarouselCard"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberFileMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered Viber Sender name.",
"maxLength":20,
"minLength":2
},
"to":{
"type":"string",
"description":"Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).",
"pattern":"^[0-9]{1,15}$"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":50,
"minLength":1
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.FileContent"
},
"callbackData":{
"type":"string",
"description":"Custom client's data that will be included in Delivery Report.",
"maxLength":4000,
"minLength":1
},
"trackingData":{
"type":"string",
"description":"Custom client's data that will be passed back with user's reply.",
"maxLength":100,
"minLength":1
},
"applySessionRate":{
"type":"boolean",
"description":"Defines if the message should be charged using Viber's session rate if applicable."
},
"label":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label"
},
"smsFailover":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover"
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
}
},
"required":[
"content",
"from",
"to"
],
"title":"ViberFileMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberImageMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered Viber Sender name.",
"maxLength":20,
"minLength":2
},
"to":{
"type":"string",
"description":"Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).",
"pattern":"^[0-9]{1,15}$"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":50,
"minLength":1
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ImageContent"
},
"callbackData":{
"type":"string",
"description":"Custom client's data that will be included in Delivery Report.",
"maxLength":4000,
"minLength":1
},
"trackingData":{
"type":"string",
"description":"Custom client's data that will be passed back with user's reply.",
"maxLength":100,
"minLength":1
},
"applySessionRate":{
"type":"boolean",
"description":"Defines if the message should be charged using Viber's session rate if applicable."
},
"label":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label"
},
"smsFailover":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover"
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
}
},
"required":[
"content",
"from",
"to"
],
"title":"ViberImageMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundFileContent":{
"type":"object",
"properties":{
"url":{
"type":"string",
"description":"URL of received file."
},
"fileName":{
"type":"string",
"description":"Name of received file."
},
"trackingData":{
"type":"string",
"description":"Viber's tracking data from outgoing message that end user replies to. Might be random string of characters if not set explicitly in outgoing message."
},
"text":{
"type":"string",
"description":"Description of received file."
},
"type":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType"
}
},
"required":[
"type"
],
"title":"ViberInboundFileContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundTextContent",
"FILE":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundFileContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType"
}
},
"required":[
"type"
],
"title":"ViberInboundMessageContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType":{
"type":"string",
"enum":[
"TEXT",
"FILE"
],
"title":"ViberInboundMessageContentType"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessages":{
"type":"object",
"properties":{
"results":{
"type":"array",
"description":"Collection of mobile originated messages.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.InboundMessageViberInboundMessageContent"
}
},
"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":"ViberInboundMessages"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundTextContent":{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text of received message."
},
"trackingData":{
"type":"string",
"description":"Viber's tracking data from outgoing message that end user replies to. Might be random string of characters if not set explicitly in outgoing message."
},
"type":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType"
}
},
"required":[
"text",
"type"
],
"title":"ViberInboundTextContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessage":{
"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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ToDestination"
}
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
"options":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessageOptions"
},
"webhooks":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedWebhooksWithSeen"
}
},
"required":[
"content",
"destinations",
"sender"
],
"title":"ViberMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessageOptions":{
"type":"object",
"description":"Message options.",
"properties":{
"platform":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform"
},
"validityPeriod":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriod"
},
"deliveryTimeWindow":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultSmsFailover"
},
"trackingData":{
"type":"string",
"description":"Custom client's data that will be passed back with user's reply. It is not supported for `TEMPLATE` or when `toPrimaryDeviceOnly` option is enabled for text only and image only content types or when `activationCheck` option is enabled for text only content type.",
"maxLength":100,
"minLength":1
},
"label":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label"
},
"applySessionRate":{
"type":"boolean",
"description":"Defines if the message should be charged using Viber's session rate if applicable. The session rate is supported for text only, image only and `FILE` content types. For text only content type `sessionRate` won't be applied when `toPrimaryDeviceOnly` or `activationCheck` option is enabled. For image only content type `sessionRate` won't be applied when `toPrimaryDeviceOnly` option is enabled."
},
"toPrimaryDeviceOnly":{
"type":"boolean",
"description":"Defines if the message should be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet). Primary device concept is supported for text only, image only, `FILE` content type. For text only `toPrimaryDeviceOnly` won't be applied when `activationCheck` option is enabled."
},
"activationCheck":{
"type":"boolean",
"description":"Enables activation check for sensitive messages. When true, validates that the user has not recently activated Viber on any device. If validation passes message will be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet). Supported for text only content type. This feature must be enabled for the sender beforehand. Please contact support to arrange activation."
}
},
"title":"ViberMessageOptions"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundCarouselContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the carousel.",
"maxLength":1000,
"minLength":0
},
"cards":{
"type":"array",
"description":"An array of cards contained within the carousel.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberCarouselCard"
},
"maxItems":5,
"minItems":2
}
}
}
],
"required":[
"cards",
"text",
"type"
],
"title":"ViberOutboundCarouselContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent":{
"type":"object",
"description":"Message content.",
"discriminator":{
"propertyName":"type",
"mapping":{
"TEXT":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTextContent",
"IMAGE":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundImageContent",
"TEMPLATE":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTransactionalTemplateContent",
"FILE":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundFileContent",
"VIDEO":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundVideoContent",
"LIST":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundListContent",
"CAROUSEL":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundCarouselContent"
}
},
"properties":{
"type":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContentType"
}
},
"required":[
"type"
],
"title":"ViberOutboundContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContentType":{
"type":"string",
"enum":[
"TEXT",
"IMAGE",
"VIDEO",
"FILE",
"LIST",
"CAROUSEL",
"TEMPLATE"
],
"title":"ViberOutboundContentType"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundFileContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"fileName":{
"type":"string",
"description":"Name of the file being sent (file extension included).",
"pattern":".*\\.(docx?|dotx?|xlsx?|f?ods|f?odt|rtf|odf|txt|info|pdf|xps|pdax|eps|csv|xlsm|xltx)$"
},
"mediaUrl":{
"type":"string",
"description":"URL of the file being sent. Must be a valid URL starting with https:// or http://. Supported file types are .doc, .docx, .rtf, .dot, .dotx, .odt ,.odf, .fodt, .txt, .info, .pdf, .xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx. Maximum file size is 200 MB. ",
"pattern":"^(https?)://.*$"
}
}
}
],
"required":[
"fileName",
"mediaUrl",
"type"
],
"title":"ViberOutboundFileContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundImageContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the image. It is required when sending a message with a button and an image.",
"maxLength":1000,
"minLength":1
},
"mediaUrl":{
"type":"string",
"description":"URL of the image being sent. Must be a valid URL starting with https:// or http://. Supported image types are .jpg, .jpeg, .png. Recommended resolution: 800 px x 800 px.",
"maxLength":1000,
"minLength":0
},
"showImageInFullScreen":{
"type":"boolean",
"default":false,
"description":"Indicates whether the image is expandable. if set to `true`, the image opens in fullscreen, if set to `false`, tapping the image follows the button's URL."
},
"button":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction"
}
}
}
],
"required":[
"mediaUrl",
"type"
],
"title":"ViberOutboundImageContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundListContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the options.",
"maxLength":85,
"minLength":0
},
"options":{
"type":"array",
"description":"List of possible options.",
"items":{
"type":"string",
"description":"List of possible options.",
"maxLength":50,
"minLength":0
},
"maxItems":5,
"minItems":2
}
}
}
],
"required":[
"options",
"text",
"type"
],
"title":"ViberOutboundListContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTextContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Content of the message being sent. If sending a template, see the [guidance and compliance rules](https://www.infobip.com/docs/viber/business-messages/api#message-template-business-messages-api).",
"maxLength":1000,
"minLength":0
},
"button":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction"
}
}
}
],
"required":[
"text",
"type"
],
"title":"ViberOutboundTextContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTransactionalTemplateContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"templateId":{
"type":"string",
"description":"Predefined code of a template to be sent."
},
"parameters":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"A range of variables which are specific per template. Omit it if template doesn't have parameters."
},
"language":{
"type":"string",
"description":"Template language. Must match the 'lang' parameter from template creation. If not specified (OTP templates only), defaults to device language."
}
}
}
],
"required":[
"language",
"templateId",
"type"
],
"title":"ViberOutboundTransactionalTemplateContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundVideoContent":{
"type":"object",
"allOf":[
{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent"
},
{
"type":"object",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the video.",
"maxLength":1000,
"minLength":1
},
"mediaUrl":{
"type":"string",
"description":"URL of the video being sent. Must be a valid URL starting with https:// or http://. The resource must allow HEAD request with 'Content-Length' header. Supported video types are .3gp, .m4v, .mov, .mp4. Maximum video size is 200 MB.",
"maxLength":1000,
"minLength":0
},
"mediaDuration":{
"type":"string",
"format":"duration",
"description":"How long is the video. It has to be in [ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601#Durations)."
},
"thumbnailUrl":{
"type":"string",
"description":"URL of the thumbnail being sent. Must be a valid URL starting with https:// or http://. Supported thumbnail types are .jpg, .jpeg, .png. Recommended resolution: 800 px x 800 px.",
"maxLength":1000,
"minLength":0
},
"buttonTitle":{
"type":"string",
"deprecated":true,
"description":"Button title.",
"maxLength":30,
"minLength":1
},
"button":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithOptionalAction"
}
}
}
],
"required":[
"mediaDuration",
"mediaUrl",
"thumbnailUrl",
"type"
],
"title":"ViberOutboundVideoContent"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberRequest":{
"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/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessage"
}
},
"options":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultMessageRequestOptions"
}
},
"required":[
"messages"
],
"title":"ViberRequest"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse":{
"type":"object",
"description":"Viber message template response containing template details and current status.",
"properties":{
"templateId":{
"type":"string",
"description":"Unique identifier of the template.",
"example":"00000000-0000-0000-0000-000000000000"
},
"version":{
"type":"string",
"description":"Template version number.",
"example":"1"
},
"sender":{
"type":"string",
"description":"Sender for which the template is registered.",
"example":"CompanyName"
},
"createdAt":{
"type":"integer",
"format":"int64",
"description":"Unix timestamp in milliseconds when the template was created.",
"example":1677628800000
},
"category":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory"
},
"status":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateStatus"
},
"lastModified":{
"type":"integer",
"format":"int64",
"description":"Unix timestamp in milliseconds when the template was last modified.",
"example":1677628800000
},
"params":{
"type":"array",
"description":"List of variable parameters defined in the template.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam"
}
},
"body":{
"type":"array",
"description":"List of template bodies per language containing the actual message text.",
"items":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody"
}
}
},
"title":"ViberTemplateResponse"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTextMessage":{
"type":"object",
"description":"An array of messages being sent.",
"properties":{
"from":{
"type":"string",
"description":"Registered Viber Sender name.",
"maxLength":20,
"minLength":2
},
"to":{
"type":"string",
"description":"Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).",
"pattern":"^[0-9]{1,15}$"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":50,
"minLength":1
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TextContent"
},
"callbackData":{
"type":"string",
"description":"Custom client's data that will be included in Delivery Report.",
"maxLength":4000,
"minLength":1
},
"trackingData":{
"type":"string",
"description":"Custom client's data that will be passed back with user's reply.",
"maxLength":100,
"minLength":1
},
"applySessionRate":{
"type":"boolean",
"description":"Defines if the message should be charged using Viber's session rate if applicable. The session rate is not supported for text messages with buttons."
},
"toPrimaryDeviceOnly":{
"type":"boolean",
"description":"Defines if the message should be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet)."
},
"label":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label"
},
"smsFailover":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover"
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
}
},
"required":[
"content",
"from",
"to"
],
"title":"ViberTextMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberVideoMessage":{
"type":"object",
"properties":{
"from":{
"type":"string",
"description":"Registered Viber Sender name.",
"maxLength":20,
"minLength":2
},
"to":{
"type":"string",
"description":"Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).",
"pattern":"^[0-9]{1,15}$"
},
"messageId":{
"type":"string",
"description":"The ID that uniquely identifies the message sent.",
"maxLength":50,
"minLength":1
},
"content":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.VideoContent"
},
"callbackData":{
"type":"string",
"description":"Custom client's data that will be included in Delivery Report.",
"maxLength":4000,
"minLength":1
},
"trackingData":{
"type":"string",
"description":"Custom client's data that will be passed back with user's reply.",
"maxLength":100,
"minLength":1
},
"smsFailover":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover"
},
"notifyUrl":{
"type":"string",
"description":"The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).",
"maxLength":2048,
"minLength":0
},
"urlOptions":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions"
},
"entityId":{
"type":"string",
"description":"Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
},
"applicationId":{
"type":"string",
"description":"Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).",
"maxLength":255,
"minLength":0,
"writeOnly":true
}
},
"required":[
"content",
"from",
"to"
],
"title":"ViberVideoMessage"
},
"9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.VideoContent":{
"type":"object",
"description":"The content object to build a message that will be sent.",
"properties":{
"text":{
"type":"string",
"description":"Text to be displayed alongside the video.",
"maxLength":1000,
"minLength":1
},
"mediaUrl":{
"type":"string",
"description":"URL of the video being sent. Must be a valid URL starting with https:// or http://. The resource must allow HEAD request with 'Content-Length' header. Supported video types are .3gp, .m4v, .mov, .mp4. Maximum video size is 200 MB.",
"maxLength":1000,
"minLength":0
},
"thumbnailUrl":{
"type":"string",
"description":"URL of the thumbnail being sent. Must be a valid URL starting with https:// or http://. Supported thumbnail types are .jpg, .jpeg, .png.Recommended resolution: 800 px x 800 px."
},
"mediaDuration":{
"type":"integer",
"format":"int32",
"description":"How long is the video. Maximum video duration is 600s.",
"maximum":600,
"minimum":1
},
"buttonTitle":{
"type":"string",
"description":"Button text.",
"maxLength":30,
"minLength":1
}
},
"required":[
"mediaDuration",
"mediaUrl",
"thumbnailUrl"
],
"title":"VideoContent"
},
"ApiError":{
"type":"object",
"properties":{
"errorCode":{
"type":"string",
"description":"An error code uniquely identifying the error case."
},
"description":{
"type":"string",
"description":"A detailed description of an error."
},
"action":{
"type":"string",
"description":"An action that should be taken to recover from the error."
},
"violations":{
"type":"array",
"description":"List of violations that caused the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorViolation"
}
},
"resources":{
"type":"array",
"description":"List of available resources to recover from the error.",
"items":{
"$ref":"#/components/schemas/ApiErrorResource"
}
}
},
"required":[
"action",
"description",
"errorCode",
"resources",
"violations"
],
"title":"ApiError"
},
"ApiErrorResource":{
"type":"object",
"description":"List of available resources to recover from the error.",
"properties":{
"name":{
"type":"string",
"description":"Resource name."
},
"url":{
"type":"string",
"description":"Resource URL."
}
},
"title":"ApiErrorResource"
},
"ApiErrorViolation":{
"type":"object",
"description":"List of violations that caused the error.",
"properties":{
"property":{
"type":"string",
"description":"Request property that caused the error."
},
"violation":{
"type":"string",
"description":"Detailed violation description."
}
},
"title":"ApiErrorViolation"
},
"ApiException":{
"type":"object",
"properties":{
"requestError":{
"$ref":"#/components/schemas/ApiRequestError"
}
},
"title":"ApiException"
},
"ApiRequestError":{
"type":"object",
"properties":{
"serviceException":{
"$ref":"#/components/schemas/ApiRequestErrorDetails"
}
},
"title":"ApiRequestError"
},
"ApiRequestErrorDetails":{
"type":"object",
"properties":{
"messageId":{
"type":"string",
"description":"Identifier of the error."
},
"text":{
"type":"string",
"description":"Detailed error description."
},
"validationErrors":{
"type":"object",
"additionalProperties":{
"type":"array",
"items":{
"type":"string",
"description":"Validation errors."
}
},
"description":"Validation errors."
}
},
"title":"ApiRequestErrorDetails"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.GetViberTemplatesResponse":{
"type":"object",
"description":"List of templates per page.",
"properties":{
"templates":{
"type":"array",
"description":"List of templates for requested page.",
"items":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.ViberTemplateResponseNoDates"
}
},
"paging":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.Paging"
}
},
"required":[
"templates"
],
"title":"GetViberTemplatesResponse"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.Paging":{
"type":"object",
"description":"Contains information about the page.",
"properties":{
"page":{
"type":"integer",
"format":"int32",
"description":"Requested page number.",
"minimum":0
},
"size":{
"type":"integer",
"format":"int32",
"description":"Requested page size.",
"minimum":1
},
"totalPages":{
"type":"integer",
"format":"int32",
"description":"The total number of pages of the results matching the requested parameters.",
"minimum":0
},
"totalResults":{
"type":"integer",
"format":"int64",
"description":"The total number of the results matching the requested parameters.",
"minimum":0
}
},
"required":[
"page",
"size",
"totalPages",
"totalResults"
],
"title":"Paging"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateBody":{
"type":"object",
"description":"Template body containing the actual message text for a specific language.",
"properties":{
"language":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateLang"
},
"template":{
"type":"string",
"description":"Template message text with optional placeholders for variables (e.g., {{1}}, {{2}}). Maximum 875 characters. Last word in the template text cannot be a placeholder.",
"example":"Your order {{orderId}} has been confirmed.",
"maxLength":875,
"minLength":1
}
},
"required":[
"language",
"template"
],
"title":"TemplateBody"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateCategory":{
"type":"string",
"description":"Business category of the template, used for classification and approval routing.",
"enum":[
"OTP",
"TRANSACTIONAL"
],
"example":"TRANSACTIONAL",
"title":"TemplateCategory"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateLang":{
"type":"string",
"description":"Language code for the template body.",
"enum":[
"ar",
"hy",
"be",
"bs",
"bg",
"my",
"hr",
"cs",
"da",
"nl",
"en",
"fi",
"fr",
"ka",
"de",
"el",
"he",
"hu",
"id",
"it",
"ja",
"ne",
"no",
"fa",
"pl",
"ro",
"ru",
"sr",
"sk",
"sl",
"es",
"sv",
"th",
"tr",
"uk",
"vi"
],
"example":"en",
"title":"TemplateLang"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParam":{
"type":"object",
"description":"Variable parameter definition for template placeholders.",
"properties":{
"type":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParamType"
},
"name":{
"type":"string",
"description":"Name or identifier of the parameter, used to reference it in the template. Must have the same name as the placeholder in the template content.",
"example":"orderId",
"maxLength":50,
"minLength":0
},
"example":{
"type":"string",
"description":"Example value for the parameter, used for template preview and validation.",
"example":"ORD-12345",
"maxLength":25,
"minLength":0
}
},
"required":[
"example",
"name",
"type"
],
"title":"TemplateParam"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParamType":{
"type":"string",
"description":"Type of template parameter.",
"enum":[
"TEXT"
],
"example":"TEXT",
"title":"TemplateParamType"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateStatus":{
"type":"string",
"description":"Current approval status of the template in the review process.",
"enum":[
"PENDING",
"APPROVED",
"DECLINED"
],
"example":"APPROVED",
"title":"TemplateStatus"
},
"f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.ViberTemplateResponseNoDates":{
"type":"object",
"description":"Viber message template response containing template details and current status.",
"properties":{
"templateId":{
"type":"string",
"description":"Unique identifier of the template.",
"example":"00000000-0000-0000-0000-000000000000"
},
"version":{
"type":"string",
"description":"Template version number.",
"example":"1"
},
"sender":{
"type":"string",
"description":"Sender for which the template is registered.",
"example":"CompanyName"
},
"category":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateCategory"
},
"status":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateStatus"
},
"params":{
"type":"array",
"description":"List of variable parameters defined in the template.",
"items":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParam"
}
},
"body":{
"type":"array",
"description":"List of template bodies per language containing the actual message text.",
"items":{
"$ref":"#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateBody"
}
}
},
"title":"ViberTemplateResponseNoDates"
}
},
"responses":{
"ApiError400":{
"description":"Bad Request",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E400",
"description":"Request cannot be processed.",
"action":"Check the syntax, violations and adjust the request.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n"
}
}
},
"ApiError401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E401",
"description":"The request lacks valid authentication credentials for the requested resource.",
"action":"Check the resources and adjust authentication credentials.",
"violations":[],
"resources":[
{
"name":"API Authentication",
"url":"https://www.infobip.com/docs/essentials/api-authentication"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n"
}
}
},
"ApiError403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E403",
"description":"Insufficient permissions to access the requested resource.",
"action":"Repeat the request with new or different credentials.",
"violations":[],
"resources":[
{
"name":"API Scopes",
"url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n"
}
}
},
"ApiError404":{
"description":"Not Found",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E404",
"description":"Not found - request URL doesn't exist on the API server or resource is not found.",
"action":"Check the resources and adjust your request.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\n \n \n\n"
}
}
},
"ApiError429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E429",
"description":"Too many requests sent.",
"action":"Check request rate limit specified in the API endpoint documentation resource.",
"violations":[],
"resources":[
{
"name":"Throttling handling errors",
"url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors"
}
]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n"
}
}
},
"ApiError500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":{
"errorCode":"E500",
"description":"Something went wrong.",
"action":"Contact the support.",
"violations":[],
"resources":[]
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiError"
},
"example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n"
}
}
},
"ApiException401":{
"description":"Unauthorized",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"UNAUTHORIZED",
"text":"Unauthorized"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n"
}
}
},
"ApiException403":{
"description":"Forbidden",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"FORBIDDEN",
"text":"Forbidden"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n"
}
}
},
"ApiException429":{
"description":"Too Many Requests",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"TOO_MANY_REQUESTS",
"text":"Too many requests"
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n"
}
}
},
"ApiException500":{
"description":"Internal Server Error",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":{
"requestError":{
"serviceException":{
"messageId":"GENERAL_ERROR",
"text":"Something went wrong. Please contact support."
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/ApiException"
},
"example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n"
}
}
}
},
"parameters":{},
"examples":{},
"requestBodies":{},
"headers":{},
"securitySchemes":{
"APIKeyHeader":{
"type":"apiKey",
"description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n",
"name":"Authorization",
"in":"header"
},
"Basic":{
"type":"http",
"description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n",
"scheme":"basic"
},
"IBSSOTokenHeader":{
"type":"apiKey",
"description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n",
"name":"Authorization",
"in":"header"
},
"OAuth2":{
"type":"oauth2",
"description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```",
"flows":{
"clientCredentials":{
"tokenUrl":"https://api.infobip.com/auth/1/oauth2/token",
"scopes":{}
}
}
}
},
"links":{},
"callbacks":{}
},
"webhooks":{
"receive-inbound-viber-messages":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"inbound-message"
],
"summary":"Receive Viber inbound message",
"description":"Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.",
"externalDocs":{
"description":"Learn more about Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"receive-viber-inbound-messages",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessages"
},
"examples":{
"Received Viber TEXT message":{
"summary":"Received Viber TEXT message",
"value":{
"results":[
{
"sender":"385912345678",
"to":"givenClient",
"integrationType":"VIBER",
"receivedAt":"2020-04-01T11:02:43.594+0000",
"messageId":"1234567890123456789",
"message":{
"text":"givenText",
"trackingData":"givenTrackingData",
"type":"TEXT"
},
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":1
}
},
"Received Viber FILE message":{
"summary":"Received Viber FILE message",
"value":{
"results":[
{
"sender":"385912345678",
"to":"givenClient",
"integrationType":"VIBER",
"receivedAt":"2020-04-01T11:02:43.594+0000",
"messageId":"1234567890123456789",
"message":{
"url":"https://example.com/givenUrl.pdf",
"fileName":"givenFileName",
"trackingData":"givenTrackingData",
"type":"FILE"
},
"price":{
"pricePerMessage":0.15,
"currency":"EUR"
}
}
],
"messageCount":1,
"pendingMessageCount":1
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-outbound-viber-message-delivery-reports":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"message-status-reports"
],
"summary":"Receive Viber 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 Viber channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"receive-outbound-viber-message-delivery-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":{
"results":[
{
"bulkId":"a28dd97c-2222-4fcf-99f1-0b557ed381da",
"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":"441134960001",
"sender":"441134960000",
"sentAt":"2023-02-01T23:00:00.000+0000",
"doneAt":"2023-02-03T00:01:01.000+0000",
"messageCount":1,
"mccMnc":"22801",
"callbackData":"Callback data",
"platform":{
"entityId":"promotional-traffic-entity",
"applicationId":"marketing-automation-application"
}
}
]
}
}
}
},
"application/xml":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports"
},
"examples":{
"Delivery report":{
"summary":"Delivery report",
"value":"\n \n \n a28dd97c-2222-4fcf-99f1-0b557ed381da\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 441134960001\n 441134960000\n 2023-02-01T23:00:00.000+0000\n 2023-02-03T00:01:01.000+0000\n 1\n 22801\n Callback data\n \n promotional-traffic-entity\n marketing-automation-application\n \n \n \n\n"
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-viber-seen-reports":{
"post":{
"tags":[
"channels",
"viber",
"viber-business-messages",
"message-status-reports"
],
"summary":"Receive seen reports",
"description":"For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.",
"operationId":"receive-viber-seen-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReports"
},
"examples":{
"Seen report":{
"summary":"Seen report",
"value":{
"results":[
{
"messageId":"1215f543ab19-345f-adbd-12ad31451ed25f35",
"from":"385919998888",
"to":"41793026731",
"sentAt":"2023-04-05T11:21:57.793+0000",
"seenAt":"2023-04-05T11:22:10.251+0000",
"applicationId":"example-application-id",
"entityId":"example-entity-id",
"campaignReferenceId":"campaignRefId"
}
]
}
}
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
},
"receive-outbound-viber-bot-message-delivery-reports":{
"post":{
"tags":[
"channels",
"viber",
"viber_bot",
"logs-and-status-reports-viber-bot"
],
"summary":"Receive Viber Bot 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 Viber Bot channel and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"receive-outbound-viber-bot-message-delivery-reports",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.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."
}
}
}
},
"receive-viber-bot-api-incoming-messages":{
"post":{
"tags":[
"channels",
"viber",
"viber_bot",
"incoming-viber-bot-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 Viber Bot and use cases",
"url":"https://www.infobip.com/docs/viber"
},
"operationId":"receive-viber-bot-api-incoming-messages",
"requestBody":{
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundResponse"
}
}
}
},
"responses":{
"200":{
"description":"Your server returns this code if it accepts the callback."
}
}
}
}
}
}