{ "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:50.401626069Z" }, "tags":[ { "name":"platform", "description":"Modular tools to scale and automate your business.\n", "x-type":"category", "x-displayName":"Platform" }, { "name":"messages-api", "description":"The Messages API integrates multiple messaging channels into one interface. Instead of using a separate API for each messaging channel, use only one API for multiple channels and message types.\n", "x-type":"product", "x-displayName":"Messages API" }, { "name":"sending-message", "description":"Sends one or more messages to multiple recipients.\n", "x-type":"module", "x-displayName":"Outbound Message" }, { "name":"messages-api-status-reports", "description":"Status reports provide insights into the messages you send, including whether they were successfully delivered, failed, or seen by the recipient. These reports can be pushed in real time to a customer's webhook.\n\n__Delivery Reports:__ \n * Delivery reports confirm whether a message was successfully delivered or failed. If a failure occurs, the report includes a timestamp and a delivery failure message with a status code indicating the reason. You can fetch delivery reports using the [Get delivery reports](#platform/messages-api/messages-api-status-reports/get-messages-api-delivery-reports) endpoint. This endpoint supports messages sent through both Messages API and standalone APIs (such as Viber API, WhatsApp API, or SMS API), allowing you to track delivery statuses across all messaging channels.\n\n__Seen Reports:__ \n * Seen reports confirm whether a recipient has viewed a successfully delivered message. Not all channels support this feature. You can fetch seen reports using the [Receive seen reports](#platform/messages-api/messages-api-status-reports/receive-messages-api-seen-reports) endpoint.\n", "x-type":"module", "x-displayName":"Message Status Reports" }, { "name":"inbound-messages", "description":"Receive incoming messages on the defined end-point in real-time or use [Get incoming messages](#platform/messages-api/inbound-messages/get-messages-api-inbound-messages) endpoint to pull incoming messages manually.\n", "x-type":"module", "x-displayName":"Receive inbound message" } ], "paths":{ "/messages-api/1/messages":{ "post":{ "tags":[ "platform", "messages-api", "sending-message" ], "summary":"Send a Messages API message", "description":"Send messages at scale through multiple channels, utilizing various message types.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"send-messages-api-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest" }, "examples":{ "Text message APPLE_MB":{ "summary":"Text message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Text message with buttons APPLE_MB":{ "summary":"Text message with buttons", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Image message APPLE_MB":{ "summary":"Image message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Video message APPLE_MB":{ "summary":"Video message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Document message APPLE_MB":{ "summary":"Document message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Rich link message APPLE_MB":{ "summary":"Rich link message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Authentication request message APPLE_MB":{ "summary":"Authentication request message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Authentication!", "type":"AUTHENTICATION_REQUEST" }, "confirmationBody":{ "text":"Thank you!", "imageUrl":"https://example.com/authenticated.jpg" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "List message APPLE_MB":{ "summary":"List message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" }, "confirmationBody":{ "text":"Thanks!", "imageUrl":"https://example.com/thanks.jpg" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Carousel message APPLE_MB":{ "summary":"Carousel message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nFor APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "cards":[ { "body":{ "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Sticker message APPLE_MB":{ "summary":"Sticker message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nFor APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Mixed message APPLE_MB":{ "summary":"Mixed message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "items":[ { "url":"https://example.com/example1.jpg" }, { "url":"https://example.com/example2.jpg" }, { "url":"https://example.com/example3.jpg" } ], "type":"MIXED" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Time picker message APPLE_MB":{ "summary":"Time picker message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"When do you want to meet?", "imageUrl":"https://example.com/image.jpg", "event":{ "title":"Important meeting", "timeslots":[ { "duration":3600, "startTime":"2035-05-26T08:30:00Z" }, { "duration":3600, "startTime":"2035-05-26T09:30:00Z" } ], "location":{ "latitude":44.95305, "longitude":13.85637, "radius":50.0, "name":"Infobip d.o.o." } }, "type":"TIME_PICKER" }, "confirmationBody":{ "text":"Thanks!", "imageUrl":"https://example.com/thanks.jpg" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Order request message APPLE_MB":{ "summary":"Order request message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Message text", "subtext":"Message subtitle", "imageUrl":"https://example.com/image.jpg", "order":{ "items":[ { "name":"Item name", "retailerId":"retailerId", "amount":100 } ] }, "payment":{ "configuration":{ "merchantDomain":"customMerchantDomain", "merchantDisplayName":"customMerchantDisplayName", "type":"APPLE_PAY" }, "total":{ "value":75, "description":"Total description" } }, "shippings":[ { "amount":10, "description":"Shipping description", "identifier":"identified", "label":"label" } ], "type":"ORDER_REQUEST" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Template message with parameters APPLE_MB":{ "summary":"Template message with parameters", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"binaryChoice.engage.noImage", "language":"en-us", "referenceId":"referenceId" }, "content":{ "body":{ "type":"TEXT", "brandName":"Infobip" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "template" ] } }, "Text message with options and webhooks APPLE_MB":{ "summary":"Text message with options and webhooks", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking APPLE_MB":{ "summary":"Text message with scheduling and URL shortening and tracking", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels APPLE_MB":{ "summary":"Text message with failover to other channels", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "byChannel":[ { "channel":"APPLE_MB", "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" }, { "channel":"INSTAGRAM_DM", "to":"768938852147373" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message/template with options" ] } }, "Template message with parameters with failover to other channels APPLE_MB":{ "summary":"Template message with parameters with failover to other channels", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "byChannel":[ { "channel":"APPLE_MB", "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" }, { "channel":"INSTAGRAM_DM", "to":"768938852147373" }, { "channel":"LINE_ON", "to":"123456789" } ] } ], "template":{ "templateName":"binaryChoice.engage.noImage", "language":"en-us", "referenceId":"referenceId" }, "content":{ "body":{ "type":"TEXT", "brandName":"Infobip" } }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook", "receiveTriggeredFailoverReports":true }, "callbackData":"callbackData" }, "failover":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "content":{ "body":{ "text":"Hello, how are you?", "type":"TEXT" } } }, { "channel":"LINE_ON", "sender":"LINE IB Test", "content":{ "body":{ "url":"https://example.com/image.jpg", "text":"Hello, how are you?", "type":"IMAGE" } } } ] } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message/template with options" ] } }, "Form message APPLE_MB":{ "summary":"Form message", "description":"For APPLE_MB non template messages can only be sent after user initiates session.", "value":{ "messages":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "content":{ "body":{ "text":"Please fill this form to receive absolutely nothing!", "imageUrl":"https://example.com/image.jpg", "pages":[ { "title":"Welcome to the form!", "text":"Please fill all fields.", "buttonText":"Proceed to first question", "imageUrl":"https://example.com/image.jpg", "type":"INTRO" }, { "title":"First page", "text":"What is your name?", "pageIdentifier":"1", "nextPageIdentifier":"2", "submitForm":false, "options":{ "hintText":"A small hint", "placeholder":"Insert your name", "isRequired":false, "inputType":"SINGLELINE", "labelText":"Name", "maximumCharacterCount":30, "keyboardType":"DEFAULT", "textContentType":"GIVEN_NAME" }, "type":"INPUT" }, { "title":"Second page", "text":"Pick your favourite animal", "pageIdentifier":"2", "nextPageIdentifier":"3", "items":[ { "identifier":"2-1", "title":"Dog", "value":"dog" }, { "identifier":"2-2", "title":"Cat", "value":"cat" } ], "submitForm":false, "subtext":"Choose an animal", "selectedItemIndex":0, "type":"PICKER" }, { "title":"Third page", "text":"Select two colours of your liking", "pageIdentifier":"3", "nextPageIdentifier":"4", "items":[ { "identifier":"3-1", "title":"Red", "value":"red" }, { "identifier":"3-2", "title":"Green", "value":"green" }, { "identifier":"3-1", "title":"Blue", "value":"blue" } ], "submitForm":false, "multipleSelection":true, "type":"SELECT" }, { "title":"Fourth page", "text":"When is your birthday?", "pageIdentifier":"4", "submitForm":true, "options":{ "dateFormat":"yyyy-MM-DD", "startDate":"2025-01-01T14:00:00Z", "maximumDate":"2025-01-01T14:00:00Z", "minimumDate":"1900-01-01T14:00:00Z", "dateLabel":"Your birthday" }, "type":"DATE_PICKER" } ], "startPageIdentifier":"1", "isPrivate":false, "showSummary":false, "type":"FORM" }, "confirmationBody":{ "text":"Thank you!", "imageUrl":"https://example.com/form.jpg" } } } ] }, "x-label":{ "channel":[ "APPLE_MB" ], "message type":[ "message" ] } }, "Text message INSTAGRAM_DM":{ "summary":"Text message", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Text message with buttons INSTAGRAM_DM":{ "summary":"Text message with buttons", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Image message INSTAGRAM_DM":{ "summary":"Image message", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Video message INSTAGRAM_DM":{ "summary":"Video message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Document message INSTAGRAM_DM":{ "summary":"Document message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Rich link message INSTAGRAM_DM":{ "summary":"Rich link message", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "buttonText":"Click here", "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "List message INSTAGRAM_DM":{ "summary":"List message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Carousel message INSTAGRAM_DM":{ "summary":"Carousel message", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "cards":[ { "body":{ "title":"Otter Plushie", "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] }, { "body":{ "title":"Penguin Plushie", "text":"Waddle with adorable penguin friend", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Penguin", "url":"https://example.com/penguin", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Location message INSTAGRAM_DM":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Sticker message INSTAGRAM_DM":{ "summary":"Sticker message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message" ] } }, "Text message with options and webhooks INSTAGRAM_DM":{ "summary":"Text message with options and webhooks", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking INSTAGRAM_DM":{ "summary":"Text message with scheduling and URL shortening and tracking", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "to":"768938852147373" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels INSTAGRAM_DM":{ "summary":"Text message with failover to other channels", "description":"Communication in INSTAGRAM_DM channel is user initiated.", "value":{ "messages":[ { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "destinations":[ { "byChannel":[ { "channel":"INSTAGRAM_DM", "to":"768938852147373" }, { "channel":"LINE_ON", "to":"123456789" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"LINE_ON", "sender":"LINE IB Test" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "INSTAGRAM_DM" ], "message type":[ "message/template with options" ] } }, "Text message LINE_ON":{ "summary":"Text message", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Text message with buttons LINE_ON":{ "summary":"Text message with buttons", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Check vibes", "url":"https://example.com/vibes", "type":"OPEN_URL" } ] } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Image message LINE_ON":{ "summary":"Image message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Video message LINE_ON":{ "summary":"Video message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Document message LINE_ON":{ "summary":"Document message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Location message LINE_ON":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message" ] } }, "Text message with options and webhooks LINE_ON":{ "summary":"Text message with options and webhooks", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking LINE_ON":{ "summary":"Text message with scheduling and URL shortening and tracking", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels LINE_ON":{ "summary":"Text message with failover to other channels", "value":{ "messages":[ { "channel":"LINE_ON", "sender":"LINE IB Test", "destinations":[ { "byChannel":[ { "channel":"LINE_ON", "to":"123456789" }, { "channel":"MESSENGER", "to":"24060905360217212" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"MESSENGER", "sender":"731401526720514" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "LINE_ON" ], "message type":[ "message/template with options" ] } }, "Text message MESSENGER":{ "summary":"Text message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Text message with buttons MESSENGER":{ "summary":"Text message with buttons", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Image message MESSENGER":{ "summary":"Image message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Video message MESSENGER":{ "summary":"Video message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Document message MESSENGER":{ "summary":"Document message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Rich link message MESSENGER":{ "summary":"Rich link message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "buttonText":"Click here", "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "List message MESSENGER":{ "summary":"List message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Carousel message MESSENGER":{ "summary":"Carousel message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "cards":[ { "body":{ "title":"Otter Plushie", "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] }, { "body":{ "title":"Penguin Plushie", "text":"Waddle with adorable penguin friend", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Penguin", "url":"https://example.com/penguin", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Location message MESSENGER":{ "summary":"Location message", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Sticker message MESSENGER":{ "summary":"Sticker message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message" ] } }, "Text message with options and webhooks MESSENGER":{ "summary":"Text message with options and webhooks", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking MESSENGER":{ "summary":"Text message with scheduling and URL shortening and tracking", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "to":"24060905360217212" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels MESSENGER":{ "summary":"Text message with failover to other channels", "description":"Communication in MESSENGER channel is user initiated.", "value":{ "messages":[ { "channel":"MESSENGER", "sender":"731401526720514", "destinations":[ { "byChannel":[ { "channel":"MESSENGER", "to":"24060905360217212" }, { "channel":"MMS", "to":"123456789" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"MMS", "sender":"10950" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "MESSENGER" ], "message type":[ "message/template with options" ] } }, "Text message MMS":{ "summary":"Text message", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Image message MMS":{ "summary":"Image message", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Video message MMS":{ "summary":"Video message", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Document message MMS":{ "summary":"Document message", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Rich link message MMS":{ "summary":"Rich link message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Carousel message MMS":{ "summary":"Carousel message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "cards":[ { "body":{ "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Location message MMS":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Sticker message MMS":{ "summary":"Sticker message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Mixed message MMS":{ "summary":"Mixed message", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "items":[ { "url":"https://example.com/example1.jpg" }, { "text":"Some text" }, { "url":"https://example.com/example3.jpg" } ], "type":"MIXED" } } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message" ] } }, "Text message with options and webhooks MMS":{ "summary":"Text message with options and webhooks", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking MMS":{ "summary":"Text message with scheduling and URL shortening and tracking", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels MMS":{ "summary":"Text message with failover to other channels", "value":{ "messages":[ { "channel":"MMS", "sender":"10950", "destinations":[ { "byChannel":[ { "channel":"MMS", "to":"123456789" }, { "channel":"RCS", "to":"123456789" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"RCS", "sender":"ibpDemoPly" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "MMS" ], "message type":[ "message/template with options" ] } }, "Text message RCS":{ "summary":"Text message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Text message with buttons RCS":{ "summary":"Text message with buttons", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Image message RCS":{ "summary":"Image message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Video message RCS":{ "summary":"Video message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Document message RCS":{ "summary":"Document message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Rich link message RCS":{ "summary":"Rich link message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "buttonText":"Click here", "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "List message RCS":{ "summary":"List message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Carousel message RCS":{ "summary":"Carousel message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "cards":[ { "body":{ "title":"Otter Plushie", "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] }, { "body":{ "title":"Penguin Plushie", "text":"Waddle with adorable penguin friend", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Penguin", "url":"https://example.com/penguin", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Location message RCS":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message" ] } }, "Template message RCS":{ "summary":"Template message", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName" } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "template" ] } }, "Template message with parameters RCS":{ "summary":"Template message with parameters", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName" }, "content":{ "body":{ "type":"TEXT", "custom_param_1":"Infobip", "custom_param_2":"5:30 AM" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "template" ] } }, "Text message with options and webhooks RCS":{ "summary":"Text message with options and webhooks", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData", "seen":{ "url":"https://example.com/seen-webhook" } } } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking RCS":{ "summary":"Text message with scheduling and URL shortening and tracking", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels RCS":{ "summary":"Text message with failover to other channels", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "byChannel":[ { "channel":"RCS", "to":"123456789" }, { "channel":"SMS", "to":"123456789" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"SMS", "sender":"447491163862" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message/template with options" ] } }, "Template message with parameters with failover to other channels RCS":{ "summary":"Template message with parameters with failover to other channels", "value":{ "messages":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "byChannel":[ { "channel":"RCS", "to":"123456789" }, { "channel":"SMS", "to":"123456789" }, { "channel":"VIBER_BM", "to":"123456789" } ] } ], "template":{ "templateName":"templateName" }, "content":{ "body":{ "type":"TEXT", "custom_param_1":"Infobip", "custom_param_2":"5:30 AM" } }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook", "receiveTriggeredFailoverReports":true }, "callbackData":"callbackData" }, "failover":[ { "channel":"SMS", "sender":"447491163862", "content":{ "body":{ "text":"Hello, how are you?", "type":"TEXT" } } }, { "channel":"VIBER_BM", "sender":"InfobipDemo", "content":{ "body":{ "url":"https://example.com/image.jpg", "text":"Hello, how are you?", "type":"IMAGE" } } } ] } ] }, "x-label":{ "channel":[ "RCS" ], "message type":[ "message/template with options" ] } }, "Text message SMS":{ "summary":"Text message", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message" ] } }, "Image message SMS":{ "summary":"Image message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message" ] } }, "Video message SMS":{ "summary":"Video message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message" ] } }, "Document message SMS":{ "summary":"Document message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message" ] } }, "Location message SMS":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message" ] } }, "Text message with options and webhooks SMS":{ "summary":"Text message with options and webhooks", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData" } } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking SMS":{ "summary":"Text message with scheduling and URL shortening and tracking", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels SMS":{ "summary":"Text message with failover to other channels", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "byChannel":[ { "channel":"SMS", "to":"123456789" }, { "channel":"VIBER_BM", "to":"123456789" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"VIBER_BM", "sender":"InfobipDemo" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "SMS" ], "message type":[ "message/template with options" ] } }, "Text message VIBER_BM":{ "summary":"Text message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Text message with buttons VIBER_BM":{ "summary":"Text message with buttons", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Check vibes", "url":"https://example.com/vibes", "type":"OPEN_URL" } ] } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Image message VIBER_BM":{ "summary":"Image message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Video message VIBER_BM":{ "summary":"Video message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "thumbnailUrl":"https://example.com/thumbnail.jpg", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Document message VIBER_BM":{ "summary":"Document message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "filename":"document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Rich link message VIBER_BM":{ "summary":"Rich link message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "buttonText":"Click here", "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Carousel message VIBER_BM":{ "summary":"Carousel message", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "header":{ "text":"Check our plushies", "type":"TEXT" }, "body":{ "cards":[ { "body":{ "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] }, { "body":{ "text":"Waddle with adorable penguin friend", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Penguin", "url":"https://example.com/penguin", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Location message VIBER_BM":{ "summary":"Location message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Sticker message VIBER_BM":{ "summary":"Sticker message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\n", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message" ] } }, "Template message with parameters VIBER_BM":{ "summary":"Template message with parameters", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"0aac888f-2ee2-4112-9659-1755a951966a", "language":"en" }, "content":{ "body":{ "pin":"1234", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "template" ] } }, "Text message with options and webhooks VIBER_BM":{ "summary":"Text message with options and webhooks", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData", "seen":{ "url":"https://example.com/seen-webhook" } } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Text message with traffic type option VIBER_BM":{ "summary":"Text message with traffic type option", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "adaptationMode":false, "trafficType":"TRANSACTIONAL" } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Text message with enabled session rate and primary device only options VIBER_BM":{ "summary":"Text message with enabled session rate and primary device only options", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "adaptationMode":false, "sessionRate":true, "primaryDevice":true } } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking VIBER_BM":{ "summary":"Text message with scheduling and URL shortening and tracking", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels VIBER_BM":{ "summary":"Text message with failover to other channels", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "byChannel":[ { "channel":"VIBER_BM", "to":"123456789" }, { "channel":"VIBER_BOT", "to":"SirE8dEwjQEda4/VugaE+A==" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708" }, { "channel":"WHATSAPP", "sender":"447491163862", "template":{ "templateName":"givenTemplateName", "language":"en" } } ] } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Template message with parameters with failover to other channels VIBER_BM":{ "summary":"Template message with parameters with failover to other channels", "value":{ "messages":[ { "channel":"VIBER_BM", "sender":"InfobipDemo", "destinations":[ { "byChannel":[ { "channel":"VIBER_BM", "to":"123456789" }, { "channel":"VIBER_BOT", "to":"SirE8dEwjQEda4/VugaE+A==" }, { "channel":"WHATSAPP", "to":"123456789" } ] } ], "template":{ "templateName":"0aac888f-2ee2-4112-9659-1755a951966a", "language":"en" }, "content":{ "body":{ "pin":"1234", "type":"TEXT" } }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook", "receiveTriggeredFailoverReports":true }, "callbackData":"callbackData" }, "failover":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "content":{ "body":{ "text":"Hello, how are you?", "type":"TEXT" } } }, { "channel":"WHATSAPP", "sender":"447491163862", "content":{ "body":{ "url":"https://example.com/image.jpg", "text":"Hello, how are you?", "type":"IMAGE" } } } ] } ] }, "x-label":{ "channel":[ "VIBER_BM" ], "message type":[ "message/template with options" ] } }, "Text message VIBER_BOT":{ "summary":"Text message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Text message with senderDisplayInfo VIBER_BOT":{ "summary":"Text message with senderDisplayInfo", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "senderDisplayInfo":{ "name":"Company name", "avatarUrl":"https://example.com/avatarUrl.jpg" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Text message with buttons VIBER_BOT":{ "summary":"Text message with buttons", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Image message VIBER_BOT":{ "summary":"Image message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Video message VIBER_BOT":{ "summary":"Video message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Document message VIBER_BOT":{ "summary":"Document message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "filename":"document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Rich link message VIBER_BOT":{ "summary":"Rich link message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "buttonText":"Click here", "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "List message VIBER_BOT":{ "summary":"List message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nCommunication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Carousel message VIBER_BOT":{ "summary":"Carousel message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "cards":[ { "body":{ "title":"Otter Plushie", "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] }, { "body":{ "title":"Penguin Plushie", "text":"Waddle with adorable penguin friend", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Penguin", "url":"https://example.com/penguin", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Location message VIBER_BOT":{ "summary":"Location message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Contact message VIBER_BOT":{ "summary":"Contact message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "name":"Some Something", "phoneNumber":"123456789", "type":"CONTACT" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Sticker message VIBER_BOT":{ "summary":"Sticker message", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "reference":"40133", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message" ] } }, "Text message with options and webhooks VIBER_BOT":{ "summary":"Text message with options and webhooks", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData", "seen":{ "url":"https://example.com/seen-webhook" } } } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking VIBER_BOT":{ "summary":"Text message with scheduling and URL shortening and tracking", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "to":"SirE8dEwjQEda4/VugaE+A==" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels VIBER_BOT":{ "summary":"Text message with failover to other channels", "description":"Communication in VIBER_BOT channel is user initiated.", "value":{ "messages":[ { "channel":"VIBER_BOT", "sender":"pa:5964217479313231708", "destinations":[ { "byChannel":[ { "channel":"VIBER_BOT", "to":"SirE8dEwjQEda4/VugaE+A==" }, { "channel":"WHATSAPP", "to":"123456789" }, { "channel":"RCS", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"WHATSAPP", "sender":"447491163862" }, { "channel":"RCS", "sender":"ibpDemoPly", "template":{ "templateName":"givenTemplateName" } } ] } ] }, "x-label":{ "channel":[ "VIBER_BOT" ], "message type":[ "message/template with options" ] } }, "Text message WHATSAPP":{ "summary":"Text message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Text message with buttons WHATSAPP":{ "summary":"Text message with buttons", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" }, "buttons":[ { "text":"Thank you", "postbackData":"thanks", "type":"REPLY" }, { "text":"I send you more :3", "postbackData":"more", "type":"REPLY" } ] } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Image message WHATSAPP":{ "summary":"Image message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/image.jpg", "type":"IMAGE" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Video message WHATSAPP":{ "summary":"Video message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/video.mp4", "type":"VIDEO" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Document message WHATSAPP":{ "summary":"Document message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "url":"https://example.com/document.pdf", "type":"DOCUMENT" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Rich link message WHATSAPP":{ "summary":"Rich link message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nFor WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "redirectUrl":"https://example.com", "text":"Have a bear-y good day!", "url":"https://example.com/image.jpg", "isVideo":false, "type":"RICH_LINK" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "List message WHATSAPP":{ "summary":"List message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Welcome to the Safari Adventure Crew!", "subtext":"Adjust your trip", "sections":[ { "sectionTitle":"Essentials", "items":[ { "text":"Binoculars" }, { "text":"Safari Hat" } ] }, { "sectionTitle":"Animals to Meet", "items":[ { "text":"Elephant" }, { "text":"Zebra" } ] } ], "type":"LIST" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Carousel message WHATSAPP":{ "summary":"Carousel message", "description":"Message type is not fully or natively supported by the channel and will be adapted.\nFor WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "cards":[ { "body":{ "text":"Cuddle with softest otter in the river", "url":"https://example.com/image.png", "isVideo":false }, "buttons":[ { "text":"Otter", "url":"https://example.com/otter", "postbackData":"postbackData", "type":"OPEN_URL" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Location message WHATSAPP":{ "summary":"Location message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "latitude":44.95305, "longitude":13.85637, "name":"Infobip d.o.o.", "address":"Istarska 157, 52215 Vodnjan, Croatia", "type":"LOCATION" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Contact message WHATSAPP":{ "summary":"Contact message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "name":"Some Something", "phoneNumber":"123456789", "type":"CONTACT" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Sticker message WHATSAPP":{ "summary":"Sticker message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "reference":"https://example.com/sticker.webp", "type":"STICKER" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Product message WHATSAPP":{ "summary":"Product message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "header":{ "text":"Check our products", "type":"TEXT" }, "body":{ "text":"New watches.", "catalogId":"3735864913400897", "sections":[ { "title":"New watch", "productRetailerIds":[ "pf8e9cpb9u" ] }, { "title":"Another watch", "productRetailerIds":[ "a92wdavv4a" ] }, { "title":"Another new watch", "productRetailerIds":[ "5m9rpwuk95" ] } ], "type":"PRODUCT" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Flow message WHATSAPP":{ "summary":"Flow message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Share with us your opinion", "id":"1049250280482345", "token":"tokenForTracking", "buttonText":"Click Me!", "mode":"PUBLISHED", "action":{ "payload":{ "screen":"BOOKING_DETAILS" }, "type":"NAVIGATE" }, "type":"FLOW" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Order request message WHATSAPP":{ "summary":"Order request message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Message text", "imageUrl":"https://example.com/image.jpg", "order":{ "catalogId":"catalogId", "currency":"INR", "type":"DIGITAL_GOODS", "items":[ { "name":"Item name", "retailerId":"retailerId", "quantity":1, "amount":100, "saleAmount":50 } ], "expiration":{ "timestamp":"2024-02-06T14:18:29.797Z", "description":"Description of the expiration" } }, "payment":{ "configuration":{ "id":"paymentId", "name":"paymentConfigurationName", "productDescription":"description of product in order", "customerFirstName":"customerFirstName", "customerLastName":"customerLastName", "customerEmail":"customerEmail@example.com", "callbackData":[ "callbackData" ], "type":"UPI_PAYU" }, "total":{ "value":75 }, "subtotal":50, "tax":{ "value":25, "description":"Tax description" }, "discount":{ "value":10, "description":"Discount description" } }, "shippings":[ { "amount":10, "description":"Shipping description" } ], "type":"ORDER_REQUEST" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Order status message WHATSAPP":{ "summary":"Order status message", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "title":"Message text", "id":"orderId", "orderType":"UPI_PAYU", "orderStatus":"PENDING", "type":"ORDER_STATUS" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message" ] } }, "Template message WHATSAPP":{ "summary":"Template message", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName", "language":"en" } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "template" ] } }, "Template message with parameters WHATSAPP":{ "summary":"Template message with parameters", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName", "language":"en" }, "content":{ "body":{ "type":"TEXT", "1":"Infobip", "2":"5:30 AM" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "template" ] } }, "Template message with parameters and dynamic URL buttons WHATSAPP":{ "summary":"Template message with parameters and dynamic URL buttons", "description":"If template has defined static URL buttons they should be omitted in request.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName", "language":"en" }, "content":{ "body":{ "type":"TEXT", "1":"Infobip", "2":"5:30 AM" }, "buttons":[ { "suffix":"example1", "type":"OPEN_URL" }, { "suffix":"example2", "type":"OPEN_URL" } ] } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "template" ] } }, "Template authentication message with copy code button WHATSAPP":{ "summary":"Template authentication message with copy code button", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName", "language":"en" }, "content":{ "body":{ "type":"TEXT", "1":"Infobip", "2":"12345" }, "buttons":[ { "suffix":"12345", "type":"OPEN_URL" } ] } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "template" ] } }, "Template carousel message WHATSAPP":{ "summary":"Template carousel message", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "template":{ "templateName":"templateName", "language":"en" }, "content":{ "body":{ "cards":[ { "header":{ "url":"https://example.com/giraffe.jpg", "type":"IMAGE" }, "body":{ "1":"Girafffe" }, "buttons":[ { "postbackData":"giraffe", "type":"QUICK_REPLY" } ] }, { "header":{ "url":"https://example.com/zebra.jpg", "type":"IMAGE" }, "body":{ "1":"Zebra" }, "buttons":[ { "postbackData":"zebra", "type":"QUICK_REPLY" } ] } ], "type":"CAROUSEL" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "template" ] } }, "Text message with options and webhooks WHATSAPP":{ "summary":"Text message with options and webhooks", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "options":{ "platform":{ "entityId":"entityId", "applicationId":"applicationId" }, "validityPeriod":{ "amount":10, "timeUnit":"MINUTES" }, "adaptationMode":false, "campaignReferenceId":"campaignReferenceId" }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook" }, "callbackData":"callbackData", "seen":{ "url":"https://example.com/seen-webhook" } } } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message/template with options" ] } }, "Text message with scheduling and URL shortening and tracking WHATSAPP":{ "summary":"Text message with scheduling and URL shortening and tracking", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ], "options":{ "schedule":{ "bulkId":"bulkId", "sendAt":"2025-10-01T00:00:00.000Z" }, "tracking":{ "shortenUrl":true, "trackClicks":true, "trackingUrl":"https://example.com/track-url", "removeProtocol":true } } }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message/template with options" ] } }, "Text message with failover to other channels WHATSAPP":{ "summary":"Text message with failover to other channels", "description":"For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "byChannel":[ { "channel":"WHATSAPP", "to":"123456789" }, { "channel":"APPLE_MB", "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" }, { "channel":"RCS", "to":"123456789" } ] } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } }, "failover":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad" }, { "channel":"RCS", "sender":"ibpDemoPly", "template":{ "templateName":"givenTemplateName" } } ] } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message/template with options" ] } }, "Template message with parameters with failover to other channels WHATSAPP":{ "summary":"Template message with parameters with failover to other channels", "value":{ "messages":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "byChannel":[ { "channel":"WHATSAPP", "to":"123456789" }, { "channel":"APPLE_MB", "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" }, { "channel":"INSTAGRAM_DM", "to":"768938852147373" } ] } ], "template":{ "templateName":"templateName", "language":"en" }, "content":{ "body":{ "type":"TEXT", "1":"Infobip", "2":"5:30 AM" } }, "webhooks":{ "delivery":{ "url":"https://example.com/delivery-webhook", "receiveTriggeredFailoverReports":true }, "callbackData":"callbackData" }, "failover":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "content":{ "body":{ "text":"Hello, how are you?", "type":"TEXT" } } }, { "channel":"INSTAGRAM_DM", "sender":"17841447232797249", "content":{ "body":{ "url":"https://example.com/image.jpg", "text":"Hello, how are you?", "type":"IMAGE" } } } ] } ] }, "x-label":{ "channel":[ "WHATSAPP" ], "message type":[ "message/template with options" ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Successful response":{ "summary":"Successful response", "value":{ "bulkId":"1688025180464000013", "messages":[ { "messageId":"1688025180464000014", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"MESSAGE_ACCEPTED", "description":"Message sent to next instance" }, "destination":"48600700800" } ] } } } } } }, "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", "messages-api:message:send", "messages-api:manage" ] } }, "/messages-api/1/messages/validate":{ "post":{ "tags":[ "platform", "messages-api", "sending-message" ], "summary":"Validate a Messages API message", "description":"Perform a detailed validation of Messages API messages. This endpoint executes more specific checks than the `/messages` endpoint such as: possible channel-specific validations, verification of each failover step and unknown fields. Returns `200 OK` when the request would be accepted by the platform or `400 BAD_REQUEST` when it may fail at any point. Use this endpoint to validate messages before sending them to catch potential issues early.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"validate-messages-api-message", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest" }, "examples":{ "Validate correct request example":{ "summary":"Validate correct request example", "value":{ "messages":[ { "channel":"SMS", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "content":{ "body":{ "text":"Sending you lots of otterly delightful vibes today!", "type":"TEXT" } } } ] } } } } } }, "responses":{ "200":{ "description":"Message accepted", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationOkResponse" }, "examples":{ "Successful response":{ "summary":"Successful response", "value":{ "description":"Request can be sent through '/messages' endpoint and should be accepted by our platform.", "action":"No action is required, but it is recommended to check and address any violations.", "skippableViolations":[ { "property":"messages[0].metadata", "violation":"Unknown property" } ] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationBadResponse" }, "examples":{ "Error response":{ "summary":"Error response", "value":{ "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[ { "property":"messages[0].content.body", "violation":"invalid value" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "messages-api:message:send", "messages-api:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/messages-api/1/events":{ "post":{ "tags":[ "platform", "messages-api", "sending-message" ], "summary":"Send a Messages API event", "description":"Send one or more events to multiple recipients.\n\nAn event is an interaction with end-user's device which does not impact messaging content of conversation.\n\nExamples of events are: TYPING_STARTED, TYPING_STOPPED.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"send-messages-api-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventRequest" }, "examples":{ "Typing started event APPLE_MB":{ "summary":"Typing started event", "value":{ "events":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "event":"TYPING_STARTED" } ] }, "x-label":{ "channel":[ "APPLE_MB" ] } }, "Typing stopped event APPLE_MB":{ "summary":"Typing stopped event", "value":{ "events":[ { "channel":"APPLE_MB", "sender":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "destinations":[ { "to":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=" } ], "event":"TYPING_STOPPED" } ] }, "x-label":{ "channel":[ "APPLE_MB" ] } }, "Typing started event RCS":{ "summary":"Typing started event", "value":{ "events":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "event":"TYPING_STARTED" } ] }, "x-label":{ "channel":[ "RCS" ] } }, "Seen event RCS":{ "summary":"Seen event", "value":{ "events":[ { "channel":"RCS", "sender":"ibpDemoPly", "destinations":[ { "to":"123456789" } ], "messageId":"1234-5678-abcd-efgh", "event":"SEEN" } ] }, "x-label":{ "channel":[ "RCS" ] } }, "Typing started event WHATSAPP":{ "summary":"Typing started event", "value":{ "events":[ { "channel":"WHATSAPP", "sender":"447491163862", "destinations":[ { "to":"123456789" } ], "event":"TYPING_STARTED" } ] }, "x-label":{ "channel":[ "WHATSAPP" ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails" }, "examples":{ "Successful response":{ "summary":"Successful response", "value":{ "bulkId":"1688025180464000013", "messages":[ { "messageId":"1688025180464000014", "status":{ "groupId":1, "groupName":"PENDING", "id":26, "name":"MESSAGE_ACCEPTED", "description":"Message sent to next instance" }, "destination":"48600700800" } ] } } } } } }, "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", "messages-api:message:send", "messages-api:manage" ] } }, "/messages-api/1/reports":{ "get":{ "tags":[ "platform", "messages-api", "messages-api-status-reports" ], "summary":"Get 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. This endpoint retrieves delivery reports for messages sent through Messages API as well as messages sent using channel-specific standalone APIs (for example, Viber, API, WhatsApp API, or SMS API). Please note they will be returned only once.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"get-messages-api-delivery-reports", "parameters":[ { "name":"channel", "in":"query", "description":"Messaging channel for which the report will be fetched.", "required":false, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Channel" } }, { "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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":{ "results":[ { "event":"DELIVERY", "channel":"WHATSAPP", "sender":"senderNumber", "destination":"41793026727", "sentAt":"2024-02-06T14:18:29.797+0000", "doneAt":"2024-02-06T17:18:29.797+0000", "bulkId":"1688025180464000013", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "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":"my-entity-id", "applicationId":"my-application-id" }, "deviceDetails":"deviceDetails", "networkId":1, "campaignReferenceId":"campaignRef" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "message:send", "messages-api:message:send", "messages-api:manage" ] } }, "/messages-api/1/inbound":{ "get":{ "tags":[ "platform", "messages-api", "inbound-messages" ], "summary":"Get inbound messages", "description":"If you are unable to receive incoming messages to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"get-messages-api-inbound-messages", "parameters":[ { "name":"channel", "in":"query", "description":"Messaging channel for which inbound messages will be fetched.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoGetEndpointChannel" } }, { "name":"limit", "in":"query", "description":"Maximum number of messages to be returned in a response. If not set, last 50 records are returned. Maximum limit is `1000` and you can only access messages for the last 48h.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":2 }, { "name":"applicationId", "in":"query", "description":"Application ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"marketing-automation-application" }, { "name":"entityId", "in":"query", "description":"Entity ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"promotional-traffic-entity" }, { "name":"campaignReferenceId", "in":"query", "description":"ID of a campaign that message belongs to.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"mycampaign" } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessageResponse" }, "examples":{ "Received text message example":{ "summary":"Received text message example", "value":{ "results":[ { "channel":"SMS", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text message 123", "cleanText":"Text message", "type":"TEXT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received text message with keyword example":{ "summary":"Received text message with keyword example", "value":{ "results":[ { "channel":"SMS", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"KWRDText message 123", "cleanText":"Text message", "keyword":"KWRD", "type":"TEXT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received image with caption message example":{ "summary":"Received image with caption message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/image.jpg", "text":"Image caption", "type":"IMAGE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received audio with caption message example":{ "summary":"Received audio with caption message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-audio", "text":"Audio caption", "type":"AUDIO" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received audio with subject and text message example (MMS only)":{ "summary":"Received audio with subject and text message example (MMS only)", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-audio", "text":"Audio caption", "type":"AUDIO" }, { "text":"Text message", "cleanText":"Text message", "type":"TEXT" }, { "text":"KEYWORD Some subject", "cleanText":"Some subject", "keyword":"KEYWORD", "type":"SUBJECT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received video with caption example":{ "summary":"Received video with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-video", "text":"Video caption", "type":"VIDEO" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received document with caption example":{ "summary":"Received document with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-document", "text":"Document caption", "type":"DOCUMENT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received file with caption example":{ "summary":"Received file with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received multiple file with caption example":{ "summary":"Received multiple file with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" }, { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received location with url example":{ "summary":"Received location with url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "latitude":16.0, "longitude":18.0, "url":"http://my.domain/media/my-location", "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received location without url example":{ "summary":"Received location without url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "latitude":16.0, "longitude":18.0, "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received location only with url example":{ "summary":"Received location only with url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-location", "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received list reply example":{ "summary":"Received list reply example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text for selected option", "id":"selectedItemId", "type":"LIST_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received list reply with multiple item selected example":{ "summary":"Received list reply with multiple item selected example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text for first selected option ", "id":"selectedItemIdFirst", "type":"LIST_REPLY" }, { "text":"Text for second selected option", "id":"selectedItemIdSecond", "type":"LIST_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received button message example":{ "summary":"Received button message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Yes", "payload":"true", "id":"1", "type":"BUTTON_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received flow response example":{ "summary":"Received flow response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "response":{ "rating":5, "additional_comment":"That was very nice :)", "flow_token":"tokenForTracking" }, "type":"FLOW_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received typing started event example":{ "summary":"Received typing started event example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"TYPING_STARTED" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received typing stopped event example":{ "summary":"Received typing stopped event example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"TYPING_STOPPED" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received payment response example":{ "summary":"Received payment response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "referenceId":"referenceId", "paymentId":"paymentId", "status":"SUCCESS", "total":{ "value":100, "currency":"BRL" }, "transaction":{ "id":"transactionId", "type":"UPI" }, "items":[ { "retailerId":"retailerId", "catalogId":"catalogId" } ], "type":"PAYMENT_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received form response example":{ "summary":"Received form response example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "content":[ { "isPrivate":false, "selections":[ { "type":"INPUT", "pageIdentifier":"0", "text":"Input text", "items":[ { "title":"Input item title", "value":"Input item value" } ] }, { "type":"PICKER", "pageIdentifier":"1", "text":"Picker text", "items":[ { "title":"Picker item title", "value":"Picker item value" } ] }, { "type":"DATE_PICKER", "pageIdentifier":"2", "text":"Date picker text", "items":[ { "title":"Date picker item title", "value":"2025-01-01T14:00:00.797+0000" } ] }, { "type":"SELECT", "pageIdentifier":"3", "text":"Select text", "items":[ { "title":"Select item title", "value":"Select item value" } ] }, { "type":"SELECT", "pageIdentifier":"4", "text":"Multi-select text", "items":[ { "title":"Multi-select item 1", "value":"Multi-select value 1" }, { "title":"Multi-select item 2", "value":"Multi-select value 2" } ] } ], "type":"FORM_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "metadata":{ "correlationData":"your-correlation-data" }, "event":"MO" } ], "messageCount":1, "pendingMessageCount":0 } }, "Received reaction response example":{ "summary":"Received reaction response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "emoji":"\\u2764\\uFE0F", "action":"ADDED", "type":"REACTION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received url response example":{ "summary":"Received url response example", "value":{ "results":[ { "channel":"MESSENGER", "sender":"731401526720514", "destination":"24060905360217212", "content":[ { "url":"http://my.domain/media/my-url", "type":"URL" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } } } } } }, "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":[ "inbound-message:read", "messages-api:manage" ] } } }, "components":{ "schemas":{ "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Channel":{ "type":"string", "enum":[ "APPLE_MB", "INSTAGRAM_DM", "LINE_ON", "MESSENGER", "MMS", "RCS", "SMS", "VIBER_BM", "VIBER_BOT", "WHATSAPP" ], "title":"Channel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryDay" } }, "from":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime" }, "to":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime" } }, "required":[ "days" ], "title":"DeliveryTimeWindow" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundDlrChannel":{ "type":"string", "description":"Messaging channel used for sending an event. `KAKAO, ZALO, VOICE or TELEGRAM` can be received with Smart Messaging.", "enum":[ "APPLE_MB", "INSTAGRAM_DM", "LINE_ON", "MESSENGER", "MMS", "RCS", "SMS", "VIBER_BM", "VIBER_BOT", "WHATSAPP", "KAKAO", "ZALO", "VOICE", "TELEGRAM" ], "title":"InboundDlrChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoEventChannel":{ "type":"string", "description":"Messaging channel using which the message was sent.", "enum":[ "APPLE_MB", "INSTAGRAM_DM", "MESSENGER", "MMS", "RCS", "SMS", "VIBER_BM", "VIBER_BOT", "WHATSAPP" ], "title":"InboundMoEventChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoGetEndpointChannel":{ "type":"string", "enum":[ "APPLE_MB", "MESSENGER", "MMS", "SMS", "VIBER_BM", "WHATSAPP" ], "title":"InboundMoGetEndpointChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundSeenChannel":{ "type":"string", "description":"Messaging channel used for sending an event.", "enum":[ "RCS", "VIBER_BM", "VIBER_BOT", "WHATSAPP" ], "title":"InboundSeenChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundTypingStartedChannel":{ "type":"string", "description":"Messaging channel used for sending a message.", "enum":[ "APPLE_MB", "RCS" ], "title":"InboundTypingStartedChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundTypingStoppedChannel":{ "type":"string", "description":"Messaging channel used for sending a message.", "enum":[ "APPLE_MB" ], "title":"InboundTypingStoppedChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination":{ "type":"object", "description":"Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**", "oneOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelsDestination" }, { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination" } ], "title":"MessageDestination" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageOrderingOptions":{ "type":"object", "description":"Message ordering options.", "properties":{ "respectOrder":{ "type":"boolean", "default":true, "description":"If set to `true`, messages will be sent in the same order as they are provided in the request." }, "stopOnFailure":{ "type":"boolean", "default":true, "description":"It can be used in combination with `respectOrder` to stop sending messages when first message from request fails." } }, "title":"MessageOrderingOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseDetails":{ "type":"object", "description":"Other details of the message.", "title":"MessageResponseDetails" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageStatus" }, "destination":{ "type":"string", "description":"The destination address of the message, i.e., its recipient." }, "details":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseDetails" } }, "title":"MessageResponseMessageResponseDetails" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover":{ "type":"object", "description":"Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.", "oneOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiFailover" }, { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFailover" } ], "title":"MessagesApiBaseFailover" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseMessage":{ "type":"object", "description":"Array of message objects of a single message or multiple messages sent under one bulk ID.", "oneOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessage" }, { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessage" } ], "title":"MessagesApiBaseMessage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButton":{ "type":"object", "description":"List of buttons of a card.", "discriminator":{ "propertyName":"type", "mapping":{ "QUICK_REPLY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateQuickReplyButton", "OPEN_URL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateOpenUrlButton", "PHONE_NUMBER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplatePhoneNumberButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButtonType" } }, "required":[ "type" ], "title":"MessagesApiCarouselTemplateButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButtonType":{ "type":"string", "enum":[ "QUICK_REPLY", "OPEN_URL", "PHONE_NUMBER" ], "title":"MessagesApiCarouselTemplateButtonType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateOpenUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButton" }, { "type":"object", "properties":{ "suffix":{ "type":"string", "description":"Extension of a URL defined in the registered template." } } } ], "required":[ "suffix", "type" ], "title":"MessagesApiCarouselTemplateOpenUrlButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplatePhoneNumberButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButton" } ], "required":[ "type" ], "title":"MessagesApiCarouselTemplatePhoneNumberButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateQuickReplyButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButton" }, { "type":"object", "properties":{ "postbackData":{ "type":"string", "description":"Custom client data that will be included in a user's response." } } } ], "required":[ "postbackData", "type" ], "title":"MessagesApiCarouselTemplateQuickReplyButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelDestination":{ "type":"object", "description":"An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel" }, "to":{ "type":"string", "description":"The destination address of the message associated with given channel. It can be alphanumeric or numeric." }, "messageId":{ "type":"string", "deprecated":true, "description":"The ID that uniquely identifies the message sent.", "maxLength":200, "minLength":0 } }, "required":[ "channel", "to" ], "title":"MessagesApiChannelDestination" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelsDestination":{ "type":"object", "description":"Represents a destination which can be specified by a `channel`. **It is required for a message failover**.", "properties":{ "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.", "maxLength":200, "minLength":0 }, "byChannel":{ "type":"array", "description":"An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelDestination" } } }, "required":[ "byChannel" ], "title":"Channels Destination" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDelivery":{ "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/api#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. The default setting is `false`." }, "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":"MessagesApiDelivery" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryError":{ "type":"object", "description":"Message error if occurred, 0 if there is no error.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Error group ID." }, "groupName":{ "type":"string", "description":"Error group name." }, "id":{ "type":"integer", "format":"int32", "description":"Error ID." }, "name":{ "type":"string", "description":"Error name." }, "description":{ "type":"string", "description":"Human-readable description of the error." }, "permanent":{ "type":"boolean", "description":"Tells if the error is permanent." } }, "required":[ "id" ], "title":"MessagesApiDeliveryError" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Incoming Delivery reports.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult" } } }, "required":[ "results" ], "title":"MessagesApiDeliveryReportResponse" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult":{ "type":"object", "description":"Incoming Delivery reports.", "properties":{ "event":{ "type":"string", "default":"DELIVERY", "description":"Event type (delivery report in this case)." }, "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundDlrChannel" }, "sender":{ "type":"string", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, "destination":{ "type":"string", "description":"Message destination address." }, "sentAt":{ "type":"string", "description":"Tells when the message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "doneAt":{ "type":"string", "description":"Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.). Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "callbackData":{ "type":"string", "description":"Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists)." }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of parts the message content was split into." }, "status":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryStatus" }, "error":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryError" }, "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" }, "deviceDetails":{ "type":"string", "description":"Device name if available." }, "mccMnc":{ "type":"integer", "format":"int32", "description":"Mobile country and network codes." }, "networkId":{ "type":"integer", "format":"int32", "description":"Network id dependent on Country." }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "required":[ "bulkId", "channel", "destination", "doneAt", "error", "event", "messageCount", "messageId", "sender", "sentAt", "status" ], "title":"MessagesApiDeliveryResult" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryStatus":{ "type":"object", "description":"Messaged status.", "properties":{ "groupId":{ "type":"integer", "format":"int32", "description":"Status group." }, "groupName":{ "type":"string", "description":"Status group name." }, "id":{ "type":"integer", "format":"int32", "description":"Status ID." }, "name":{ "type":"string", "description":"Status name." }, "description":{ "type":"string", "description":"Human-readable description of the status." } }, "required":[ "description", "groupId", "groupName", "id", "name" ], "title":"MessagesApiDeliveryStatus" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDescriptiveTotalAmount":{ "type":"object", "description":"Total amount of the order.", "properties":{ "value":{ "type":"number", "description":"Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "description":{ "type":"string", "description":"(Apple specific, required) Additional description of the amount." } }, "title":"MessagesApiDescriptiveTotalAmount" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventOptions":{ "type":"object", "description":"Event options.", "properties":{ "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTimeWindow" } }, "title":"MessagesApiEventOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventRequest":{ "type":"object", "properties":{ "events":{ "type":"array", "description":"Array of event objects of a single event or multiple events sent", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent" } } }, "required":[ "events" ], "title":"MessagesApiEventRequest" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiFailover":{ "type":"object", "description":"Configuration of a single failover step", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel" }, "sender":{ "type":"string", "description":"Sender for channel specified above." }, "content":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent" }, "validityPeriod":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod" } }, "required":[ "channel" ], "title":"Message failover" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent":{ "type":"object", "description":"Incoming messages", "discriminator":{ "propertyName":"event", "mapping":{ "MO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEvent", "TYPING_STARTED":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStartedEvent", "TYPING_STOPPED":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStoppedEvent" } }, "properties":{ "event":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEventType" } }, "required":[ "event" ], "title":"MessagesApiInboundEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEventType":{ "type":"string", "description":"Event type.", "enum":[ "MO", "TYPING_STARTED", "TYPING_STOPPED" ], "title":"MessagesApiInboundEventType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStartedEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundTypingStartedChannel" }, "sender":{ "type":"string", "description":"Identifier (usually number) of the party which sent the message." }, "destination":{ "type":"string", "description":"Sender provided during the activation process." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of the MT message that this MO message is a response to." }, "callbackData":{ "type":"string", "description":"Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists)." }, "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" } } } ], "required":[ "channel", "destination", "event", "messageId", "receivedAt", "sender" ], "title":"MessagesApiInboundTypingStartedEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStoppedEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundTypingStoppedChannel" }, "sender":{ "type":"string", "description":"Identifier (usually number) of the party which sent the message." }, "destination":{ "type":"string", "description":"Sender provided during the activation process." }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of the MT message that this MO message is a response to." }, "callbackData":{ "type":"string", "description":"Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists)." }, "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" } } } ], "required":[ "channel", "destination", "event", "messageId", "receivedAt", "sender" ], "title":"MessagesApiInboundTypingStoppedEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessage":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Incoming messages", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent" } } }, "required":[ "results" ], "title":"MessagesApiIncomingMessage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessageResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Incoming messages", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent" } }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of messages returned in the `results` array." }, "pendingMessageCount":{ "type":"integer", "format":"int32", "description":"The number of messages that have not been pulled in." } }, "required":[ "results" ], "title":"MessagesApiIncomingMessageResponse" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessage":{ "type":"object", "description":"Represents a single message.", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel" }, "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":"Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination" } }, "content":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent" }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions" }, "webhooks":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks" }, "failover":{ "type":"array", "description":"Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover" } } }, "required":[ "channel", "content", "destinations" ], "title":"Messages API message" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAddCalendarEventButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." }, "startTime":{ "type":"string", "format":"date-time", "description":"Event start time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "endTime":{ "type":"string", "format":"date-time", "description":"Event end time. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "title":{ "type":"string", "description":"Event title." }, "description":{ "type":"string", "description":"Event description." } } } ], "required":[ "endTime", "startTime", "text", "title", "type" ], "title":"MessagesApiMessageAddCalendarEventButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "merchantDomain":{ "type":"string", "description":"The domain of the merchant's website." }, "merchantDisplayName":{ "type":"string", "description":"The merchant's display name." }, "merchantPaymentGatewayUrl":{ "type":"string", "description":"The URL of the merchant's payment gateway. This is the URL that Apple Pay uses to process payments." }, "merchantCountryCode":{ "type":"string", "description":"The two-letter ISO 3166 merchant’s country code.", "pattern":"^[A-Z]{2}$" }, "currencyCode":{ "type":"string", "description":"The three-letter ISO 4217 currency code for the payment.", "pattern":"^[A-Z]{3}$" }, "merchantCapabilities":{ "type":"array", "description":"An array of payment capabilities supported by the merchant. The array must include 3DS.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationMerchantCapability" } }, "supportedNetworks":{ "type":"array", "description":"An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationNetwork" } }, "requiredBillingFields":{ "type":"array", "description":"The list of the customer's required billing information needed to process the transaction.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationContactField" } }, "requiredShippingFields":{ "type":"array", "description":"The list of shipping or contact information required from the customer to fulfill the order.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationContactField" } }, "paymentMethodUpdateUrl":{ "type":"string", "description":"Called by Apple Pay when the user changes the payment method." }, "shippingContactUpdateUrl":{ "type":"string", "description":"Called by Apple Pay when the user changes their shipping address information." }, "shippingMethodUpdateUrl":{ "type":"string", "description":"Called by Apple Pay when the user changes the shipping method." }, "orderTrackingUrl":{ "type":"string", "description":"Called by Apple Pay after completing the order provides you with an opportunity to update the order information in your system." }, "fallbackUrl":{ "type":"string", "description":"A URL that opens in a web browser so the user can complete the purchase if their device is unable to make payments using Apple Pay." } } } ], "required":[ "type" ], "title":"MessagesApiMessageApplePayPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationContactField":{ "type":"string", "description":"The list of shipping or contact information required from the customer to fulfill the order.", "enum":[ "POSTAL_ADDRESS", "EMAIL", "PHONE", "NAME", "PHONETIC_NAME" ], "title":"MessagesApiMessageApplePayPaymentConfigurationContactField" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationMerchantCapability":{ "type":"string", "description":"An array of payment capabilities supported by the merchant. The array must include 3DS.", "enum":[ "3DS", "CREDIT", "DEBIT", "EMV" ], "title":"MessagesApiMessageApplePayPaymentConfigurationMerchantCapability" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfigurationNetwork":{ "type":"string", "description":"An array of payment networks supported by the merchant. The array must include one or more of the following values: AMEX, DISCOVER, MASTERCARD, PRIVATE_LABEL or VISA.", "enum":[ "AMEX", "CHINA_UNION_PAY", "DISCOVER", "ELECTRON", "INTERAC", "MAESTRO", "MASTERCARD", "PRIVATE_LABEL", "VISA" ], "title":"MessagesApiMessageApplePayPaymentConfigurationNetwork" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAuthenticationRequestBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be sent." }, "scopes":{ "type":"array", "description":"Array that specifies the scopes of the request.", "items":{ "type":"string", "description":"Array that specifies the scopes of the request." } }, "imageUrl":{ "type":"string", "description":"URL of the image." } } } ], "required":[ "text", "type" ], "title":"MessagesApiMessageAuthenticationRequestBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody":{ "type":"object", "description":"Body of the message.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextBody", "IMAGE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageImageBody", "VIDEO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageVideoBody", "DOCUMENT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDocumentBody", "RICH_LINK":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRichLinkBody", "AUTHENTICATION_REQUEST":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAuthenticationRequestBody", "LIST":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListBody", "CAROUSEL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselBody", "LOCATION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageLocationBody", "CONTACT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContactBody", "STICKER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageStickerBody", "PRODUCT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageProductBody", "MIXED":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedBody", "FLOW":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowBody", "TIME_PICKER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerBody", "ORDER_REQUEST":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderRequestBody", "ORDER_STATUS":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusBody", "FORM":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormBody" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBodyType" } }, "required":[ "type" ], "title":"MessagesApiMessageBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBodyType":{ "type":"string", "enum":[ "TEXT", "IMAGE", "VIDEO", "DOCUMENT", "RICH_LINK", "AUTHENTICATION_REQUEST", "LIST", "CAROUSEL", "LOCATION", "CONTACT", "STICKER", "PRODUCT", "MIXED", "FLOW", "TIME_PICKER", "ORDER_REQUEST", "ORDER_STATUS", "FORM" ], "title":"MessagesApiMessageBodyType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilBoletoPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "code":{ "type":"string", "description":"Boleto code." } } } ], "required":[ "type" ], "title":"MessagesApiMessageBrazilBoletoPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilLinkPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "paymentLink":{ "type":"string", "description":"Payment link." } } } ], "required":[ "type" ], "title":"MessagesApiMessageBrazilLinkPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "name":{ "type":"string", "description":"Name of the WhatsApp payment configuration to be used for this order.", "maxLength":60, "minLength":1 } } } ], "required":[ "type" ], "title":"MessagesApiMessageBrazilPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPixDcPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "name":{ "type":"string", "description":"Name of the WhatsApp payment configuration to be used for this order. Can be omitted for Brazil PIX.", "maxLength":60, "minLength":1 }, "code":{ "type":"string", "description":"Dynamic Pix code which will be copied by the buyer." }, "merchantName":{ "type":"string", "description":"Pix account holder name." }, "keyType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPixDcPaymentContentKeyType" }, "key":{ "type":"string", "description":"Key to identify the pix user’s account." } } } ], "required":[ "type" ], "title":"MessagesApiMessageBrazilPixDcPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPixDcPaymentContentKeyType":{ "type":"string", "description":"Key type to identify the pix user’s account.", "enum":[ "CPF", "CNPJ", "EMAIL", "PHONE", "EVP" ], "title":"MessagesApiMessageBrazilPixDcPaymentContentKeyType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton":{ "type":"object", "description":"List of buttons of the message.", "discriminator":{ "propertyName":"type", "mapping":{ "REPLY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageReplyButton", "OPEN_URL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOpenUrlButton", "DIAL_PHONE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDialPhoneButton", "SHOW_LOCATION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageShowLocationButton", "REQUEST_LOCATION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRequestLocationButton", "ADD_CALENDAR_EVENT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAddCalendarEventButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButtonType" } }, "required":[ "type" ], "title":"MessagesApiMessageButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButtonType":{ "type":"string", "enum":[ "REPLY", "OPEN_URL", "DIAL_PHONE", "SHOW_LOCATION", "REQUEST_LOCATION", "ADD_CALENDAR_EVENT" ], "title":"MessagesApiMessageButtonType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptions":{ "type":"object", "description":"Set of alignment options for the Card.", "properties":{ "orientation":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsOrientationEnum" }, "alignment":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsAlignmentEnum" }, "height":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsHeightEnum" } }, "title":"MessagesApiMessageCardOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsAlignmentEnum":{ "type":"string", "default":"LEFT", "description":"Alignment of the card.", "enum":[ "LEFT", "RIGHT" ], "title":"MessagesApiMessageCardOptionsAlignmentEnum" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsHeightEnum":{ "type":"string", "default":"MEDIUM", "description":"Height of the card media.", "enum":[ "SHORT", "MEDIUM", "TALL" ], "title":"MessagesApiMessageCardOptionsHeightEnum" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptionsOrientationEnum":{ "type":"string", "default":"VERTICAL", "description":"Orientation of the card.", "enum":[ "HORIZONTAL", "VERTICAL" ], "title":"MessagesApiMessageCardOptionsOrientationEnum" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "cards":{ "type":"array", "description":"Carousel cards.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselCard" } } } } ], "required":[ "cards", "type" ], "title":"MessagesApiMessageCarouselBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselCard":{ "type":"object", "description":"Carousel cards.", "properties":{ "body":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselCardBody" }, "buttons":{ "type":"array", "description":"List of buttons of a card.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" } } }, "required":[ "body" ], "title":"MessagesApiMessageCarouselCard" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselCardBody":{ "type":"object", "description":"Body of a card.", "properties":{ "title":{ "type":"string", "description":"Title of the card." }, "text":{ "type":"string", "description":"Text to be sent." }, "url":{ "type":"string", "description":"URL of the card's media. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image." }, "isVideo":{ "type":"boolean", "default":false, "description":"Indicates if provided `url` is a video." }, "thumbnailUrl":{ "type":"string", "description":"URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`." }, "cardOptions":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptions" } }, "title":"MessagesApiMessageCarouselCardBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageConfirmationBody":{ "type":"object", "description":"Body of the confirmation message.", "properties":{ "text":{ "type":"string", "description":"Text to be sent." }, "description":{ "type":"string", "description":"Description to be sent." }, "imageUrl":{ "type":"string", "description":"URL of the image." } }, "required":[ "text" ], "title":"MessagesApiMessageConfirmationBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContactBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the contact." }, "phoneNumber":{ "type":"string", "description":"Phone number of the contact." } } } ], "required":[ "name", "phoneNumber", "type" ], "title":"MessagesApiMessageContactBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent":{ "type":"object", "description":"Content of the message.", "properties":{ "header":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader" }, "body":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, "buttons":{ "type":"array", "description":"List of buttons of the message.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" } }, "confirmationBody":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageConfirmationBody" }, "senderDisplayInfo":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSenderDisplayInfo" }, "footer":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFooter" } }, "required":[ "body" ], "title":"MessagesApiMessageContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDatePickerFormPage":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"Title of the page." }, "text":{ "type":"string", "description":"Text of the page." }, "pageIdentifier":{ "type":"string", "description":"Unique identifier of the page.", "maxLength":20, "minLength":0 }, "nextPageIdentifier":{ "type":"string", "description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.", "maxLength":20, "minLength":0 }, "submitForm":{ "type":"boolean", "description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages." }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDatePickerFormPageOptions" } } } ], "required":[ "pageIdentifier", "text", "type" ], "title":"MessagesApiMessageDatePickerFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDatePickerFormPageOptions":{ "type":"object", "description":"Options of the page.", "properties":{ "dateFormat":{ "type":"string", "description":"Date format used on the page e.g. `MM/dd/yyyy`." }, "startDate":{ "type":"string", "format":"date-time", "description":"Date displayed by the date picker. Has the following format: `YYYY-MM-DD`." }, "maximumDate":{ "type":"string", "format":"date-time", "description":"Maximum date that the date picker can show. Has the following format: `YYYY-MM-DD`." }, "minimumDate":{ "type":"string", "format":"date-time", "description":"Minimum date that the date picker can show. Has the following format: `YYYY-MM-DD`." }, "dateLabel":{ "type":"string", "description":"Text to be shown next to the date field." } }, "title":"MessagesApiMessageDatePickerFormPageOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDescriptiveDiscountAmount":{ "type":"object", "description":"(WhatsApp specific) Discount of the order.", "properties":{ "value":{ "type":"number", "description":"Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "description":{ "type":"string", "description":"Additional description of the amount. Optional for WhatsApp." } }, "title":"MessagesApiMessageDescriptiveDiscountAmount" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDescriptiveTaxAmount":{ "type":"object", "description":"(WhatsApp specific, required) Tax amount of the order.", "properties":{ "value":{ "type":"number", "description":"Value of the amount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "description":{ "type":"string", "description":"Additional description of the amount. Optional for WhatsApp." } }, "title":"MessagesApiMessageDescriptiveTaxAmount" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDialPhoneButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "phoneNumber":{ "type":"string", "description":"Valid phone number.", "pattern":"^\\+?[0-9]\\d{1,14}$" }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." } } } ], "required":[ "phoneNumber", "text", "type" ], "title":"MessagesApiMessageDialPhoneButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDocumentBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the document." }, "text":{ "type":"string", "description":"Document caption." }, "filename":{ "type":"string", "description":"Document filename." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMessageDocumentBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowAction":{ "type":"object", "description":"Action of the flow.", "discriminator":{ "propertyName":"type", "mapping":{ "NAVIGATE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowNavigateAction", "DATA_EXCHANGE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowDataExchangeAction" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowActionType" } }, "required":[ "type" ], "title":"MessagesApiMessageFlowAction" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowActionPayload":{ "type":"object", "description":"Payload of the action.", "properties":{ "screen":{ "type":"string", "description":"ID of the first screen of the flow." }, "data":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Input data for first screen of the flow. Must be a non-empty object." } }, "required":[ "screen" ], "title":"MessagesApiMessageFlowActionPayload" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowActionType":{ "type":"string", "enum":[ "NAVIGATE", "DATA_EXCHANGE" ], "title":"MessagesApiMessageFlowActionType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be sent." }, "id":{ "type":"string", "description":"ID of the flow." }, "token":{ "type":"string", "description":"Token of the flow." }, "buttonText":{ "type":"string", "description":"Button label text." }, "mode":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowMode" }, "action":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowAction" } } } ], "required":[ "action", "buttonText", "id", "text", "token", "type" ], "title":"MessagesApiMessageFlowBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowDataExchangeAction":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowAction" } ], "required":[ "type" ], "title":"MessagesApiMessageFlowDataExchangeAction" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowMode":{ "type":"string", "default":"PUBLISHED", "description":"Mode of the flow.", "enum":[ "DRAFT", "PUBLISHED" ], "title":"MessagesApiMessageFlowMode" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowNavigateAction":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowAction" }, { "type":"object", "properties":{ "payload":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowActionPayload" } } } ], "required":[ "payload", "type" ], "title":"MessagesApiMessageFlowNavigateAction" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFooter":{ "type":"object", "description":"Footer of the message.", "properties":{ "text":{ "type":"string", "description":"Text of the footer." } }, "required":[ "text" ], "title":"MessagesApiMessageFooter" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of the received message." }, "imageUrl":{ "type":"string", "description":"Image of the received message." }, "pages":{ "type":"array", "description":"An array of different pages to be shown in the form. If INTRO page is included it will always appear first.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" } }, "startPageIdentifier":{ "type":"string", "description":"Identifier for the starting page of the form. Must match one of the string identifiers for the configured pages.", "maxLength":20, "minLength":0 }, "isPrivate":{ "type":"boolean", "default":false, "description":"Indicates whether to mark the response as private." }, "showSummary":{ "type":"boolean", "default":false, "description":"If set to true then it shows the summary of all the selections made within the form." } } } ], "required":[ "pages", "startPageIdentifier", "text", "type" ], "title":"MessagesApiMessageFormBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage":{ "type":"object", "description":"An array of different pages to be shown in the form. If INTRO page is included it will always appear first.", "discriminator":{ "propertyName":"type", "mapping":{ "SELECT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSelectFormPage", "PICKER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePickerFormPage", "DATE_PICKER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDatePickerFormPage", "INPUT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPage", "INTRO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageIntroFormPage" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPageType" } }, "required":[ "type" ], "title":"MessagesApiMessageFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPageType":{ "type":"string", "enum":[ "INTRO", "SELECT", "PICKER", "DATE_PICKER", "INPUT" ], "title":"MessagesApiMessageFormPageType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPickerPageItem":{ "type":"object", "description":"An array of objects defining the user experience.", "properties":{ "identifier":{ "type":"string", "description":"Unique identifier of the item." }, "title":{ "type":"string", "description":"Title of the item." }, "value":{ "type":"string", "description":"Value of the item." } }, "required":[ "identifier", "title", "value" ], "title":"MessagesApiMessageFormPickerPageItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormSelectPageItem":{ "type":"object", "description":"An array of objects defining the user experience.", "properties":{ "identifier":{ "type":"string", "description":"Unique identifier of the item." }, "title":{ "type":"string", "description":"Title of the item." }, "value":{ "type":"string", "description":"Value of the item." }, "nextPageIdentifier":{ "type":"string", "description":"Identifier of the next page. Set this value only when multipleSelection is not defined or set to false.", "maxLength":20, "minLength":0 }, "imageUrl":{ "type":"string", "description":"Image of the item." } }, "required":[ "identifier", "title", "value" ], "title":"MessagesApiMessageFormSelectPageItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader":{ "type":"object", "description":"Header of the message.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextHeader" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeaderType" } }, "required":[ "type" ], "title":"MessagesApiMessageHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeaderType":{ "type":"string", "enum":[ "TEXT" ], "title":"MessagesApiMessageHeaderType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageImageBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the image." }, "text":{ "type":"string", "description":"Image caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMessageImageBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormInputType":{ "type":"string", "default":"SINGLELINE", "description":"Type of input.", "enum":[ "SINGLELINE", "MULTILINE" ], "title":"MessagesApiMessageInputFormInputType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPage":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"Title of the page." }, "text":{ "type":"string", "description":"Text of the page." }, "pageIdentifier":{ "type":"string", "description":"Unique identifier of the page.", "maxLength":20, "minLength":0 }, "nextPageIdentifier":{ "type":"string", "description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.", "maxLength":20, "minLength":0 }, "submitForm":{ "type":"boolean", "description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages." }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageOptions" } } } ], "required":[ "pageIdentifier", "text", "type" ], "title":"MessagesApiMessageInputFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageKeyboard":{ "type":"string", "default":"DEFAULT", "description":"Type of keyboard to be shown.", "enum":[ "DEFAULT", "ASCII_CAPABLE", "NUMBERS_AND_PUNCTUATION", "URL", "NUMBER_PAD", "PHONE_PAD", "NAME_PHONE_PAD", "EMAIL_ADDRESS", "DECIMAL_PAD", "TWITTER_KEYBOARD", "WEB_SEARCH" ], "title":"MessagesApiMessageInputFormPageKeyboard" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageOptions":{ "type":"object", "description":"Options of the page.", "properties":{ "hintText":{ "type":"string", "description":"Text to give the user more input context that displays below the Input field." }, "regex":{ "type":"string", "description":"String representing a JSON encoded regular expression (regex) string to limit the type of input for input field to use." }, "placeholder":{ "type":"string", "description":"Text string used when there is no other text in the input text field." }, "isRequired":{ "type":"boolean", "description":"When set to true, the next button on page is disabled until the user provides input." }, "inputType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormInputType" }, "labelText":{ "type":"string", "description":"Text label shown to identify the input field. Applicable only for SINGLELINE input type." }, "prefixText":{ "type":"string", "description":"String value representing optional text shown next to the text field. Applicable only for SINGLELINE input type." }, "maximumCharacterCount":{ "type":"integer", "format":"int32", "description":"Maximum field size in characters.", "minimum":0 }, "keyboardType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageKeyboard" }, "textContentType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageTextContentType" } }, "title":"MessagesApiMessageInputFormPageOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageInputFormPageTextContentType":{ "type":"string", "description":"Value representing the keyboard and system information about the expected semantic meaning for the content that users enter.", "enum":[ "NAME_PREFIX", "GIVEN_NAME", "MIDDLE_NAME", "FAMILY_NAME", "NAME_SUFFIX", "NICKNAME", "JOB_TITLE", "ORGANIZATION_NAME", "LOCATION", "FULL_STREET_ADDRESS", "STREET_ADDRESS_LINE_1", "STREET_ADDRESS_LINE_2", "ADDRESS_CITY", "ADDRESS_STATE", "ADDRESS_CITY_STATE", "SUBLOCALITY", "COUNTRY_NAME", "POSTAL_CODE", "PHONE_NUMBER", "EMAIL_ADDRESS", "URL", "CREDIT_CARD_NUMBER", "USERNAME", "PASSWORD", "NEW_PASSWORD", "ONE_TIME_CODE" ], "title":"MessagesApiMessageInputFormPageTextContentType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageIntroFormPage":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"If set, it displays in bold the title on the main page underneath the image." }, "text":{ "type":"string", "description":"If set, displays additional text on the main page underneath the title." }, "buttonText":{ "type":"string", "description":"Text on the button shown on the main page. If missing then this view doesn't display and continues onto the first module." }, "imageUrl":{ "type":"string", "description":"Image to be shown at the top of the main page." } } } ], "required":[ "type" ], "title":"MessagesApiMessageIntroFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be sent." }, "subtext":{ "type":"string", "description":"Subtext to be sent." }, "imageUrl":{ "type":"string", "description":"URL of the image." }, "sections":{ "type":"array", "description":"Section's list.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListSection" } } } } ], "required":[ "sections", "text", "type" ], "title":"MessagesApiMessageListBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListItem":{ "type":"object", "description":"List Items.", "properties":{ "id":{ "type":"string", "description":"Item ID (supported only by WhatsApp), has to be unique for each item." }, "text":{ "type":"string", "description":"Item Text." }, "description":{ "type":"string", "description":"Item Description." }, "imageUrl":{ "type":"string", "description":"Item's Image URL." } }, "required":[ "text" ], "title":"MessagesApiMessageListItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListSection":{ "type":"object", "description":"Section's list.", "properties":{ "sectionTitle":{ "type":"string", "description":"Section's title" }, "multipleSelection":{ "type":"boolean", "description":"Multiple Selection." }, "items":{ "type":"array", "description":"List Items.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListItem" } } }, "required":[ "items", "sectionTitle" ], "title":"MessagesApiMessageListSection" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageLocationBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location.", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location.", "maximum":180, "minimum":-180 }, "name":{ "type":"string", "description":"Location name.", "maxLength":1000, "minLength":0 }, "address":{ "type":"string", "description":"Location address.", "maxLength":1000, "minLength":0 } } } ], "required":[ "latitude", "longitude", "type" ], "title":"MessagesApiMessageLocationBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"Mixed items.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedItem" } } } } ], "required":[ "items", "type" ], "title":"MessagesApiMessageMixedBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedItem":{ "type":"object", "description":"Mixed items.", "oneOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedMediaItem" }, { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedTextItem" } ], "title":"MessagesApiMessageMixedItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedMediaItem":{ "type":"object", "description":"Supported by APPLE_MB, MMS", "properties":{ "url":{ "type":"string", "description":"URL of the media's item." } }, "required":[ "url" ], "title":"Media" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedTextItem":{ "type":"object", "description":"Supported by MMS", "properties":{ "text":{ "type":"string", "description":"Text to be sent." } }, "required":[ "text" ], "title":"Text" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOpenUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "url":{ "type":"string", "description":"URL to be opened when clicked on the button." }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." }, "openIn":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOpenUrlButtonOpenIn" } } } ], "required":[ "text", "type", "url" ], "title":"MessagesApiMessageOpenUrlButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions":{ "type":"object", "description":"Message options.", "properties":{ "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" }, "validityPeriod":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod" }, "deliveryTimeWindow":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTimeWindow" }, "adaptationMode":{ "type":"boolean", "default":true, "description":"If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified." }, "regional":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RegionalOptions" }, "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." }, "transliteration":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TransliterationCode" }, "correlationData":{ "type":"string", "description":"Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.", "maxLength":100, "minLength":1 }, "trafficType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTrafficType" }, "sessionRate":{ "type":"boolean", "description":"Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true." }, "primaryDevice":{ "type":"boolean", "description":"Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message." } }, "title":"MessagesApiMessageOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrder":{ "type":"object", "description":"Payment request order.", "properties":{ "catalogId":{ "type":"string", "description":"(WhatsApp specific) ID that uniquely identifies the [catalog](https://www.infobip.com/docs/api/platform/catalogs-api) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to." }, "currency":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderCurrency" }, "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderType" }, "detailsType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderDetailsType" }, "items":{ "type":"array", "description":"An array of items in the order.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderItem" } }, "expiration":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderExpiration" } }, "title":"MessagesApiMessageOrder" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderCurrency":{ "type":"string", "description":"(WhatsApp specific, required) Order currency.", "enum":[ "INR", "BRL" ], "title":"MessagesApiMessageOrderCurrency" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderDetailsType":{ "type":"string", "description":"(WhatsApp specific) A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.", "enum":[ "QUICK_PAY" ], "title":"MessagesApiMessageOrderDetailsType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderExpiration":{ "type":"object", "description":"(WhatsApp specific) Expiration of the order.", "properties":{ "timestamp":{ "type":"string", "format":"date-time", "description":"Timestamp of the expiration. Must be at least 5 minutes in the future." }, "description":{ "type":"string", "description":"Description of the expiration.", "maxLength":120, "minLength":0 } }, "title":"MessagesApiMessageOrderExpiration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderImporter":{ "type":"object", "description":"(WhatsApp specific) Importer data. Required when catalogId is not provided. It's supported only for UPI PayU payments.", "properties":{ "name":{ "type":"string", "description":"Name of the importer. Required when catalogId is not provided." }, "address":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderImporterAddress" }, "originCountry":{ "type":"string", "description":"Country of origin. Required when catalogId is not provided." } }, "title":"MessagesApiMessageOrderImporter" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderImporterAddress":{ "type":"object", "description":"Address of the importer. Required when catalogId is not provided.", "properties":{ "firstAddressLine":{ "type":"string", "description":"First address line." }, "secondAddressLine":{ "type":"string", "description":"Second address line." }, "city":{ "type":"string", "description":"City name." }, "zoneCode":{ "type":"string", "description":"Zone code value." }, "postalCode":{ "type":"string", "description":"Zip code value." }, "countryCode":{ "type":"string", "description":"Country code value." } }, "title":"MessagesApiMessageOrderImporterAddress" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderItem":{ "type":"object", "description":"An array of items in the order.", "properties":{ "name":{ "type":"string", "description":"Name of the item." }, "retailerId":{ "type":"string", "description":"(WhatsApp specific, and required) Product-unique identifier, as defined in catalog." }, "quantity":{ "type":"integer", "format":"int32", "description":"(WhatsApp specific) Item quantity." }, "amount":{ "type":"number", "description":"Price of the item (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "saleAmount":{ "type":"number", "description":"(WhatsApp specific) Item discount (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "importer":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderImporter" } }, "required":[ "amount", "name" ], "title":"MessagesApiMessageOrderItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderRequestBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Payment request title." }, "subtext":{ "type":"string", "description":"(Apple specific) Payment request subtitle" }, "imageUrl":{ "type":"string", "description":"URL of an image sent." }, "order":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrder" }, "payment":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePayment" }, "shippings":{ "type":"array", "description":"An array of shipping information. For WhatsApp only one item allowed, for Apple many allowed.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageShipping" } } } } ], "required":[ "payment", "text", "type" ], "title":"MessagesApiMessageOrderRequestBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"Content of the message body." }, "id":{ "type":"string", "description":"Unique identifier of the payment." }, "orderType":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusOrderType" }, "orderStatus":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusOrderStatus" }, "description":{ "type":"string", "description":"Description of the order status." } } } ], "required":[ "id", "orderStatus", "orderType", "type" ], "title":"MessagesApiMessageOrderStatusBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusOrderStatus":{ "type":"string", "description":"Status of the order.", "enum":[ "PENDING", "PROCESSING", "PARTIALLY_SHIPPED", "SHIPPED", "COMPLETED", "CANCELED" ], "title":"MessagesApiMessageOrderStatusOrderStatus" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusOrderType":{ "type":"string", "description":"Type of the order payment.", "enum":[ "UPI_PAYU", "BRAZIL", "BRAZIL_PIX_DC", "PG_PAYU", "PG_RAZORPAY", "BRAZIL_LINK", "BRAZIL_BOLETO", "UPI_INTENT" ], "title":"MessagesApiMessageOrderStatusOrderType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderType":{ "type":"string", "description":"(WhatsApp specific, required) Type of the goods in the order.", "enum":[ "PHYSICAL_GOODS", "DIGITAL_GOODS" ], "title":"MessagesApiMessageOrderType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePayment":{ "type":"object", "description":"Request payment data.", "properties":{ "configuration":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, "total":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDescriptiveTotalAmount" }, "subtotal":{ "type":"number", "description":"(WhatsApp specific, required) Sub-total amount of the order (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "tax":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDescriptiveTaxAmount" }, "discount":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDescriptiveDiscountAmount" } }, "title":"MessagesApiMessagePayment" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiary":{ "type":"object", "description":"Beneficiary of the payment.", "properties":{ "name":{ "type":"string", "description":"Beneficiary's name.", "maxLength":200, "minLength":0 }, "firstAddressLine":{ "type":"string", "description":"First address line.", "maxLength":100, "minLength":0 }, "secondAddressLine":{ "type":"string", "description":"Second address line.", "maxLength":100, "minLength":0 }, "city":{ "type":"string", "description":"City name." }, "state":{ "type":"string", "description":"State name." }, "country":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiaryCountry" }, "postalCode":{ "type":"string", "description":"Zip code value.", "pattern":"^[0-9]{6}$" } }, "title":"MessagesApiMessagePaymentBeneficiary" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiaryCountry":{ "type":"string", "description":"Country name.", "enum":[ "INDIA" ], "title":"MessagesApiMessagePaymentBeneficiaryCountry" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration":{ "type":"object", "description":"Required for WhatsApp, optional for Apple. Type of the payment.", "discriminator":{ "propertyName":"type", "mapping":{ "PG_PAYU":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePgPayuPaymentConfiguration", "PG_RAZORPAY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiPgRazorpayPaymentConfiguration", "UPI_PAYU":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiPayuPaymentConfiguration", "BRAZIL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPaymentConfiguration", "BRAZIL_PIX_DC":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilPixDcPaymentConfiguration", "BRAZIL_LINK":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilLinkPaymentConfiguration", "BRAZIL_BOLETO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBrazilBoletoPaymentConfiguration", "UPI_INTENT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiIntentPaymentConfiguration", "APPLE_PAY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageApplePayPaymentConfiguration" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfigurationType" } }, "required":[ "type" ], "title":"MessagesApiMessagePaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfigurationType":{ "type":"string", "enum":[ "PG_PAYU", "PG_RAZORPAY", "UPI_PAYU", "BRAZIL", "BRAZIL_PIX_DC", "BRAZIL_LINK", "BRAZIL_BOLETO", "UPI_INTENT", "APPLE_PAY" ], "title":"MessagesApiMessagePaymentConfigurationType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePgPayuPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "name":{ "type":"string", "description":"Name of the WhatsApp payment configuration to be used for this order.", "maxLength":60, "minLength":1 }, "beneficiary":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiary" }, "callbackData":{ "type":"array", "description":"List of custom parameters corresponding to the transaction.", "items":{ "type":"string", "description":"List of custom parameters corresponding to the transaction.", "maxLength":255, "minLength":1 }, "maxItems":4, "minItems":0 } } } ], "required":[ "type" ], "title":"MessagesApiMessagePgPayuPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePickerFormPage":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"Title of the page." }, "text":{ "type":"string", "description":"Text of the page." }, "pageIdentifier":{ "type":"string", "description":"Unique identifier of the page.", "maxLength":20, "minLength":0 }, "nextPageIdentifier":{ "type":"string", "description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.", "maxLength":20, "minLength":0 }, "items":{ "type":"array", "description":"An array of objects defining the user experience.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPickerPageItem" } }, "submitForm":{ "type":"boolean", "description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages." }, "subtext":{ "type":"string", "description":"Text shown next to the picker text field." }, "selectedItemIndex":{ "type":"integer", "format":"int32", "default":0, "description":"A zero-indexed number identifying the item in the picker wheel should be selected by default.", "minimum":0 } } } ], "required":[ "items", "pageIdentifier", "text", "type" ], "title":"MessagesApiMessagePickerFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageProductBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Content of message body. Required only for multi-product messages." }, "catalogId":{ "type":"string", "description":"The ID that uniquely identifies the catalog" }, "sections":{ "type":"array", "description":"An array of product sections. Header and title fields are required in case of multiple products.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageProductSection" } } } } ], "required":[ "catalogId", "sections", "type" ], "title":"MessagesApiMessageProductBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageProductSection":{ "type":"object", "description":"An array of product sections. Header and title fields are required in case of multiple products.", "properties":{ "title":{ "type":"string", "description":"The title of the section. Required, if the message has more than one section." }, "productRetailerIds":{ "type":"array", "description":"Unique product identifier, as defined in catalog.", "items":{ "type":"string", "description":"Unique product identifier, as defined in catalog." } } }, "required":[ "productRetailerIds" ], "title":"MessagesApiMessageProductSection" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageReplyButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." } } } ], "required":[ "text", "type" ], "title":"MessagesApiMessageReplyButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRequestLocationButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." } } } ], "required":[ "type" ], "title":"MessagesApiMessageRequestLocationButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRichLinkBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "redirectUrl":{ "type":"string", "description":"URL to be redirected to." }, "text":{ "type":"string", "description":"Text to be sent." }, "url":{ "type":"string", "description":"URL of the rich link. It can be image or video. When you provide it with `isVideo=true` then it will be mapped as a video, otherwise - as an image." }, "isVideo":{ "type":"boolean", "default":false, "description":"Indicates if provided `url` is a video." }, "thumbnailUrl":{ "type":"string", "description":"URL of the thumbnail image. If you add this, then we use as thumbnail image for video you provided in `url`. Applicable only when `isVideo=true`." }, "buttonText":{ "type":"string", "description":"Button label text." }, "cardOptions":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCardOptions" } } } ], "required":[ "redirectUrl", "text", "type", "url" ], "title":"MessagesApiMessageRichLinkBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSelectFormPage":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormPage" }, { "type":"object", "properties":{ "title":{ "type":"string", "description":"Title of the page." }, "text":{ "type":"string", "description":"Text of the page." }, "pageIdentifier":{ "type":"string", "description":"Unique identifier of the page.", "maxLength":20, "minLength":0 }, "nextPageIdentifier":{ "type":"string", "description":"Identifier of the next page. If not set, the client assumes the current page to be the final page.", "maxLength":20, "minLength":0 }, "items":{ "type":"array", "description":"An array of objects defining the user experience.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormSelectPageItem" } }, "submitForm":{ "type":"boolean", "description":"Placed on the pages to denote the end page of the form. Can be set on multiple pages." }, "multipleSelection":{ "type":"boolean", "default":false, "description":"Enables multiple selection for the page." } } } ], "required":[ "items", "pageIdentifier", "text", "type" ], "title":"MessagesApiMessageSelectFormPage" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSenderDisplayInfo":{ "type":"object", "description":"Sender display info (name and avatar). Used only for Viber Bot messages.", "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":"MessagesApiMessageSenderDisplayInfo" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageShipping":{ "type":"object", "description":"An array of shipping information. For WhatsApp only one item allowed, for Apple many allowed.", "properties":{ "amount":{ "type":"number", "description":"Amount of shipping cost (up to 2 decimal places). For WhatsApp it has to be multiplied by offset (100 for `INR` and `BRL`)" }, "description":{ "type":"string", "description":"(Apple specific and required) Additional description of shipping cost. Optional for WhatsApp." }, "identifier":{ "type":"string", "description":"(Apple specific and required) Client-defined value used to identify this shipping method." }, "label":{ "type":"string", "description":"(Apple specific and required) Short description of the shipping method." } }, "required":[ "amount" ], "title":"MessagesApiMessageShipping" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageShowLocationButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be displayed on the button." }, "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location.", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location.", "maximum":180, "minimum":-180 }, "name":{ "type":"string", "description":"Location name.", "maxLength":1000, "minLength":0 }, "postbackData":{ "type":"string", "description":"Custom data that will be sent to you when the user replies to the message." } } } ], "required":[ "latitude", "longitude", "text", "type" ], "title":"MessagesApiMessageShowLocationButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageStickerBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "reference":{ "type":"string", "description":"Unique reference to the sticker. It can be URL or identifier. If it is URL, resource should be of WebP type." } } } ], "required":[ "reference", "type" ], "title":"MessagesApiMessageStickerBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be sent." } } } ], "required":[ "text", "type" ], "title":"MessagesApiMessageTextBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of the header." } } } ], "required":[ "text", "type" ], "title":"MessagesApiMessageTextHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text to be sent." }, "subtext":{ "type":"string", "description":"Subtext to be sent." }, "imageUrl":{ "type":"string", "description":"URL of the image." }, "event":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerEvent" } } } ], "required":[ "event", "text", "type" ], "title":"MessagesApiMessageTimePickerBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerEvent":{ "type":"object", "description":"Event with possible occurrences and location.", "properties":{ "title":{ "type":"string", "description":"Title of event." }, "timeslots":{ "type":"array", "description":"Possible timeslots for event.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerTimeslot" } }, "location":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerLocation" }, "imageUrl":{ "type":"string", "description":"URL of the event's image." } }, "required":[ "timeslots", "title" ], "title":"MessagesApiMessageTimePickerEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerLocation":{ "type":"object", "description":"Location of the event.", "properties":{ "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location.", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location.", "maximum":180, "minimum":-180 }, "radius":{ "type":"number", "format":"double", "description":"Radius of the location in meters.", "maximum":1000000, "minimum":0 }, "name":{ "type":"string", "description":"Name of the location." } }, "required":[ "latitude", "longitude", "name" ], "title":"MessagesApiMessageTimePickerLocation" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerTimeslot":{ "type":"object", "description":"Possible timeslots for event.", "properties":{ "duration":{ "type":"integer", "format":"int32", "description":"Duration of the time slot in seconds.", "minimum":0 }, "startTime":{ "type":"string", "format":"date-time", "description":"Event start time. UTC string in ISO-8601 format. On end-user phone it is converted to their timezone." }, "identifier":{ "type":"string", "description":"Identifier of timeslot. Will be autogenerated if not provided." } }, "required":[ "duration", "startTime" ], "title":"MessagesApiMessageTimePickerTimeslot" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiIntentPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "beneficiary":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiary" }, "format":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentFormat" } } } ], "required":[ "type" ], "title":"MessagesApiMessageUpiIntentPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiPayuPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment.", "maxLength":25, "minLength":1 }, "name":{ "type":"string", "description":"Name of the WhatsApp payment configuration to be used for this order.", "maxLength":60, "minLength":1 }, "productDescription":{ "type":"string", "description":"Brief description of products in this order.", "maxLength":100, "minLength":1 }, "customerFirstName":{ "type":"string", "description":"Customer's first name.", "maxLength":60, "minLength":1 }, "customerLastName":{ "type":"string", "description":"Customer's last name.", "maxLength":20, "minLength":0 }, "customerEmail":{ "type":"string", "description":"Customer's email.", "maxLength":50, "minLength":1 }, "callbackData":{ "type":"array", "description":"List of custom parameters corresponding to the transaction.", "items":{ "type":"string", "description":"List of custom parameters corresponding to the transaction.", "maxLength":255, "minLength":0 }, "maxItems":5, "minItems":0 } } } ], "required":[ "type" ], "title":"MessagesApiMessageUpiPayuPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageUpiPgRazorpayPaymentConfiguration":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentConfiguration" }, { "type":"object", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the payment. It can only contain English letters, numbers, underscores, dashes, or dots, and should not exceed 35 characters" }, "name":{ "type":"string", "description":"Name of the WhatsApp payment configuration to be used for this order.", "maxLength":60, "minLength":1 }, "beneficiary":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessagePaymentBeneficiary" }, "callbackData":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Object with key value pairs containing custom parameters corresponding to the transaction." } } } ], "required":[ "type" ], "title":"MessagesApiMessageUpiPgRazorpayPaymentConfiguration" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageVideoBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the video." }, "text":{ "type":"string", "description":"Video caption." }, "thumbnailUrl":{ "type":"string", "description":"URL of the thumbnail of the video (required and used only for Viber messages)." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMessageVideoBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoEventChannel" }, "sender":{ "type":"string", "description":"Identifier (usually number) of the party which sent the message." }, "destination":{ "type":"string", "description":"Sender provided during the activation process." }, "content":{ "type":"array", "description":"Content of the message.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" } }, "receivedAt":{ "type":"string", "format":"date-time", "description":"Date and time when Infobip received the message." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "pairedMessageId":{ "type":"string", "description":"Message ID of the MT message that this MO message is a response to." }, "callbackData":{ "type":"string", "description":"Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists)." }, "messageCount":{ "type":"integer", "format":"int32", "description":"The number of parts the message content was split into." }, "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the MT message" }, "metadata":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventMetadata" } } } ], "required":[ "channel", "content", "destination", "event", "messageCount", "messageId", "receivedAt", "sender" ], "title":"MessagesApiMoEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventAudioContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the audio." }, "text":{ "type":"string", "description":"Audio caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventAudioContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventAuthenticationResponseContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "authCode":{ "type":"string", "description":"Authentication code." }, "error":{ "type":"string", "description":"Error in case of unsuccessful authentication." } } } ], "required":[ "type" ], "title":"MessagesApiMoEventAuthenticationResponseContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventButtonReplyContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Title of the selected button." }, "payload":{ "type":"string", "description":"Payload of the selected button." }, "id":{ "type":"string", "description":"Identifier of the selected button." } } } ], "required":[ "text", "type" ], "title":"MessagesApiMoEventButtonReplyContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent":{ "type":"object", "description":"Content of the message.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventTextContent", "SUBJECT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventSubjectContent", "IMAGE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventImageContent", "AUDIO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventAudioContent", "VIDEO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventVideoContent", "DOCUMENT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventDocumentContent", "FILE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFileContent", "URL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventUrlContent", "BUTTON_REPLY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventButtonReplyContent", "LIST_REPLY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventListReplyContent", "LOCATION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventLocationContent", "AUTHENTICATION_RESPONSE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventAuthenticationResponseContent", "FLOW_RESPONSE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFlowResponseContent", "PAYMENT_RESPONSE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentResponseContent", "FORM_RESPONSE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormContent", "REACTION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventReactionContent" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContentType" } }, "required":[ "type" ], "title":"MessagesApiMoEventContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContentType":{ "type":"string", "enum":[ "TEXT", "SUBJECT", "IMAGE", "AUDIO", "VIDEO", "DOCUMENT", "FILE", "URL", "BUTTON_REPLY", "LIST_REPLY", "LOCATION", "AUTHENTICATION_RESPONSE", "FLOW_RESPONSE", "PAYMENT_RESPONSE", "FORM_RESPONSE", "REACTION" ], "title":"MessagesApiMoEventContentType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventDocumentContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the document." }, "text":{ "type":"string", "description":"Document caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventDocumentContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFileContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the file." }, "text":{ "type":"string", "description":"File caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventFileContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFlowResponseContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "response":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Flow response payload." } } } ], "required":[ "response", "type" ], "title":"MessagesApiMoEventFlowResponseContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "isPrivate":{ "type":"boolean", "description":"Indicates if response is private." }, "selections":{ "type":"array", "description":"List of user responses.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormSelection" } } } } ], "required":[ "selections", "type" ], "title":"MessagesApiMoEventFormContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormItem":{ "type":"object", "description":"List of selected items or values provided by the user for this form selection.", "properties":{ "title":{ "type":"string", "description":"Title of the item." }, "value":{ "type":"string", "description":"Value of the item." } }, "required":[ "title", "value" ], "title":"MessagesApiMoEventFormItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormSelection":{ "type":"object", "description":"List of user responses.", "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormSelectionType" }, "pageIdentifier":{ "type":"string", "description":"Identifier of the form page where the selection was made." }, "text":{ "type":"string", "description":"Text of selection." }, "items":{ "type":"array", "description":"List of selected items or values provided by the user for this form selection.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormItem" } } }, "required":[ "items", "pageIdentifier", "text", "type" ], "title":"MessagesApiMoEventFormSelection" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventFormSelectionType":{ "type":"string", "description":"Type of selection.", "enum":[ "PICKER", "DATE_PICKER", "INPUT", "SELECT" ], "title":"MessagesApiMoEventFormSelectionType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventImageContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the image." }, "text":{ "type":"string", "description":"Image caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventImageContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventListReplyContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of the selected reply." }, "id":{ "type":"string", "description":"Identifier of the selected reply." } } } ], "required":[ "id", "text", "type" ], "title":"MessagesApiMoEventListReplyContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventLocationContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location." }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location." }, "url":{ "type":"string", "description":"URL of the location." } } } ], "required":[ "type" ], "title":"MessagesApiMoEventLocationContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventMetadata":{ "type":"object", "description":"Additional information associated with the message", "properties":{ "correlationData":{ "type":"string", "description":"Correlation data included in the outbound message. Auto-generated if not set explicitly." } }, "title":"MessagesApiMoEventMetadata" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentCurrency":{ "type":"string", "description":"(WhatsApp specific) Currency of the payment.", "enum":[ "INR", "BRL", "UNKNOWN" ], "title":"MessagesApiMoEventPaymentCurrency" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentItem":{ "type":"object", "description":"Items information included in the incoming message.", "properties":{ "name":{ "type":"string", "description":"(Apple specific) A short, localized description of the item." }, "amount":{ "type":"number", "description":"(Apple specific) The monetary amount of the item." }, "retailerId":{ "type":"string", "description":"(WhatsApp specific) Product unique identifier, as defined in catalog." }, "catalogId":{ "type":"string", "description":"(WhatsApp specific) The ID that uniquely identifies the catalog registered with Facebook, connected to the WhatsApp Business Account (WABA) the sender belongs to." } }, "title":"MessagesApiMoEventPaymentItem" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentResponseContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "referenceId":{ "type":"string", "description":"(WhatsApp specific) Unique identifier generated by the payment service provider." }, "paymentId":{ "type":"string", "description":"(WhatsApp specific) Unique identifier of the payment." }, "status":{ "type":"string", "description":"Status of the payment." }, "total":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTotal" }, "transaction":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTransaction" }, "items":{ "type":"array", "description":"Items information included in the incoming message.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentItem" } } } } ], "required":[ "status", "total", "type" ], "title":"MessagesApiMoEventPaymentResponseContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTotal":{ "type":"object", "description":"Total amount of the payment.", "properties":{ "value":{ "type":"number", "description":"Value of the payment amount. In case of Apple it represents a value of all items. In case of WhatsApp it represents a value multiplied by the offset." }, "description":{ "type":"string", "description":"(Apple specific) A short localized description." }, "currency":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentCurrency" } }, "title":"MessagesApiMoEventPaymentTotal" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTransaction":{ "type":"object", "description":"(WhatsApp specific) Transaction of the payment.", "properties":{ "id":{ "type":"string", "description":"(WhatsApp specific) Unique identifier of the transaction." }, "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTransactionType" } }, "title":"MessagesApiMoEventPaymentTransaction" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventPaymentTransactionType":{ "type":"string", "description":"(WhatsApp specific) Type of the transaction.", "enum":[ "UPI", "BR", "UNKNOWN" ], "title":"MessagesApiMoEventPaymentTransactionType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventReactionContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "emoji":{ "type":"string", "description":"Emoji used in the reaction." }, "action":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ReactionActionType" } } } ], "required":[ "type" ], "title":"MessagesApiMoEventReactionContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventSubjectContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Subject of the message." }, "cleanText":{ "type":"string", "description":"Subject of the message without the keyword (if a keyword was sent)." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message subject." } } } ], "required":[ "cleanText", "text", "type" ], "title":"MessagesApiMoEventSubjectContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventTextContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "text":{ "type":"string", "description":"Text of the message." }, "cleanText":{ "type":"string", "description":"Text of the message without the keyword (if a keyword was sent)." }, "keyword":{ "type":"string", "description":"Keyword extracted from the message text." } } } ], "required":[ "cleanText", "text", "type" ], "title":"MessagesApiMoEventTextContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventUrlContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the content." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventUrlContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventVideoContent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEventContent" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of the video." }, "text":{ "type":"string", "description":"Video caption." } } } ], "required":[ "type", "url" ], "title":"MessagesApiMoEventVideoContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOpenUrlButtonOpenIn":{ "type":"string", "description":"Options available for RCS. Type of the URL open application. It is used to define how URL will be opened on a mobile phone. If it is not specified or if device does not support webviews, URL will be opened using browser. Following options are available:\n* `BROWSER`: Browser will be used on a mobile phone to open URL.\n* `WEBVIEW_FULL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up the full screen on a mobile phone.\n* `WEBVIEW_HALF`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up half of the screen on a mobile phone.\n* `WEBVIEW_TALL`: Integrated webview window will be used on a mobile phone to open URL. The web page takes up three quarters of the screen on a mobile phone.\n", "enum":[ "BROWSER", "WEBVIEW_FULL", "WEBVIEW_HALF", "WEBVIEW_TALL" ], "title":"MessagesApiOpenUrlButtonOpenIn" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent":{ "type":"object", "description":"Array of event objects of a single event or multiple events sent", "discriminator":{ "propertyName":"event", "mapping":{ "TYPING_STARTED":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStartedEvent", "TYPING_STOPPED":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStoppedEvent", "SEEN":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundSeenEvent" } }, "properties":{ "event":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEventType" } }, "required":[ "event" ], "title":"MessagesApiOutboundEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEventType":{ "type":"string", "description":"Event type.", "enum":[ "TYPING_STARTED", "TYPING_STOPPED", "SEEN" ], "title":"MessagesApiOutboundEventType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundSeenEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundSeenEventChannel" }, "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":"Array of destination objects for where events are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination" }, "maxItems":1, "minItems":1 }, "messageId":{ "type":"string", "description":"ID of the message that should be marked as seen." }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventOptions" } } } ], "required":[ "channel", "destinations", "event", "messageId", "sender" ], "title":"MessagesApiOutboundSeenEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStartedEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTypingStartedEventChannel" }, "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":"Array of destination objects for where events are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination" } }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventOptions" } } } ], "required":[ "channel", "destinations", "event", "sender" ], "title":"MessagesApiOutboundTypingStartedEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStoppedEvent":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent" }, { "type":"object", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTypingStoppedEventChannel" }, "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":"Array of destination objects for where events are being sent. A valid destination is required.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination" } }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventOptions" } } } ], "required":[ "channel", "destinations", "event", "sender" ], "title":"MessagesApiOutboundTypingStoppedEvent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest":{ "type":"object", "properties":{ "messages":{ "type":"array", "description":"Array of message objects of a single message or multiple messages sent under one bulk ID.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseMessage" } }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequestOptions" } }, "required":[ "messages" ], "title":"MessagesApiRequest" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequestOptions":{ "type":"object", "description":"Options applicable to all messages in the request.", "properties":{ "schedule":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RequestSchedulingSettings" }, "tracking":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.UrlOptions" }, "messageOrdering":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageOrderingOptions" } }, "title":"MessagesApiRequestOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenReport":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"Collection of reports, one per every message.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenResult" } } }, "required":[ "results" ], "title":"MessagesApiSeenReport" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenResult":{ "type":"object", "description":"Collection of reports, one per every message.", "properties":{ "event":{ "type":"string", "default":"SEEN", "description":"Event type (seen report in this case)." }, "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundSeenChannel" }, "sender":{ "type":"string", "description":"The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`)." }, "destination":{ "type":"string", "description":"Message destination address." }, "sentAt":{ "type":"string", "description":"Tells when the message was sent. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "seenAt":{ "type":"string", "description":"Tells when the message was seen. Has the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`." }, "bulkId":{ "type":"string", "description":"The ID that uniquely identifies the request." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the received message." }, "callbackData":{ "type":"string", "description":"Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists)." }, "platform":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform" }, "campaignReferenceId":{ "type":"string", "description":"ID of a campaign that was sent in the message." } }, "required":[ "bulkId", "channel", "destination", "event", "messageId", "seenAt", "sender", "sentAt" ], "title":"MessagesApiSeenResult" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate":{ "type":"object", "description":"Details of the template.", "properties":{ "templateName":{ "type":"string", "description":"Name of the template." }, "language":{ "type":"string", "description":"Language of the template." }, "referenceId":{ "type":"string", "description":"Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc)." } }, "required":[ "templateName" ], "title":"MessagesApiTemplate" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody":{ "type":"object", "description":"Body of a template message.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextBody", "CAROUSEL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselBody" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBodyType" } }, "required":[ "type" ], "title":"MessagesApiTemplateBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBodyType":{ "type":"string", "enum":[ "TEXT", "CAROUSEL" ], "title":"MessagesApiTemplateBodyType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton":{ "type":"object", "description":"List of buttons of a template message.", "discriminator":{ "propertyName":"type", "mapping":{ "QUICK_REPLY":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateQuickReplyButton", "OPEN_URL":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateOpenUrlButton", "PHONE_NUMBER":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplatePhoneNumberButton", "FLOW":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFlowButton", "COPY_CODE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCopyCodeButton", "CATALOG":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCatalogButton", "MULTI_PRODUCT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMultiProductButton" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButtonType" } }, "required":[ "type" ], "title":"MessagesApiTemplateButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButtonType":{ "type":"string", "enum":[ "QUICK_REPLY", "OPEN_URL", "PHONE_NUMBER", "FLOW", "COPY_CODE", "CATALOG", "MULTI_PRODUCT" ], "title":"MessagesApiTemplateButtonType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselBody":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody" }, { "type":"object", "properties":{ "cards":{ "type":"array", "description":"Carousel cards.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCard" } } } } ], "required":[ "cards", "type" ], "title":"MessagesApiTemplateCarouselBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCard":{ "type":"object", "description":"Carousel cards.", "properties":{ "header":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeader" }, "body":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Key value pairs that will be replaced during message sending. Valid example `{\"1\": \"John\", \"2\": \"Smith\"}`." }, "description":"Body of a card." }, "buttons":{ "type":"array", "description":"List of buttons of a card.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiCarouselTemplateButton" } } }, "required":[ "header" ], "title":"MessagesApiTemplateCarouselCard" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeader":{ "type":"object", "description":"Header of a card.", "discriminator":{ "propertyName":"type", "mapping":{ "IMAGE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardImageHeader", "VIDEO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardVideoHeader" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeaderType" } }, "required":[ "type" ], "title":"MessagesApiTemplateCarouselCardHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeaderType":{ "type":"string", "enum":[ "IMAGE", "VIDEO" ], "title":"MessagesApiTemplateCarouselCardHeaderType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardImageHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeader" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of an image." } } } ], "required":[ "type", "url" ], "title":"MessagesApiTemplateCarouselCardImageHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardVideoHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselCardHeader" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of a video." } } } ], "required":[ "type", "url" ], "title":"MessagesApiTemplateCarouselCardVideoHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCatalogButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "productId":{ "type":"string", "description":"Product-unique identifier from the catalog.", "maxLength":3000, "minLength":0 } } } ], "required":[ "type" ], "title":"MessagesApiTemplateCatalogButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCopyCodeButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "code":{ "type":"string", "description":"Coupon code.", "maxLength":15, "minLength":0 } } } ], "required":[ "code", "type" ], "title":"MessagesApiTemplateCopyCodeButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateDocumentHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of a document." }, "filename":{ "type":"string", "description":"Name of the file which will be used to display in message." } } } ], "required":[ "filename", "type", "url" ], "title":"MessagesApiTemplateDocumentHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFailover":{ "type":"object", "description":"Configuration of a single failover step", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel" }, "sender":{ "type":"string", "description":"Sender for channel specified above." }, "template":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate" }, "content":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent" }, "validityPeriod":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod" } }, "required":[ "channel", "template" ], "title":"Template message failover" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFlowButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "token":{ "type":"string", "description":"Flow token.", "maxLength":3000, "minLength":0 }, "data":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Message action payload data. JSON object with the data payload for the first screen" } } } ], "required":[ "type" ], "title":"MessagesApiTemplateFlowButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader":{ "type":"object", "description":"Header of a template message.", "discriminator":{ "propertyName":"type", "mapping":{ "TEXT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextHeader", "DOCUMENT":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateDocumentHeader", "IMAGE":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateImageHeader", "VIDEO":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateVideoHeader", "LOCATION":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateLocationHeader" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeaderType" } }, "required":[ "type" ], "title":"MessagesApiTemplateHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeaderType":{ "type":"string", "enum":[ "TEXT", "DOCUMENT", "IMAGE", "VIDEO", "LOCATION" ], "title":"MessagesApiTemplateHeaderType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateImageHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of an image." } } } ], "required":[ "type", "url" ], "title":"MessagesApiTemplateImageHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateLocationHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" }, { "type":"object", "properties":{ "latitude":{ "type":"number", "format":"double", "description":"Latitude of the location.", "maximum":90, "minimum":-90 }, "longitude":{ "type":"number", "format":"double", "description":"Longitude of the location.", "maximum":180, "minimum":-180 } } } ], "required":[ "latitude", "longitude", "type" ], "title":"MessagesApiTemplateLocationHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessage":{ "type":"object", "description":"Represents a single template message.", "properties":{ "channel":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel" }, "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":"Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination" } }, "template":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate" }, "content":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent" }, "options":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions" }, "webhooks":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks" }, "failover":{ "type":"array", "description":"Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover" } } }, "required":[ "channel", "destinations", "template" ], "title":"Messages API template message" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent":{ "type":"object", "description":"Content of the message.", "properties":{ "header":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" }, "body":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody" }, "buttons":{ "type":"array", "description":"List of buttons of a template message.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" } }, "expirationTime":{ "type":"string", "description":"Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." } }, "title":"MessagesApiTemplateMessageContent" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMultiProductButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "productId":{ "type":"string", "description":"Product-unique identifier, as defined in catalog. If omitted, the image of the first item in your catalog will be used.", "maxLength":3000, "minLength":0 }, "sections":{ "type":"array", "description":"An array of multi product sections.", "items":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMultiProductButtonSection" }, "maxItems":10, "minItems":1 } } } ], "required":[ "sections", "type" ], "title":"MessagesApiTemplateMultiProductButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMultiProductButtonSection":{ "type":"object", "description":"An array of multi product sections.", "properties":{ "title":{ "type":"string", "description":"Title of the section.", "maxLength":24, "minLength":0 }, "productIds":{ "type":"array", "description":"An array of product-unique identifiers as defined in the catalog. If product retailer ID doesn't exist in your catalog, the product won't be displayed.", "items":{ "type":"string", "description":"An array of product-unique identifiers as defined in the catalog. If product retailer ID doesn't exist in your catalog, the product won't be displayed." } } }, "required":[ "productIds", "title" ], "title":"MessagesApiTemplateMultiProductButtonSection" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateOpenUrlButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "suffix":{ "type":"string", "description":"Extension of a URL defined in the registered template." } } } ], "required":[ "suffix", "type" ], "title":"MessagesApiTemplateOpenUrlButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplatePhoneNumberButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" } ], "required":[ "type" ], "title":"MessagesApiTemplatePhoneNumberButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateQuickReplyButton":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton" }, { "type":"object", "properties":{ "postbackData":{ "type":"string", "description":"Custom client data that will be included in a user's response." } } } ], "required":[ "postbackData", "type" ], "title":"MessagesApiTemplateQuickReplyButton" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextBody":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Key value pairs that will be replaced during message sending. Valid example `{\"1\": \"John\", \"2\": \"Smith\", \"type\": \"TEXT\"}`." }, "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody" } ], "description":"Key value pairs that will be replaced during message sending. Valid example `{\"1\": \"John\", \"2\": \"Smith\", \"type\": \"TEXT\"}`.", "required":[ "type" ], "title":"MessagesApiTemplateTextBody" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextHeader":{ "type":"object", "additionalProperties":{ "type":"string", "description":"Key value pairs that will be replaced during message sending in a header. Valid example `{\"1\": \"John\", \"2\": \"Smith\", \"type\": \"TEXT\"}`" }, "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" } ], "description":"Key value pairs that will be replaced during message sending in a header. Valid example `{\"1\": \"John\", \"2\": \"Smith\", \"type\": \"TEXT\"}`", "required":[ "type" ], "title":"MessagesApiTemplateTextHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateVideoHeader":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader" }, { "type":"object", "properties":{ "url":{ "type":"string", "description":"URL of a video." } } } ], "required":[ "type", "url" ], "title":"MessagesApiTemplateVideoHeader" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination":{ "type":"object", "description":"Represents a simple destination.", "properties":{ "to":{ "type":"string", "description":"The destination address of the message. It can be alphanumeric or numeric." }, "messageId":{ "type":"string", "description":"The ID that uniquely identifies the message sent.", "maxLength":200, "minLength":0 } }, "required":[ "to" ], "title":"To Destination" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTrafficType":{ "type":"string", "description":"Traffic type classification for message sending. Supported by Viber for non-template messages only.", "enum":[ "PROMOTIONAL", "TRANSACTIONAL" ], "title":"MessagesApiTrafficType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentFormat":{ "type":"object", "description":"Format of the payment.", "discriminator":{ "propertyName":"type", "mapping":{ "LINK":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentLinkFormat" } }, "properties":{ "type":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentFormatType" } }, "required":[ "type" ], "title":"MessagesApiUpiIntentPaymentFormat" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentFormatType":{ "type":"string", "enum":[ "LINK" ], "title":"MessagesApiUpiIntentPaymentFormatType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentLinkFormat":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiUpiIntentPaymentFormat" }, { "type":"object", "properties":{ "paymentLink":{ "type":"string", "description":"Payment link." } } } ], "required":[ "type" ], "title":"MessagesApiUpiIntentPaymentLinkFormat" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks":{ "type":"object", "description":"Provides options for configuring message webhooks.", "properties":{ "delivery":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDelivery" }, "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 and Seen Report. The maximum value is 4000 characters.", "maxLength":4000, "minLength":0 }, "seen":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SeenStatusReporting" } }, "title":"MessagesApiWebhooks" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel":{ "type":"string", "description":"Messaging channel used for sending a message.", "enum":[ "APPLE_MB", "INSTAGRAM_DM", "LINE_ON", "MESSENGER", "MMS", "RCS", "SMS", "VIBER_BM", "VIBER_BOT", "WHATSAPP" ], "title":"OutboundMessageChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundSeenEventChannel":{ "type":"string", "description":"Messaging channel used for sending an event.", "enum":[ "RCS" ], "title":"OutboundSeenEventChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel":{ "type":"string", "description":"Messaging channel used for sending a template message.", "enum":[ "APPLE_MB", "RCS", "VIBER_BM", "WHATSAPP" ], "title":"OutboundTemplateChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTypingStartedEventChannel":{ "type":"string", "description":"Messaging channel used for sending an event.", "enum":[ "APPLE_MB", "RCS", "WHATSAPP" ], "title":"OutboundTypingStartedEventChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTypingStoppedEventChannel":{ "type":"string", "description":"Messaging channel used for sending an event.", "enum":[ "APPLE_MB" ], "title":"OutboundTypingStoppedEventChannel" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ReactionActionType":{ "type":"string", "description":"Action type indicating whether the reaction was added or removed.", "enum":[ "ADDED", "REMOVED" ], "title":"ReactionActionType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RecipientType":{ "type":"string", "description":"Recipient Type must be `TACIR` or `BIREYSEL`.", "enum":[ "BIREYSEL", "TACIR" ], "title":"RecipientType" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.IndiaDltOptions" }, "turkeyIys":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TurkeyIysOptions" }, "southKorea":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SouthKoreaOptions" } }, "title":"RegionalOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SendingSpeedLimit" } }, "title":"RequestSchedulingSettings" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseMessageResponseDetails" } } }, "required":[ "messages" ], "title":"ResponseEnvelopeMessageResponseMessageResponseDetails" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SpeedLimitTimeUnit" } }, "required":[ "amount" ], "title":"SendingSpeedLimit" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TransliterationCode":{ "type":"string", "description":"The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.", "enum":[ "NONE", "TURKISH", "GREEK", "CYRILLIC", "SERBIAN_CYRILLIC", "CENTRAL_EUROPEAN", "BALTIC", "NON_UNICODE", "PORTUGUESE", "COLOMBIAN", "BULGARIAN_CYRILLIC", "ALL" ], "title":"TransliterationCode" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RecipientType" } }, "required":[ "recipientType" ], "title":"TurkeyIysOptions" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.UrlOptions":{ "type":"object", "description":"Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE, Messenger, Viber Bot.", "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" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationBadResponse":{ "type":"object", "properties":{ "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" } }, "skippableViolations":{ "type":"array", "description":"List of violations that may be omitted, but is recommended to address.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } } }, "required":[ "action", "description", "violations" ], "title":"ValidationBadResponse" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationOkResponse":{ "type":"object", "properties":{ "description":{ "type":"string", "description":"A detailed description." }, "action":{ "type":"string", "description":"An action that should be taken." }, "skippableViolations":{ "type":"array", "description":"List of violations that may be omitted, but is recommended to address.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } } }, "required":[ "action", "description" ], "title":"ValidationOkResponse" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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. Minimal value is 10 seconds.", "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/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriodTimeUnit" } }, "required":[ "amount" ], "title":"ValidityPeriod" }, "899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriodTimeUnit":{ "type":"string", "default":"MINUTES", "description":"Message validity period time unit.", "enum":[ "SECONDS", "MINUTES", "HOURS" ], "title":"ValidityPeriodTimeUnit" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" } }, "responses":{ "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can\nbe revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} }, "webhooks":{ "receive-messages-api-delivery-reports":{ "post":{ "tags":[ "platform", "messages-api", "messages-api-status-reports" ], "summary":"Receive delivery reports", "description":"Incoming Reports 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 Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"receive-messages-api-delivery-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":{ "results":[ { "event":"DELIVERY", "channel":"WHATSAPP", "sender":"senderNumber", "destination":"41793026727", "sentAt":"2024-02-06T14:18:29.797+0000", "doneAt":"2024-02-06T17:18:29.797+0000", "bulkId":"1688025180464000013", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "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":"my-entity-id", "applicationId":"my-application-id" }, "deviceDetails":"deviceDetails", "networkId":1, "campaignReferenceId":"campaignRef" } ] } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse" }, "examples":{ "Delivery report":{ "summary":"Delivery report", "value":"\n \n \n DELIVERY\n WHATSAPP\n senderNumber\n 41793026727\n 2024-02-06T14:18:29.797+0000\n 2024-02-06T17:18:29.797+0000\n 1688025180464000013\n ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy\n 1\n \n 3\n DELIVERED\n 5\n DELIVERED_TO_HANDSET\n Message delivered to handset\n \n \n 0\n OK\n 0\n NO_ERROR\n No Error\n false\n \n \n my-entity-id\n my-application-id\n \n deviceDetails\n 1\n campaignRef\n \n \n\n" } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-messages-api-seen-reports":{ "post":{ "tags":[ "platform", "messages-api", "messages-api-status-reports" ], "summary":"Receive Seen reports", "description":"Incoming Seen Reports 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 > seen > url` parameter. Contact support@infobip.com if you require help.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"receive-messages-api-seen-reports", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenReport" }, "examples":{ "Seen report":{ "summary":"Seen report", "value":{ "results":[ { "event":"SEEN", "channel":"WHATSAPP", "sender":"senderNumber", "destination":"41793026727", "sentAt":"2024-02-06T14:18:29.797+0000", "seenAt":"2024-02-06T14:28:29.797+0000", "bulkId":"1688025180464000013", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "callbackData":"reference-callback-data-from-outbound-message", "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "campaignReferenceId":"campaignRef" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } }, "receive-messages-api-incoming-messages":{ "post":{ "tags":[ "platform", "messages-api", "inbound-messages" ], "summary":"Receive inbound messages", "description":"Incoming messages will be forwarded to this endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number or resource by specifying your endpoint and we will send inbound messages to you as soon as they are delivered to us.\n\nMake sure you set renderer or format to `MO_MESSAGES_API_JSON`.", "externalDocs":{ "description":"Learn more about the Messages API and use cases", "url":"https://www.infobip.com/docs/messages-api" }, "operationId":"receive-messages-api-incoming-messages", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessage" }, "examples":{ "Received text message example":{ "summary":"Received text message example", "value":{ "results":[ { "channel":"SMS", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text message 123", "cleanText":"Text message", "type":"TEXT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received text message with keyword example":{ "summary":"Received text message with keyword example", "value":{ "results":[ { "channel":"SMS", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"KWRDText message 123", "cleanText":"Text message", "keyword":"KWRD", "type":"TEXT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received image with caption message example":{ "summary":"Received image with caption message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/image.jpg", "text":"Image caption", "type":"IMAGE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received audio with caption message example":{ "summary":"Received audio with caption message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-audio", "text":"Audio caption", "type":"AUDIO" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received audio with subject and text message example (MMS only)":{ "summary":"Received audio with subject and text message example (MMS only)", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-audio", "text":"Audio caption", "type":"AUDIO" }, { "text":"Text message", "cleanText":"Text message", "type":"TEXT" }, { "text":"KEYWORD Some subject", "cleanText":"Some subject", "keyword":"KEYWORD", "type":"SUBJECT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received video with caption example":{ "summary":"Received video with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-video", "text":"Video caption", "type":"VIDEO" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received document with caption example":{ "summary":"Received document with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-document", "text":"Document caption", "type":"DOCUMENT" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received file with caption example":{ "summary":"Received file with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received multiple file with caption example":{ "summary":"Received multiple file with caption example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" }, { "url":"http://my.domain/media/my-file", "text":"File caption", "type":"FILE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received location with url example":{ "summary":"Received location with url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "latitude":16.0, "longitude":18.0, "url":"http://my.domain/media/my-location", "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received location without url example":{ "summary":"Received location without url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "latitude":16.0, "longitude":18.0, "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received location only with url example":{ "summary":"Received location only with url example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "url":"http://my.domain/media/my-location", "type":"LOCATION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received list reply example":{ "summary":"Received list reply example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text for selected option", "id":"selectedItemId", "type":"LIST_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received list reply with multiple item selected example":{ "summary":"Received list reply with multiple item selected example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Text for first selected option ", "id":"selectedItemIdFirst", "type":"LIST_REPLY" }, { "text":"Text for second selected option", "id":"selectedItemIdSecond", "type":"LIST_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received button message example":{ "summary":"Received button message example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "text":"Yes", "payload":"true", "id":"1", "type":"BUTTON_REPLY" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received flow response example":{ "summary":"Received flow response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "response":{ "rating":5, "additional_comment":"That was very nice :)", "flow_token":"tokenForTracking" }, "type":"FLOW_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received typing started event example":{ "summary":"Received typing started event example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"TYPING_STARTED" } ] } }, "Received typing stopped event example":{ "summary":"Received typing stopped event example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"TYPING_STOPPED" } ] } }, "Received payment response example":{ "summary":"Received payment response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "referenceId":"referenceId", "paymentId":"paymentId", "status":"SUCCESS", "total":{ "value":100, "currency":"BRL" }, "transaction":{ "id":"transactionId", "type":"UPI" }, "items":[ { "retailerId":"retailerId", "catalogId":"catalogId" } ], "type":"PAYMENT_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received form response example":{ "summary":"Received form response example", "value":{ "results":[ { "channel":"APPLE_MB", "sender":"urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=", "destination":"e1c86198-d9bf-43ee-a635-7fe9cbcf45ad", "content":[ { "isPrivate":false, "selections":[ { "type":"INPUT", "pageIdentifier":"0", "text":"Input text", "items":[ { "title":"Input item title", "value":"Input item value" } ] }, { "type":"PICKER", "pageIdentifier":"1", "text":"Picker text", "items":[ { "title":"Picker item title", "value":"Picker item value" } ] }, { "type":"DATE_PICKER", "pageIdentifier":"2", "text":"Date picker text", "items":[ { "title":"Date picker item title", "value":"2025-01-01T14:00:00.797+0000" } ] }, { "type":"SELECT", "pageIdentifier":"3", "text":"Select text", "items":[ { "title":"Select item title", "value":"Select item value" } ] }, { "type":"SELECT", "pageIdentifier":"4", "text":"Multi-select text", "items":[ { "title":"Multi-select item 1", "value":"Multi-select value 1" }, { "title":"Multi-select item 2", "value":"Multi-select value 2" } ] } ], "type":"FORM_RESPONSE" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "metadata":{ "correlationData":"your-correlation-data" }, "event":"MO" } ] } }, "Received reaction response example":{ "summary":"Received reaction response example", "value":{ "results":[ { "channel":"WHATSAPP", "sender":"48123234567", "destination":"48123098765", "content":[ { "emoji":"\\u2764\\uFE0F", "action":"ADDED", "type":"REACTION" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } }, "Received url response example":{ "summary":"Received url response example", "value":{ "results":[ { "channel":"MESSENGER", "sender":"731401526720514", "destination":"24060905360217212", "content":[ { "url":"http://my.domain/media/my-url", "type":"URL" } ], "receivedAt":"2020-02-06T14:18:29.797+0000", "messageId":"ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy", "messageCount":1, "platform":{ "entityId":"my-entity-id", "applicationId":"my-application-id" }, "event":"MO" } ] } } } } } }, "responses":{ "200":{ "description":"Your server returns this code if it accepts the callback." } } } } } }