openapi: 3.2.0
info:
  title: Infobip OpenAPI Specification Channels API
  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:37.825639538Z'
tags:
- name: channels
  description: 'Create a perfect customer experience by using the channels your customer already use and love.

    '
  x-type: category
  x-displayName: Channels
paths:
  /sms/3/messages:
    post:
      tags:
      - channels
      summary: Send SMS message
      description: 'With this API method, you can do anything from sending a basic message to one person, all the way to sending customized messages to thousands of recipients in one go. It comes with a range of useful features like transliteration, scheduling, and tracking in a unified way.\

        If utilizing Message Delivery Reports webhook, please consult the documentation provided at [Receive outbound SMS message reports](#channels/sms/receive-outbound-sms-message-report-v3).\

        This endpoint is the successor of [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message).'
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: send-sms-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope'
            examples:
              Send basic textual message:
                summary: Send basic textual message
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      text: This is a sample message
              Send fully-featured textual message:
                summary: Send fully-featured textual message
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                      messageId: MESSAGE-ID-123-xyz
                    - to: '41793026834'
                    content:
                      text: Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.
                      transliteration: TURKISH
                      language:
                        languageCode: TR
                    options:
                      validityPeriod:
                        amount: 720
                        timeUnit: HOURS
                      campaignReferenceId: summersale
                    webhooks:
                      delivery:
                        url: https://www.example.com/sms/advanced
                        intermediateReport: true
                      contentType: application/json
                      callbackData: DLR callback data
                  - sender: '41793026700'
                    destinations:
                    - to: '41793026700'
                    content:
                      text: A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.
                    options:
                      deliveryTimeWindow:
                        days:
                        - MONDAY
                        - TUESDAY
                        - WEDNESDAY
                        - THURSDAY
                        - FRIDAY
                        - SATURDAY
                        - SUNDAY
                        from:
                          hour: 6
                          minute: 0
                        to:
                          hour: 15
                          minute: 30
                  options:
                    schedule:
                      bulkId: BULK-ID-123-xyz
                      sendAt: 2021-08-24T15:00:00.000+0000
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
                      customDomain: example.com
                    includeSmsCountInResponse: true
                    conversionTracking:
                      useConversionTracking: true
                      conversionTrackingName: MY_CAMPAIGN
              Send flash textual message:
                summary: Send flash textual message
                description: Send a message that will pop-up on the user's phone
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      text: Toto, I've got a feeling we're not in Kansas anymore.
                    options:
                      flash: true
              SMS language:
                summary: SMS language
                description: Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      text: Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.
                      language:
                        languageCode: TR
              SMS transliteration:
                summary: SMS transliteration
                description: Send full-size messages in original language alphabet using transliteration conversion
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      text: Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα
                      transliteration: GREEK
              Platform features:
                summary: Platform features
                description: Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    content:
                      text: Custom application and entity based rules will be applied to this message
                    options:
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
              Send Basic India DLT message:
                summary: Send Basic India DLT message
                description: Send a message with India DLT parameters included
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      text: India DLT parameters will be applied in this message
                    options:
                      regional:
                        indiaDlt:
                          contentTemplateId: '1111111111111111111'
                          principalEntityId: '1111111111111111112'
                          telemarketerId: '111111111111'
              Send fully-featured binary SMS message:
                summary: Send fully-featured binary SMS message
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                      messageId: MESSAGE-ID-123-xyz
                    - to: '41793026834'
                    content:
                      dataCoding: 0
                      esmClass: 0
                      hex: 54 65 73 74 20 6d 65 73 73 61 67 65 2e
                    options:
                      validityPeriod:
                        amount: 720
                        timeUnit: HOURS
                    webhooks:
                      delivery:
                        url: https://www.example.com/sms/advanced
                        intermediateReport: true
                      contentType: application/json
                      callbackData: DLR callback data
                  - sender: '41793026700'
                    destinations:
                    - to: '41793026700'
                    content:
                      dataCoding: 0
                      esmClass: 0
                      hex: 41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E
                    options:
                      deliveryTimeWindow:
                        days:
                        - MONDAY
                        - TUESDAY
                        - WEDNESDAY
                        - THURSDAY
                        - FRIDAY
                        - SATURDAY
                        - SUNDAY
                        from:
                          hour: 6
                          minute: 0
                        to:
                          hour: 15
                          minute: 30
                      campaignReferenceId: summersale
                  options:
                    schedule:
                      bulkId: BULK-ID-123-xyz
                      sendAt: 2021-08-23T14:00:00.000+0000
              Send Unicode flash binary SMS message:
                summary: Send Unicode flash binary SMS message
                value:
                  messages:
                  - sender: InfoSMS
                    destinations:
                    - to: '41793026727'
                    content:
                      dataCoding: 8
                      esmClass: 0
                      hex: 0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf
                    options:
                      flash: true
          application/xml:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope'
            examples:
              Send basic textual message:
                summary: Send basic textual message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>This is a sample message</text>\n      </content>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Send fully-featured textual message:
                summary: Send fully-featured textual message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <options>\n    <schedule>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <sendAt>2021-08-24T15:00:00.000+0000</sendAt>\n    </schedule>\n    <tracking>\n      <shortenUrl>true</shortenUrl>\n      <trackClicks>true</trackClicks>\n      <trackingUrl>https://example.com/click-report</trackingUrl>\n      <removeProtocol>true</removeProtocol>\n      <customDomain>example.com</customDomain>\n    </tracking>\n    <includeSmsCountInResponse>true</includeSmsCountInResponse>\n    <conversionTracking>\n      <useConversionTracking>true</useConversionTracking>\n      <conversionTrackingName>MY_CAMPAIGN</conversionTrackingName>\n    </conversionTracking>\n  </options>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.</text>\n        <transliteration>TURKISH</transliteration>\n        <language>\n          <languageCode>TR</languageCode>\n        </language>\n      </content>\n      <options>\n        <validityPeriod>\n          <amount>720</amount>\n          <timeUnit>HOURS</timeUnit>\n        </validityPeriod>\n        <campaignReferenceId>summersale</campaignReferenceId>\n      </options>\n      <webhooks>\n        <delivery>\n          <url>https://www.example.com/sms/advanced</url>\n          <intermediateReport>true</intermediateReport>\n        </delivery>\n        <contentType>application/json</contentType>\n        <callbackData>DLR callback data</callbackData>\n      </webhooks>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n        </destination>\n        <destination>\n          <to>41793026834</to>\n        </destination>\n      </destinations>\n    </message>\n    <message>\n      <sender>41793026700</sender>\n      <content>\n        <text>A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.</text>\n      </content>\n      <options>\n        <deliveryTimeWindow>\n          <days>\n            <days>MONDAY</days>\n            <days>TUESDAY</days>\n            <days>WEDNESDAY</days>\n            <days>THURSDAY</days>\n            <days>FRIDAY</days>\n            <days>SATURDAY</days>\n            <days>SUNDAY</days>\n          </days>\n          <from>\n            <hour>6</hour>\n            <minute>0</minute>\n          </from>\n          <to>\n            <hour>15</hour>\n            <minute>30</minute>\n          </to>\n        </deliveryTimeWindow>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026700</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Send flash textual message:
                summary: Send flash textual message
                description: Send a message that will pop-up on the user's phone
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>Toto, I've got a feeling we're not in Kansas anymore.</text>\n      </content>\n      <options>\n        <flash>true</flash>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              SMS language:
                summary: SMS language
                description: Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.</text>\n        <language>\n          <languageCode>TR</languageCode>\n        </language>\n      </content>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              SMS transliteration:
                summary: SMS transliteration
                description: Send full-size messages in original language alphabet using transliteration conversion
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα</text>\n        <transliteration>GREEK</transliteration>\n      </content>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Platform features:
                summary: Platform features
                description: Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <content>\n        <text>Custom application and entity based rules will be applied to this message</text>\n      </content>\n      <options>\n        <platform>\n          <entityId>promotional-traffic-entity</entityId>\n          <applicationId>marketing-automation-application</applicationId>\n        </platform>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Send Basic India DLT message:
                summary: Send Basic India DLT message
                description: Send a message with India DLT parameters included
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <text>India DLT parameters will be applied in this message</text>\n      </content>\n      <options>\n        <regional>\n          <indiaDlt>\n            <contentTemplateId>1111111111111111111</contentTemplateId>\n            <principalEntityId>1111111111111111112</principalEntityId>\n            <telemarketerId>111111111111</telemarketerId>\n          </indiaDlt>\n        </regional>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Send fully-featured binary SMS message:
                summary: Send fully-featured binary SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <options>\n    <schedule>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <sendAt>2021-08-23T14:00:00.000+0000</sendAt>\n    </schedule>\n  </options>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <dataCoding>0</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>54 65 73 74 20 6d 65 73 73 61 67 65 2e</hex>\n      </content>\n      <options>\n        <validityPeriod>\n          <amount>720</amount>\n          <timeUnit>HOURS</timeUnit>\n        </validityPeriod>\n      </options>\n      <webhooks>\n        <delivery>\n          <url>https://www.example.com/sms/advanced</url>\n          <intermediateReport>true</intermediateReport>\n        </delivery>\n        <contentType>application/json</contentType>\n        <callbackData>DLR callback data</callbackData>\n      </webhooks>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n        </destination>\n        <destination>\n          <to>41793026834</to>\n        </destination>\n      </destinations>\n    </message>\n    <message>\n      <sender>41793026700</sender>\n      <content>\n        <dataCoding>0</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E</hex>\n      </content>\n      <options>\n        <deliveryTimeWindow>\n          <days>\n            <days>MONDAY</days>\n            <days>TUESDAY</days>\n            <days>WEDNESDAY</days>\n            <days>THURSDAY</days>\n            <days>FRIDAY</days>\n            <days>SATURDAY</days>\n            <days>SUNDAY</days>\n          </days>\n          <from>\n            <hour>6</hour>\n            <minute>0</minute>\n          </from>\n          <to>\n            <hour>15</hour>\n            <minute>30</minute>\n          </to>\n        </deliveryTimeWindow>\n        <campaignReferenceId>summersale</campaignReferenceId>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026700</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
              Send Unicode flash binary SMS message:
                summary: Send Unicode flash binary SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsRequestEnvelope>\n  <messages>\n    <message>\n      <sender>InfoSMS</sender>\n      <content>\n        <dataCoding>8</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf</hex>\n      </content>\n      <options>\n        <flash>true</flash>\n      </options>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SmsRequestEnvelope>\n"
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '41793026727'
                      details:
                        messageCount: 1
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '41793026727'
                      details:
                        messageCount: 1
                    - messageId: 3350be2d4219-3af1-23343-bbbb-1362af1edfd3
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '41435675123'
                      details:
                        messageCount: 1
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsResponseEnvelope>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <destination>41793026727</destination>\n      <details>\n        <messageCount>1</messageCount>\n      </details>\n    </message>\n  </messages>\n</SmsResponseEnvelope>\n"
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsResponseEnvelope>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <destination>41793026727</destination>\n      <details>\n        <messageCount>1</messageCount>\n      </details>\n    </message>\n    <message>\n      <messageId>3350be2d4219-3af1-23343-bbbb-1362af1edfd3</messageId>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <destination>41435675123</destination>\n      <details>\n        <messageCount>1</messageCount>\n      </details>\n    </message>\n  </messages>\n</SmsResponseEnvelope>\n"
        '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: []
            application/xml:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E400</errorCode>\n  <description>Request cannot be processed.</description>\n  <action>Check the syntax, violations and adjust the request.</action>\n  <violations>\n    <violation>\n      <property>property.path</property>\n      <violation>Violation message.</violation>\n    </violation>\n  </violations>\n  <resources/>\n</ApiError>\n"
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-additionalInfo:
        markdown: '### Related

          - [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)

          - [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)

          '
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: send-sms-messages
      - versionNumber: 2
        latest: false
        operationId: send-sms-message
      - versionNumber: 2
        latest: false
        operationId: send-binary-sms-message
  /sms/3/text/query:
    get:
      tags:
      - channels
      summary: Send SMS message over query parameters
      description: All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-messages) is not an option for your use case!<br>**Note:** Make sure that special characters are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide. This endpoint is the successor of [Send SMS message over query parameters](#channels/sms/send-sms-message-over-query-parameters).
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: send-sms-messages-over-query-parameters
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 100
          minLength: 0
      - name: from
        in: query
        description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: InfoSMS
      - name: to
        in: query
        description: List of message recipients.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: 41793026727,41793026834
      - name: text
        in: query
        description: Content of the message being sent.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: Message text
      - name: flash
        in: query
        description: Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: transliteration
        in: query
        description: Conversion of a message text from one script to another.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: TURKISH
      - name: languageCode
        in: query
        description: Code for language character set of a message content.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: TR
      - name: intermediateReport
        in: query
        description: Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report-v3) that will be sent on your callback server.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: notifyUrl
        in: query
        description: The URL on your call back server on to which a delivery report will be sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: https://www.example.com
      - name: notifyContentType
        in: query
        description: Preferred delivery report content type, `application/json` or `application/xml`.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: application/json
      - name: callbackData
        in: query
        description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports-v3). The maximum value is 4000 characters.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 4000
          minLength: 0
        example: callbackData
      - name: validityPeriod
        in: query
        description: The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 720
      - name: sendAt
        in: query
        description: 'Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: includeSmsCountInResponse
        in: query
        description: 'Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted. '
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: trackingUrl
        in: query
        description: The URL of your callback server on to which the Click report will be sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: trackingType
        in: query
        description: Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Custom tracking type
      - name: indiaDltContentTemplateId
        in: query
        description: The ID of your registered DLT (Distributed Ledger Technology) content template.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '1111111111111111111'
      - name: indiaDltPrincipalEntityId
        in: query
        description: Your DLT (Distributed Ledger Technology) entity id.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '1111111111111111112'
      - name: indiaDltTelemarketerId
        in: query
        description: Your assigned Telemarketer ID. (required for Aggregators)
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 111111111111
      - name: turkeyIysBrandCode
        in: query
        description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: turkeyIysRecipientType
        in: query
        description: Recipient Type must be TACIR or BIREYSEL
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: southKoreaResellerCode
        in: query
        description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: southKoreaTitle
        in: query
        description: Title of the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '41793026727'
                      details:
                        messageCount: 1
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsResponseEnvelope>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <destination>41793026727</destination>\n      <details>\n        <messageCount>1</messageCount>\n      </details>\n    </message>\n  </messages>\n</SmsResponseEnvelope>\n"
        '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
      - sms:message:send
      - sms:manage
      x-additionalInfo:
        markdown: '### Related

          - [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)

          - [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)

          '
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: send-sms-messages-over-query-parameters
      - versionNumber: 1
        latest: false
        operationId: send-sms-message-over-query-parameters
  /sms/1/text/query:
    get:
      tags:
      - channels
      summary: Send SMS message over query parameters
      description: All message parameters of the message can be defined in the query string. Use this method only if [Send SMS message](#channels/sms/send-sms-message) is not an option for your use case!<br>**Note:** Make sure that special characters and user credentials are properly encoded. Use a [URL encoding reference](https://www.w3schools.com/tags/ref_urlencode.asp) as a guide.
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: send-sms-message-over-query-parameters
      parameters:
      - name: username
        in: query
        description: Username for authentication.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: password
        in: query
        description: Password for authentication.
        required: true
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and logs.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: from
        in: query
        description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: InfoSMS
      - name: to
        in: query
        description: List of message recipients.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: 41793026727,41793026834
      - name: text
        in: query
        description: Content of the message being sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Message text
      - name: flash
        in: query
        description: Sends a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) if set to true.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: transliteration
        in: query
        description: Conversion of a message text from one script to another.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: TURKISH
      - name: languageCode
        in: query
        description: Code for language character set of a message content.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: TR
      - name: intermediateReport
        in: query
        description: Use a [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) that will be sent on your callback server.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: notifyUrl
        in: query
        description: The URL on your call back server on to which a delivery report will be sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: https://www.example.com
      - name: notifyContentType
        in: query
        description: Preferred delivery report content type, `application/json` or `application/xml`.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: application/json
      - name: callbackData
        in: query
        description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message [Delivery Report](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 4000
          minLength: 0
        example: callbackData
      - name: validityPeriod
        in: query
        description: The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int64
        example: 720
      - name: sendAt
        in: query
        description: 'Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: track
        in: query
        description: 'Sets the conversion element to be tracked. Possible values: `SMS` and `URL`. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion).'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: URL
      - name: processKey
        in: query
        description: The process key which  uniquely identifies conversion tracking.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: trackingType
        in: query
        description: Sets a custom conversion type naming convention, e.g. ONE_TIME_PIN, SOCIAL_INVITES, etc.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Custom tracking type
      - name: indiaDltContentTemplateId
        in: query
        description: The ID of your registered DLT (Distributed Ledger Technology) content template.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '1111111111111111111'
      - name: indiaDltPrincipalEntityId
        in: query
        description: Your DLT (Distributed Ledger Technology) entity id.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '1111111111111111112'
      - name: indiaDltTelemarketerId
        in: query
        description: Your assigned Telemarketer ID. (required for Aggregators)
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 111111111111
      - name: turkeyIysBrandCode
        in: query
        description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: turkeyIysRecipientType
        in: query
        description: Recipient Type must be TACIR or BIREYSEL
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: southKoreaResellerCode
        in: query
        description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ENROUTE
                      to: '41793026727'
                      smsCount: 1
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value:
                    bulkId: '2034072219640523073'
                    messages:
                    - messageId: '2033247207850523791'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ENROUTE
                      to: '41793026727'
                      smsCount: 1
                    - messageId: '2033247207850523792'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ENROUTE
                      to: '41793026834'
                      smsCount: 1
            application/xml:
              schema:
                $ref: '#/components/schemas/cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ENROUTE</name>\n      </status>\n      <to>41793026727</to>\n      <smsCount>1</smsCount>\n    </message>\n  </messages>\n</smsResponse>\n"
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523073</bulkId>\n  <messages>\n    <message>\n      <messageId>2033247207850523791</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ENROUTE</name>\n      </status>\n      <to>41793026727</to>\n      <smsCount>1</smsCount>\n    </message>\n    <message>\n      <messageId>2033247207850523792</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ENROUTE</name>\n      </status>\n      <to>41793026834</to>\n      <smsCount>1</smsCount>\n    </message>\n  </messages>\n</smsResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-deprecationInformation:
        deprecation: 2024-10-09T12:00:00.00+0000
        successorOperationId: send-sms-messages-over-query-parameters
      x-additionalInfo:
        markdown: '### Related

          - [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)

          - [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)

          '
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: send-sms-messages-over-query-parameters
      - versionNumber: 1
        latest: false
        operationId: send-sms-message-over-query-parameters
  /sms/1/preview:
    post:
      tags:
      - channels
      summary: Preview SMS message
      description: Avoid unpleasant surprises and check how different message configurations will affect your message text, number of characters and message parts.
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: preview-sms-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest'
            examples:
              Preview message count and remaining characters:
                summary: Preview message count and remaining characters
                description: Use this method to check how many characters are left in your message and if it fits into one or more messages.
                value:
                  text: Let's see how many characters remain unused in this message.
              Preview with message language:
                summary: Preview with message language
                description: In this example we will request a message preview for Turkish language by introducing the languageCode parameter.
                value:
                  text: Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.
                  languageCode: TR
              Preview with transliteration:
                summary: Preview with transliteration
                description: Transliteration is a technique that replaces the original special characters
                value:
                  text: Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα
                  transliteration: GREEK
          application/xml:
            schema:
              $ref: '#/components/schemas/01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest'
            examples:
              Preview message count and remaining characters:
                summary: Preview message count and remaining characters
                description: Use this method to check how many characters are left in your message and if it fits into one or more messages.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewRequest>\n  <text>Let's see how many characters remain unused in this message.</text>\n</PreviewRequest>\n"
              Preview with message language:
                summary: Preview with message language
                description: In this example we will request a message preview for Turkish language by introducing the languageCode parameter.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewRequest>\n  <text>Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.</text>\n  <languageCode>TR</languageCode>\n</PreviewRequest>\n"
              Preview with transliteration:
                summary: Preview with transliteration
                description: Transliteration is a technique that replaces the original special characters
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewRequest>\n  <text>Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα</text>\n  <transliteration>GREEK</transliteration>\n</PreviewRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse'
              examples:
                Preview response:
                  summary: Preview response
                  value:
                    originalText: Let's see how many characters remain unused in this message.
                    previews:
                    - textPreview: Let's see how many characters remain unused in this message.
                      messageCount: 1
                      charactersRemaining: 100
                      configuration: {}
                Preview response for request with message language:
                  summary: Preview response for request with message language
                  value:
                    originalText: Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.
                    previews:
                    - textPreview: Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.
                      messageCount: 2
                      charactersRemaining: 36
                      configuration: {}
                    - textPreview: Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.
                      messageCount: 1
                      charactersRemaining: 57
                      configuration:
                        language:
                          languageCode: TR
                Preview response for request with transliteration:
                  summary: Preview response for request with transliteration
                  value:
                    originalText: Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα.
                    previews:
                    - textPreview: Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα
                      messageCount: 3
                      charactersRemaining: 46
                      configuration: {}
                    - textPreview: ΩΣ MEΓAPIKO ΨHΦIΣMA EINAI ΓNΩΣTH H AΠOΦAΣH THΣ EKKΛHΣIAΣ TOY ΔHMOY TΩN AΘHNAIΩN (ΠIΘANON ΓYPΩ ΣTO 433/2 Π.X.) NA EΠIBAΛEI AYΣTHPO KAI KAΘOΛIKO EMΠAPΓKO ΣTA
                      messageCount: 1
                      charactersRemaining: 5
                      configuration:
                        transliteration: GREEK
            application/xml:
              schema:
                $ref: '#/components/schemas/b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse'
              examples:
                Preview response:
                  summary: Preview response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewResponse>\n  <originalText>Let's see how many characters remain unused in this message.</originalText>\n  <previews>\n    <previews>\n      <textPreview>Let's see how many characters remain unused in this message.</textPreview>\n      <messageCount>1</messageCount>\n      <charactersRemaining>100</charactersRemaining>\n      <configuration/>\n    </previews>\n  </previews>\n</PreviewResponse>\n"
                Preview response for request with message language:
                  summary: Preview response for request with message language
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewResponse>\n  <originalText>Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.</originalText>\n  <previews>\n    <previews>\n      <textPreview>Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.</textPreview>\n      <messageCount>2</messageCount>\n      <charactersRemaining>36</charactersRemaining>\n      <configuration/>\n    </previews>\n    <previews>\n      <textPreview>Mesaj gönderimi yapmadan önce önizleme seçeneğini kullanmanız doğru karar vermenize yardımcı olur.</textPreview>\n      <messageCount>1</messageCount>\n      <charactersRemaining>57</charactersRemaining>\n      <configuration>\n        <language>\n          <languageCode>TR</languageCode>\n        </language>\n      </configuration>\n    </previews>\n  </previews>\n</PreviewResponse>\n"
                Preview response for request with transliteration:
                  summary: Preview response for request with transliteration
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><PreviewResponse>\n  <originalText>Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα.</originalText>\n  <previews>\n    <previews>\n      <textPreview>Ως Μεγαρικό ψήφισμα είναι γνωστή η απόφαση της Εκκλησίας του δήμου των Αθηναίων (πιθανόν γύρω στο 433/2 π.Χ.) να επιβάλει αυστηρό και καθολικό εμπάργκο στα</textPreview>\n      <messageCount>3</messageCount>\n      <charactersRemaining>46</charactersRemaining>\n      <configuration/>\n    </previews>\n    <previews>\n      <textPreview>ΩΣ MEΓAPIKO ΨHΦIΣMA EINAI ΓNΩΣTH H AΠOΦAΣH THΣ EKKΛHΣIAΣ TOY ΔHMOY TΩN AΘHNAIΩN (ΠIΘANON ΓYPΩ ΣTO 433/2 Π.X.) NA EΠIBAΛEI AYΣTHPO KAI KAΘOΛIKO EMΠAPΓKO ΣTA</textPreview>\n      <messageCount>1</messageCount>\n      <charactersRemaining>5</charactersRemaining>\n      <configuration>\n        <transliteration>GREEK</transliteration>\n      </configuration>\n    </previews>\n  </previews>\n</PreviewResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:manage
  /sms/2/text/advanced:
    post:
      tags:
      - channels
      summary: Send SMS message
      description: 'Use this endpoint to send an SMS and set up a rich set of features, such as batch sending with a single API request, scheduling, URL tracking, language and transliteration configuration, etc. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\

        In light of improved features, this endpoint has been superseded. Please visit [Send SMS message](#channels/sms/send-sms-messages) for the next version.'
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: send-sms-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest'
            examples:
              Send basic textual messages:
                summary: Send basic textual messages
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoSMS
                    text: This is a sample message
              Send fully-featured textual message:
                summary: Send fully-featured textual message
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - callbackData: DLR callback data
                    destinations:
                    - messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                    - to: '41793026834'
                    flash: false
                    from: InfoSMS
                    intermediateReport: true
                    language:
                      languageCode: TR
                    notifyContentType: application/json
                    notifyUrl: https://www.example.com/sms/advanced
                    text: Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.
                    transliteration: TURKISH
                    validityPeriod: 720
                    campaignReferenceId: summersale
                  - deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
                    destinations:
                    - to: '41793026700'
                    from: '41793026700'
                    sendAt: 2021-08-25T16:00:00.000+0000
                    text: A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.
                  tracking:
                    track: SMS
                    type: MY_CAMPAIGN
              Send flash message:
                summary: Send flash message
                description: Send a message that will pop-up on the user's phone
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    flash: true
                    from: InfoSMS
                    text: Toto, I've got a feeling we're not in Kansas anymore.
              SMS language:
                summary: SMS language
                description: Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoSMS
                    language:
                      languageCode: TR
                    text: Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.
              SMS transliteration:
                summary: SMS transliteration
                description: Send full-size messages in original language alphabet using transliteration conversion
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoSMS
                    text: Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα
                    transliteration: GREEK
              Platform features:
                summary: Platform features
                description: Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    text: Custom application and entity based rules will be applied to this message
                    entityId: promotional-traffic-entity
                    applicationId: marketing-automation-application
              Send Basic India DLT message:
                summary: Send Basic India DLT message
                description: Send a message with India DLT parameters included
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoSMS
                    regional:
                      indiaDlt:
                        contentTemplateId: '1111111111111111111'
                        principalEntityId: '1111111111111111112'
                        telemarketerId: '111111111111'
                    text: India DLT parameters will be applied in this message
          application/xml:
            schema:
              $ref: '#/components/schemas/1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest'
            examples:
              Send basic textual messages:
                summary: Send basic textual messages
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <from>InfoSMS</from>\n      <text>This is a sample message</text>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              Send fully-featured textual message:
                summary: Send fully-featured textual message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <tracking>\n    <track>SMS</track>\n    <type>MY_CAMPAIGN</type>\n  </tracking>\n  <messages>\n    <message>\n      <callbackData>DLR callback data</callbackData>\n      <flash>false</flash>\n      <from>InfoSMS</from>\n      <intermediateReport>true</intermediateReport>\n      <language>\n        <languageCode>TR</languageCode>\n      </language>\n      <notifyContentType>application/json</notifyContentType>\n      <notifyUrl>https://www.example.com/sms/advanced</notifyUrl>\n      <text>Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.</text>\n      <transliteration>TURKISH</transliteration>\n      <validityPeriod>720</validityPeriod>\n      <campaignReferenceId>summersale</campaignReferenceId>\n      <destinations>\n        <destination>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n          <to>41793026727</to>\n        </destination>\n        <destination>\n          <to>41793026834</to>\n        </destination>\n      </destinations>\n    </message>\n    <message>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n          <days>SATURDAY</days>\n          <days>SUNDAY</days>\n        </days>\n        <from>\n          <hour>6</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>15</hour>\n          <minute>30</minute>\n        </to>\n      </deliveryTimeWindow>\n      <from>41793026700</from>\n      <sendAt>2021-08-25T16:00:00.000+0000</sendAt>\n      <text>A long time ago, in a galaxy far, far away... It is a period of civil war. Rebel spaceships, striking from a hidden base, have won their first victory against the evil Galactic Empire.</text>\n      <destinations>\n        <destination>\n          <to>41793026700</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              Send flash message:
                summary: Send flash message
                description: Send a message that will pop-up on the user's phone
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <flash>true</flash>\n      <from>InfoSMS</from>\n      <text>Toto, I've got a feeling we're not in Kansas anymore.</text>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              SMS language:
                summary: SMS language
                description: Crossing SMS language barriers with the National Language Identifier for Turkish, Spanish and Portuguese
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <from>InfoSMS</from>\n      <language>\n        <languageCode>TR</languageCode>\n      </language>\n      <text>Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.</text>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              SMS transliteration:
                summary: SMS transliteration
                description: Send full-size messages in original language alphabet using transliteration conversion
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <from>InfoSMS</from>\n      <text>Ως Μεγαρικό ψήφισμα είνα…ι καθολικό εμπάργκο στα</text>\n      <transliteration>GREEK</transliteration>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              Platform features:
                summary: Platform features
                description: Parts of the SMS message, such as message sender, will be customized in accordance with provided application and entity ids. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <text>Custom application and entity based rules will be applied to this message</text>\n      <entityId>promotional-traffic-entity</entityId>\n      <applicationId>marketing-automation-application</applicationId>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
              Send Basic India DLT message:
                summary: Send Basic India DLT message
                description: Send a message with India DLT parameters included
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedTextualRequest>\n  <messages>\n    <message>\n      <from>InfoSMS</from>\n      <regional>\n        <indiaDlt>\n          <contentTemplateId>1111111111111111111</contentTemplateId>\n          <principalEntityId>1111111111111111112</principalEntityId>\n          <telemarketerId>111111111111</telemarketerId>\n        </indiaDlt>\n      </regional>\n      <text>India DLT parameters will be applied in this message</text>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedTextualRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026727'
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value:
                    bulkId: '2034072219640523073'
                    messages:
                    - messageId: '2033247207850523791'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026727'
                    - messageId: '2033247207850523792'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026834'
            application/xml:
              schema:
                $ref: '#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026727</to>\n    </message>\n  </messages>\n</smsResponse>\n"
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523073</bulkId>\n  <messages>\n    <message>\n      <messageId>2033247207850523791</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026727</to>\n    </message>\n    <message>\n      <messageId>2033247207850523792</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026834</to>\n    </message>\n  </messages>\n</smsResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-additionalInfo:
        markdown: '### Related

          - [Activate Verified SMS - get look and feel of chat apps on SMS communication](https://www.infobip.com/docs/sms/verified-sms)

          - [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)

          '
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: send-sms-messages
      - versionNumber: 2
        latest: false
        operationId: send-sms-message
      - versionNumber: 2
        latest: false
        operationId: send-binary-sms-message
  /sms/2/binary/advanced:
    post:
      tags:
      - channels
      summary: Send binary SMS message
      description: 'Send single or multiple binary messages to one or more destination address. The API response will not contain the final delivery status, use [Delivery Reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/receive-outbound-sms-message-report) instead.\

        In light of improved features, this endpoint has been superseded. Please visit [Send SMS message](#channels/sms/send-sms-messages) for the next version.'
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: send-binary-sms-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest'
            examples:
              Send fully-featured binary message:
                summary: Send fully-featured binary message
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - binary:
                      dataCoding: 0
                      esmClass: 0
                      hex: 54 65 73 74 20 6d 65 73 73 61 67 65 2e
                    callbackData: DLR callback data
                    destinations:
                    - messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                    - to: '41793026834'
                    from: InfoSMS
                    intermediateReport: true
                    notifyContentType: application/json
                    notifyUrl: https://www.example.com/sms/advanced
                    validityPeriod: 720
                    campaignReferenceId: summersale
                  - binary:
                      dataCoding: 0
                      esmClass: 0
                      hex: 41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
                    destinations:
                    - to: '41793026700'
                    from: '41793026700'
                    sendAt: 2021-08-25T16:00:00.000+0000
              Unicode flash binary SMS:
                summary: Unicode flash binary SMS
                description: Send Unicode flash SMS m… over binary API method
                value:
                  messages:
                  - binary:
                      dataCoding: 8
                      esmClass: 0
                      hex: 0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf
                    destinations:
                    - to: '41793026727'
                    flash: true
                    from: InfoSMS
          application/xml:
            schema:
              $ref: '#/components/schemas/7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest'
            examples:
              Send fully-featured binary message:
                summary: Send fully-featured binary message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedBinaryRequest>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <message>\n      <binary>\n        <dataCoding>0</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>54 65 73 74 20 6d 65 73 73 61 67 65 2e</hex>\n      </binary>\n      <callbackData>DLR callback data</callbackData>\n      <from>InfoSMS</from>\n      <intermediateReport>true</intermediateReport>\n      <notifyContentType>application/json</notifyContentType>\n      <notifyUrl>https://www.example.com/sms/advanced</notifyUrl>\n      <validityPeriod>720</validityPeriod>\n      <campaignReferenceId>summersale</campaignReferenceId>\n      <destinations>\n        <destination>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n          <to>41793026727</to>\n        </destination>\n        <destination>\n          <to>41793026834</to>\n        </destination>\n      </destinations>\n    </message>\n    <message>\n      <binary>\n        <dataCoding>0</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>41 20 6C 6F 6E 67 20 74 …20 45 6D 70 69 72 65 2E</hex>\n      </binary>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n          <days>SATURDAY</days>\n          <days>SUNDAY</days>\n        </days>\n        <from>\n          <hour>6</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>15</hour>\n          <minute>30</minute>\n        </to>\n      </deliveryTimeWindow>\n      <from>41793026700</from>\n      <sendAt>2021-08-25T16:00:00.000+0000</sendAt>\n      <destinations>\n        <destination>\n          <to>41793026700</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedBinaryRequest>\n"
              Unicode flash binary SMS:
                summary: Unicode flash binary SMS
                description: Send Unicode flash SMS m… over binary API method
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SMSAdvancedBinaryRequest>\n  <messages>\n    <message>\n      <binary>\n        <dataCoding>8</dataCoding>\n        <esmClass>0</esmClass>\n        <hex>0048 0065 006c 006c 006f 0020 0077 006f 0072 006c 0064 002c 0020 039a 03b1 03bb 03b7 03bc 03ad 03c1 03b1 0020 03ba 03cc 03c3 03bc 03b5 002c 0020 30b3 30f3 30cb 30c1 30cf</hex>\n      </binary>\n      <flash>true</flash>\n      <from>InfoSMS</from>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n    </message>\n  </messages>\n</SMSAdvancedBinaryRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026727'
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value:
                    bulkId: '2034072219640523073'
                    messages:
                    - messageId: '2033247207850523791'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026727'
                    - messageId: '2033247207850523792'
                      status:
                        description: Message sent to next instance
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                      to: '41793026834'
            application/xml:
              schema:
                $ref: '#/components/schemas/33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <message>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026727</to>\n    </message>\n  </messages>\n</smsResponse>\n"
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsResponse>\n  <bulkId>2034072219640523073</bulkId>\n  <messages>\n    <message>\n      <messageId>2033247207850523791</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026727</to>\n    </message>\n    <message>\n      <messageId>2033247207850523792</messageId>\n      <status>\n        <description>Message sent to next instance</description>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n      </status>\n      <to>41793026834</to>\n    </message>\n  </messages>\n</smsResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: send-sms-messages
      - versionNumber: 2
        latest: false
        operationId: send-sms-message
      - versionNumber: 2
        latest: false
        operationId: send-binary-sms-message
  /sms/1/bulks:
    get:
      tags:
      - channels
      summary: Get scheduled SMS messages
      description: See all [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms) and their scheduled date and time. To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-scheduled-sms-messages
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        example: BULK-ID-123-xyz
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse'
              examples:
                Get message schedule info:
                  summary: Get message schedule info
                  value:
                    bulkId: BULK-ID-123-xyz
                    sendAt: 2021-08-25T16:00:00.000+0000
            application/xml:
              schema:
                $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse'
              examples:
                Get message schedule info:
                  summary: Get message schedule info
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <sendAt>2021-08-25T16:00:00.000+0000</sendAt>\n</BulkResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Bulk not found responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Bulk not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:message:send
      - sms:manage
    put:
      tags:
      - channels
      summary: Reschedule SMS messages
      description: Change the date and time of already [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: reschedule-sms-messages
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        example: BULK-ID-123-xyz
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest'
            examples:
              Reschedule messages:
                summary: Reschedule messages
                value:
                  sendAt: 2021-08-25T16:00:00.000+0000
          application/xml:
            schema:
              $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest'
            examples:
              Reschedule messages:
                summary: Reschedule messages
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkRequest>\n  <sendAt>2021-08-25T16:00:00.000+0000</sendAt>\n</BulkRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse'
              examples:
                Get message schedule info:
                  summary: Get message schedule info
                  value:
                    bulkId: BULK-ID-123-xyz
                    sendAt: 2021-08-25T16:00:00.000+0000
            application/xml:
              schema:
                $ref: '#/components/schemas/2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse'
              examples:
                Get message schedule info:
                  summary: Get message schedule info
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <sendAt>2021-08-25T16:00:00.000+0000</sendAt>\n</BulkResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Bulk not found responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Bulk not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:manage
  /sms/1/bulks/status:
    get:
      tags:
      - channels
      summary: Get scheduled SMS messages status
      description: See the status of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-scheduled-sms-messages-status
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        example: BULK-ID-123-xyz
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse'
              examples:
                Get message status info:
                  summary: Get message status info
                  value:
                    bulkId: BULK-ID-123-xyz
                    status: PAUSED
            application/xml:
              schema:
                $ref: '#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse'
              examples:
                Get message status info:
                  summary: Get message status info
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkStatusResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <status>PAUSED</status>\n</BulkStatusResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Bulk not found responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Bulk not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:message:send
      - sms:manage
    put:
      tags:
      - channels
      summary: Update scheduled SMS messages status
      description: Change the status or completely cancel sending of [scheduled messages](https://www.infobip.com/docs/sms/sms-over-api#schedule-sms). To schedule a message, use the `sendAt` field when [sending a message](#channels/sms/sms-messaging/outbound-sms/send-sms-messages).
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: update-scheduled-sms-messages-status
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        example: BULK-ID-123-xyz
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest'
            examples:
              Update message status:
                summary: Update message status
                value:
                  status: PAUSED
          application/xml:
            schema:
              $ref: '#/components/schemas/c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest'
            examples:
              Update message status:
                summary: Update message status
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><UpdateStatusRequest>\n  <status>PAUSED</status>\n</UpdateStatusRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse'
              examples:
                Get message status info:
                  summary: Get message status info
                  value:
                    bulkId: BULK-ID-123-xyz
                    status: PAUSED
            application/xml:
              schema:
                $ref: '#/components/schemas/b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse'
              examples:
                Get message status info:
                  summary: Get message status info
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkStatusResponse>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <status>PAUSED</status>\n</BulkStatusResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Bulk not found responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bulk not found:
                  summary: Bulk not found
                  description: Bulk not found
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Bulk not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:manage
  /ct/1/log/end/{messageId}:
    post:
      tags:
      - channels
      summary: Confirm conversion
      description: 'Use this endpoint to inform the Infobip platform about the successful conversion on your side. Infobip will use this information to monitor SMS performance and provide you with better service. To enable Conversion Tracking, set up the “tracking” object to “SMS” when [sending a message](https://www.infobip.com/docs/api/channels/sms/sms-messaging/outbound-sms) over HTTP API.

        For more information, see: [Tracking Conversion](https://www.infobip.com/docs/sms/api#track-conversion).'
      operationId: log-end-tag
      parameters:
      - name: messageId
        in: path
        description: ID of a converted message.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse'
              examples:
                Reporting conversion response example:
                  summary: Reporting conversion response example
                  value:
                    processKey: A37D448C1ACCA02FABA745522558326C
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse'
              examples:
                Reporting conversion response example:
                  summary: Reporting conversion response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><EndTagResponse>\n  <processKey>A37D448C1ACCA02FABA745522558326C</processKey>\n</EndTagResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-is-early-access: true
      x-scopes:
      - sms:manage
  /sms/1/inbox/reports:
    get:
      tags:
      - channels
      summary: Get inbound SMS messages
      description: If you are unable to receive incoming SMS 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. To use this method, you’d need to:<ol><li><a href="https://www.infobip.com/docs/api/platform/numbers/phone-numbers/purchase-number">Buy a number</a> capable of receiving SMS traffic.</li><li>Specify a forwarding endpoint for the number and optionally configure other <a href="https://www.infobip.com/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration">inbound settings</a>.</li></ol>
      operationId: get-inbound-sms-messages
      parameters:
      - name: limit
        in: query
        description: Maximum number of messages to be returned in a response. If not set, the latest 50 records are returned. Maximum limit value 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 was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse'
              examples:
                Receive SMS:
                  summary: Receive SMS
                  value:
                    results:
                    - messageId: '817790313235066447'
                      from: '385916242493'
                      to: '385921004026'
                      text: QUIZ Correct answer is Paris
                      cleanText: Correct answer is Paris
                      keyword: QUIZ
                      receivedAt: 2019-11-09T16:00:00.000+0000
                      smsCount: 1
                      price:
                        pricePerMessage: 0
                        currency: EUR
                      callbackData: callbackData
                    messageCount: 1
                    pendingMessageCount: 1
            application/xml:
              schema:
                $ref: '#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse'
              examples:
                Receive SMS:
                  summary: Receive SMS
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n  <messageCount>1</messageCount>\n  <pendingMessageCount>1</pendingMessageCount>\n  <results>\n    <result>\n      <messageId>817790313235066447</messageId>\n      <from>385916242493</from>\n      <to>385921004026</to>\n      <text>QUIZ Correct answer is Paris</text>\n      <cleanText>Correct answer is Paris</cleanText>\n      <keyword>QUIZ</keyword>\n      <receivedAt>2019-11-09T16:00:00.000+0000</receivedAt>\n      <smsCount>1</smsCount>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <callbackData>callbackData</callbackData>\n    </result>\n  </results>\n</reportResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - sms:inbound-message:read
      - sms:manage
      x-additional-versioning-information:
        latest: false
        versionNumber: 1
      x-additionalInfo:
        markdown: '### Related

          - [Buy numbers for sending and receiving messages](#platform-&-connectivity/numbers)

          '
  /sms/3/reports:
    get:
      tags:
      - channels
      summary: Get outbound SMS message delivery reports
      description: If you are unable to receive real-time message delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of message reports to confirm whether specific messages have been delivered. Each request towards this endpoint returns batches of the latest message reports. The API returns each report only once. If the message status changes again after retrieval, the endpoint returns a new report for the updated status on the next request.
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-outbound-sms-message-delivery-reports-v3
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports'
              examples:
                Delivery report:
                  summary: Delivery report
                  value:
                    results:
                    - bulkId: BULK-ID-123-xyz
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                      sender: InfoSMS
                      sentAt: 2019-11-09T16:00:00.000+0100
                      doneAt: 2019-11-09T16:00:00.000+0100
                      messageCount: 1
                      callbackData: callbackData
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                    - bulkId: BULK-ID-123-xyz
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                      to: '41793026834'
                      sender: InfoSMS
                      sentAt: 2019-11-09T17:00:00.000+0100
                      doneAt: 2019-11-09T17:00:00.000+0100
                      messageCount: 1
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports'
              examples:
                Delivery report:
                  summary: Delivery report
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>41793026727</to>\n      <sender>InfoSMS</sender>\n      <sentAt>2019-11-09T16:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <callbackData>callbackData</callbackData>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <to>41793026834</to>\n      <sender>InfoSMS</sender>\n      <sentAt>2019-11-09T17:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: get-outbound-sms-message-delivery-reports-v3
      - versionNumber: 1
        latest: false
        operationId: get-outbound-sms-message-delivery-reports
  /sms/3/logs:
    get:
      tags:
      - channels
      summary: Get outbound SMS message logs
      description: Use this method to obtain the logs associated with outbound messages. The available logs are limited to those generated in the last 48 hours, and you can retrieve a maximum of only 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports-v3) if your use case is to verify message delivery.
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-outbound-sms-message-logs-v3
      parameters:
      - name: mcc
        in: query
        description: Mobile Country Code.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Mobile Country Code.
      - name: mnc
        in: query
        description: Mobile Network Code. Mobile Country Code is required if this property is used.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Mobile Network Code. Mobile Country Code is required if this property is used.
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent'
              examples:
                Log:
                  summary: Log
                  value:
                    results:
                    - destination: '41793026727'
                      bulkId: BULK-ID-123-xyz
                      messageId: MESSAGE-ID-123-xyz
                      sentAt: 2019-11-09T16:00:00.000+0100
                      doneAt: 2019-11-09T16:00:00.000+0100
                      messageCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: This is a sample message
                      mccMnc: '22801'
                    - destination: '41793026834'
                      bulkId: BULK-ID-123-xyz
                      messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                      sentAt: 2019-11-09T17:00:00.000+0100
                      doneAt: 2019-11-09T17:00:00.000+0100
                      messageCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: This is a sample message
                      mccMnc: '22801'
            application/xml:
              schema:
                $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent'
              examples:
                Log:
                  summary: Log
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><LogResponse>\n  <results>\n    <result>\n      <destination>41793026727</destination>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <sentAt>2019-11-09T16:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n      <content>\n        <text>This is a sample message</text>\n      </content>\n      <mccMnc>22801</mccMnc>\n    </result>\n    <result>\n      <destination>41793026834</destination>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <sentAt>2019-11-09T17:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n      <content>\n        <text>This is a sample message</text>\n      </content>\n      <mccMnc>22801</mccMnc>\n    </result>\n  </results>\n</LogResponse>\n"
        '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:
      - sms:manage
      - sms:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: get-outbound-sms-message-logs-v3
      - versionNumber: 1
        latest: false
        operationId: get-outbound-sms-message-logs
  /sms/1/reports:
    get:
      tags:
      - channels
      summary: Get outbound SMS message delivery reports
      description: If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use this API method to learn if and when the message has been delivered to the recipient. Each request will return a batch of delivery reports - only once. The following API request will return only new reports that arrived since the last API request in the last 48 hours.
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-outbound-sms-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: Unique message ID for which a report is requested.
        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: 2
      - 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: 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: 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: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: BULK-ID-123-xyz
                      messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                      sentAt: 2019-11-09T16:00:00.000+0000
                      doneAt: 2019-11-09T16:00:00.000+0000
                      smsCount: 1
                      callbackData: callbackData
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
                    - bulkId: BULK-ID-123-xyz
                      messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                      to: '41793026834'
                      sentAt: 2019-11-09T17:00:00.000+0000
                      doneAt: 2019-11-09T17:00:00.000+0000
                      smsCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      applicationId: default
            application/xml:
              schema:
                $ref: '#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n  <results>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>41793026727</to>\n      <sentAt>2019-11-09T16:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <callbackData>callbackData</callbackData>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <entityId>promotional-traffic-entity</entityId>\n      <applicationId>marketing-automation-application</applicationId>\n    </result>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <to>41793026834</to>\n      <sentAt>2019-11-09T17:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <applicationId>default</applicationId>\n    </result>\n  </results>\n</reportResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - sms:message:send
      - sms:manage
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: get-outbound-sms-message-delivery-reports-v3
      - versionNumber: 1
        latest: false
        operationId: get-outbound-sms-message-delivery-reports
  /sms/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound SMS message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call. See [message delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) if your use case is to verify message delivery.
      externalDocs:
        description: Learn more about SMS channel and use cases
        url: https://www.infobip.com/docs/sms
      operationId: get-outbound-sms-message-logs
      parameters:
      - name: from
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        description: Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes).
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside `sentUntil` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2015-02-22T17:42:05.390+0100
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside `sentSince` to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2015-02-22T19:42:05.390+0100
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is `1000` and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: mcc
        in: query
        description: Mobile Country Code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: mnc
        in: query
        description: 'Mobile Network Code. Mobile Country Code is required if this property is used. '
        required: false
        style: form
        explode: true
        schema:
          type: string
      - 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: 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: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse'
              examples:
                SMS logs:
                  summary: SMS logs
                  value:
                    results:
                    - bulkId: BULK-ID-123-xyz
                      messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                      sentAt: 2019-11-09T16:00:00.000+0000
                      doneAt: 2019-11-09T16:00:00.000+0000
                      smsCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                    - bulkId: BULK-ID-123-xyz
                      messageId: MESSAGE-ID-ijkl-45
                      to: '41793026834'
                      sentAt: 2019-11-09T17:00:00.000+0000
                      doneAt: 2019-11-09T17:00:00.000+0000
                      smsCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: Ok
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
            application/xml:
              schema:
                $ref: '#/components/schemas/b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse'
              examples:
                SMS logs:
                  summary: SMS logs
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><smsLogsResponse>\n  <results>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>41793026727</to>\n      <sentAt>2019-11-09T16:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n    </result>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>MESSAGE-ID-ijkl-45</messageId>\n      <to>41793026834</to>\n      <sentAt>2019-11-09T17:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>Ok</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n    </result>\n  </results>\n</smsLogsResponse>\n"
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sms:logs:read
      - sms:manage
      x-deprecationInformation:
        deprecation: 2024-05-16T12:00:00.00+0000
        successorOperationId: get-outbound-sms-message-logs-v3
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 3
        latest: true
        operationId: get-outbound-sms-message-logs-v3
      - versionNumber: 1
        latest: false
        operationId: get-outbound-sms-message-logs
  /mms/2/messages:
    post:
      tags:
      - channels
      summary: Send MMS messages
      description: This method allows you to send MMS messages to a recipient or multiple recipients in one request.
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: send-mms-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRequest'
            examples:
              SMS failover:
                summary: SMS failover
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - text: Some text
                        type: TEXT
                    options:
                      smsFailover:
                        sender: '441134960000'
                        text: Some failover text
                      regional:
                        southKorea:
                          resellerCode: 123
              Text with regional options:
                summary: Text with regional options
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - text: Some text
                        type: TEXT
                    options:
                      regional:
                        southKorea:
                          resellerCode: 123
              Text with group destinations:
                summary: Text with group destinations
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - group:
                      - to: '441134960001'
                      - to: '441134960002'
                    content:
                      title: Some title
                      messageSegments:
                      - text: Some text
                        type: TEXT
              Text:
                summary: Text
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - text: Some text
                        type: TEXT
              Image as link:
                summary: Image as link
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - contentType: image/jpeg
                        contentUrl: https://www.example.com/image.jpg
                        type: LINK
              Text and image with smil:
                summary: Text and image with smil
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - contentType: application/smil
                        smil: <smil><head><layout><root-layout/><region id="Text" top="70%" left="10%" height="30%" width="100%" fit="scroll"/><region id="Image" top="0%" left="0%" height="70%" width="100%" fit="meet"/></layout></head><body><par dur="10s"><img src="image_1" region="Image"/></par><par dur="10s"><text src="body.txt" region="Text"/></par></body></smil>
                        type: SMIL
              Previously uploaded image:
                summary: Previously uploaded image
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - uploadedContentId: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
                        type: UPLOADED_REFERENCE
              Multiple images:
                summary: Multiple images
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      title: Some title
                      messageSegments:
                      - contentType: image/jpeg
                        contentUrl: https://www.example.com/image1.jpeg
                        type: LINK
                      - contentType: image/jpeg
                        contentUrl: https://www.example.com/image2.jpeg
                        type: LINK
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '441134960001'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mms:message:send
      - mms:manage
  /mms/1/advanced:
    post:
      tags:
      - channels
      summary: Send MMS message
      description: This method allows you to send one MMS or bulk MMS to a recipient or multiple recipients in one request.
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: send-mms-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.MmsAdvancedRequest'
            examples:
              Send basic textual messages with image link:
                summary: Send basic textual messages with image link
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoMMS
                    messageSegments:
                    - text: This is a sample message
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
                    title: This is sample subject
              Send basic textual messages with uploaded image:
                summary: Send basic textual messages with uploaded image
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoMMS
                    messageSegments:
                    - text: This is a sample message
                    - uploadedContentId: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
                    title: This is sample subject
              Send basic textual messages with base64 content:
                summary: Send basic textual messages with base64 content
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoMMS
                    messageSegments:
                    - text: This is a sample message
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentBase64: /9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCADVAUADASEAAhEBAxEB/8QAHAAAAQUBAQEAAAAAAAAAAAAAAgEDBAUGBwAI/8QAPhAAAgEDAwIEBAMHAgUEAwAAAQIDAAQRBRIhMUEGE1FhByJxgRQykRUjQlKhscHR8BYzYnLhJDRD8SWCg//EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACgRAQEAAgMAAgEFAAEFAAAAAAABAhEDITESQSIEEzJRYXFCkaHB4f/aAAwDAQACEQMRAD8A3ca+lSo1r1NOJIQU8opaM8oFOKKWgcXFODFIQokQHqKdRgehpWGcBos1JiDA0uaRiBFFQCiloD1KKBotJmgnqSkNBlljhieWZ1jijBZ3Y4CgdzWP034g6Ve37wnfBGX2QvIRiTnGfb71GfJMLJV48dy8bEMCMg5HrXs1aNPZr2aY09mot4fkNBK+1P70VoE/5QpROSDP+amGGaxq4adajE4k4pU4mQudtPrLWsoY6OpMddbM+pp1TSBma+jh4JGajnWIs43D9aBvQk1mL+YVD1PxLDBGfnAxSNirv4j2sN35TTAHPrWy8OeJIr9FZHBB96zmW+lWabCGUSICKdQ5YD3oofNXif4ieJdF+IGvwafqDx2sF7JGlvIiugUH0PrXTfh/8U7bXWW11dYra7bhZEyEY+4P5T/SuXDl166c+PfnrpysCAQcgjIIoga6HOIGlzQC5rwNBlzXqCJXs0g4z8TfE0mq6n+y7J91jCSJFBIV2Hdz/YVhNWFza8C1ljhwAWK5LccnHavPyyuVuTuwxmOMjsXwi8T/ALc0aS0uJS91Zgct+ZozwCfUg8fpW8zXbxZbxjk5MdZV7cPWvbh61ozIXGOtQr2QCM0DSvtZR5w55rRxuDEKUTlESb81NmsvtU8NvwKrZZQJcUqrFZW/zJSsCKuFfWVj+tPoRXazOqRUfUrxbWAknBxSNzPX/EMrXDJC3P1rN3Gt30RJ359qXZb7Rx4ovEPO6oeo6xd3kZCuQPrS3tTG31kXmLEkseproHwv1KW2uRbyOSq9MmsscNZbXbuPoTR7tXhXntVrHMN64POadTHzV8etCfS/iPeXSLtt9TUXUZ6AtjDj7Ef1rD2V09vKrFsMDnI4Fed507p/bsvw/wDiRc2iR2uqEzWg4D9WTt9xXZtN1W2v7ZZ7aVXQ9xXRw8m/xrLl49flEvzxS+ePWttsNENwPWvfiB60HopuV9aQ3I9aCAboetZj4geJf2NocpgYfiZQFQZ9Tj+5rPly1jWnHjvKOLRRTftCUTrBPKxG5Zwy7D32gDOftU+/tHltd6aflwv/ALhZmYg/QjJP2xXHp12w78FryWw8bXFrIxIuLZ1ORjOMMP7Gu5G9HrXT+nv4ufnn5Aa/A6mgOoD1rfbHQG1EfzVXajqQEZw1K0aVen6gZbpVQ/Wt5aMTApox8RmCZwXxQ5rK+nDcudpqgu2Zbnj1pZLx9aCwGYgafdeK1niL650uor604NRUd66vknT0mrRxrlm/rWL8VeJl2uFko2NMCb1JJGd3+Y0ccgkPDBh708bLdIspu9SMR8Ha1U5lKNjPFHLrGrx7mjc0in0zVj4dufw2oI44zWUyXp2/w3qpaBOe1aEX5/mqcqJFZ8TdB/4x8EPLEm7ULEGeBgdxbaPnQfUDp6ivl99qkHs3UdDXn8k1nXZhd4xN0u6CyFGlZOMgk9623hzxtJockbLPuAOHQD849/elLq7ivZqtzbfFq1lmjRrV1VjywbPFa2y8W6deQJJFdx4YYwzYINdOPL8nPlx68Sn161QIzXEe1u+6n49VjkUMjBgehBq/kn4jbUQM80DaiApOaPlB8UC68RW9vJFG8qmaRwiRryzE9Biua+LdXj1TX7syv5lvZjyo9uSxlBySACOPfIFYcuW9Rrx467V2jy3EaLNaRiWZ32r0YIOuDnAz9z9Kt/EGtNoemje0LTEYZ0i+RG/uefSs5bI01uqbwFq0l14705riNPMZZCpUggfuzyD3FdaOocfmquLk1O08uG6Yk1D/AKqYOoH+aqvKn9sDXzH+KolxO0oIB60fPY+Gk/wtZt+J3P0zXULGMCEZ9K6OLxzck7DPbhnyBQ+RSs7EC8ORVXdWQMmcVNhxZWMeIwKkMlaTxN9cGW6GOoozeAKTkVtjfkLNM9rGouwZUb+tYzUPOkkJck+lVcdJ32rZNw6ggUVrdPE+cEist6u2mtxMuLnzIwc81WMxJyTT5M9ljNBZsGpNixMykdAayl7U6l4dvCI0GeBWoF3wPmo5svirjx2ufD2pTo8qwYfbhyh7gdcH1rk3xq8F/grh/EOhQ7tIn+a5hjX/ANq56nHZSefbNced+V26MeunIfxGPyd+h9akwkyOhkk+XOOvftilILVjZ3SxgMg2rg5I+bGOhNLeatJPbSxpKyDIKr04wKqJ2WbXp2tI40YgY6EnOf8ASpWl+KtUtii291LkdBu4rTG2Jqxbxfq/lsst5LhjkgNTzePdYMQgguGJUjnGTRsLPwtfPbW+oa9fOry2+6K13tndMRhn/wD1BwPdvaqvQbm6NhI0u+R2djEiRknIPJ9z/SsN91o1FnfXUkKCO0la8XAwVA2EjkkjAJrH+Io7n8aGvGImBJ3F+nt1xRl4ePq5+GLq/iuO6kcRJbQSs7AcEFCBkduSK6ebe5HytkEcHis5LZ00ysl7eFnO3V2pfwEuDnOKuYVFzQ7mGSIEgnFOaU4kkAatMcNIue270SFVVWFaqC42piujG6jDKbp9Z1Y9qPcPaq3tOjbsMdRUK4kXPalTiRaMCKkNirx8RXyhqmsG1JVxgiq8eI94wTgfWnw56na+Sd9HYtQjlyWbJpm5MUn5SK65lLHPqo2xScYBHvXvIiCnKrSuMvp7qDdqgyFAqC8RNcuc76awHk88mp1moXGKnH066P4V0+SWJC3U1uLfQS8YJ5qeXD5Kwz+K10fR5LO6WWFmVuh9CD2NLqbXVlJ5c3Nu67X3AsP/AK+tc+XHqaa457rhHxA8LWEwurnR7eO0voHaSW1ib5JUyclfRuhwOOa5/BZ/iIzLHOgK4ARgR9ftUS/2qwdzY3ViDveLy1bqG6qO+P8AFR/lyomb5QdzA9W4q5/aalWdnJqTgQq7BQSERcnApx8WTMm0GQYJbsB6VUIrpLNdW8YiaNrgAxBs/MD3HqKkD8TBpk9pErLOkrRuwGPMPoT9Pepypw4dVC+H9LtEYKkSHepHO/eSf8daas7uQLKoYknI4kOFJPOPX+1ZxW1to800837Omuruz8wY82HDN9/Wmda064tJjCt3d3EZPAuExz68Eg/0oqptJvm/Z2k2P7NmkjXU4/LuJO/EgBXPbJ/pX02lvFPuYD5s4Ip8c9Lmt6Ox2K96WSzQDpWrDao1HTgQcAVmXgNnc7sYFVC202kaooAAYVfR3+QMN/WlvTTWz6X3PWnv2gB/EKJkPibfUAf4qiS3e5lwaqZbK46XOlsSOe9WBNbTxjfXyR8TdJuIJ/MhUlc8gVzsSsrYOR7His8vxuly/KJkF4yjk1MjvCehOfrTmdFxSYruTPY1MW43LyK1x5L9ouIVQOSSKCVCRhFyfYUWzWxA2+lXly3yIQPU1qtC8ITPKjTZPPSspuqrrvhzRVtkQbK2drbJgDArVlU1bdO3FUHi6xkuLTzY7kRyJwvyL0785FZZzbTDLTj/AIxtzcBbmB0abBV93I/7uDnJwOvtXJLyILcPKsLRqXKuXA+U8lenIzXHfXV9BvY9kj29vmdpVVXwCQgOOckdPb2NWPjK1i0q0txFLbPPsVMIoJAPO4H3z35FXE0/p95t8Hv5FvawKqlJJFOGORgkjOT/AKn2rJXJWGPyNwYoNueecjOefc04lY61qVxcwWUqXLJcWxygPGCQMkEfQUlvczXVuJLssZEQoCvQDJ5wO/PPfv2pU0SMByZopF3oxZh0IHT75/zWgsrAvZMWBEi4DKqYx3OT681FVFUs8xUoIFhBJJYqASvbHfNVMaMq4ViFJzyfze4/1p6KVttOltp/A09kQw33sGx35MfzbnYH/tFd+8Fav+PsY5g2Vl7bgcH7Clje1ZTcasNijY7h1rZgjTIGBBGazur2YIPFOFYywme1uNuSATxWn02ZpEHzcmo5Zrtrx1ZqrY6mjEbHqTWUrQaw885qXBEuR61rhUZL7T8DFWJGeldcu45bO3F/FlnHMjkqD9q4Z4psQlw3lqOvaly9w+NmjFKv8JpxDKvVTXPttpOtvOcjbGx+1XVnYX05ASFvvVzNNjS6T4WuZ2BlVgPpxWz03wWgA3J/StN79RWjs/C0MRGY8/atBY6RFFj5QMVSVxFAqLwKkR/LjilstJIfjiqfXZrFLdzfqDH3qMta7VjLvpyy/m027nnext5SI3wx27t4x2z6VhNTtYJZ/M6Sh/LJXvknHJH6ehrjv8nZPESXQ8SosSeawLYZABg4Jw/PUc5+/tReJdKsb+133u618nczEnlG5Gwevbj296qVGlPcaPN4e8OyveSkl5VzCgAZASBlgeeR+lZwQLLrE5GGRSXjUnG/njrVbJfvo9xPYJFNb7rjay4VQOTnPPcj1qBaeTJBbiFTbosajb+c79xGPU5xU7MzLYyxT/v1ixt65BAHXGKlWt9cRKrAyPEhLEcFT3I/z/egLqw1LRr6/wB2q29wIdv7tDgLu9WOOfuePSmPHltp62cU2jqhVTsZywy5znC89O5PsBwOKJewqdGee3EMU8Dxxb9+5eQM8fTPNdr8BSRWQaKMkwuVZCW6H0pfavp1SMhkBGOlEvHWtmBJMYqvvI/MQ0Bjtbs+SwHSntAmAIVm5FGc3Dwuq2EAR0BFSFjU1zNzgjUUShQacyKxNtptvSrKCcECuvizYZ4uQ6hHcToQFz9ayt14TkvJSZEGD6U7upx1CJ8P0fqhP2qbb/D2JSP3a/cUpgq5L/TvAtumCYlz7Cr+18KwRrxEv6VcxkRta2+jxR4+UfTFWEdoiKMAU0ieIDpiliTmlsaSAoxQEc0j0SR9qHkgiuVeKrm512edXkMVtEdgKEHd68d/pWXJdRrxzdYJPEP4KA2EcLSNEeHZmZduepK8g/Xig/EyXdxLLDPCbiGQCQmINGi5BI5P5u/Fc97bH01WCW4FpC0U1wxCW7lf+YCcEvj2JAPHp6UKWCXfiuCB5fNTSl/ETHgGYjlVYDr2/UU9+UKvxVqP4/wbLfNGQ08bSkN0WQOMY9wDzn096wFiqS6hDtQKsxjAJzhdzA5Pt1/WqiWovY7yXxjp5tp/Kt2QyqN+Mopxz7nGffiqg6hEdenghiAi27A0eR83qB9zS9NHnsL+LVTZQIWmDHy1Xljn6jH1PtxU5LeV8NcsIXEki7lYYYjHYdqKEdskEvFKSFI8tTlR/wBx+vOKYaZrNJIYlBixsZTgtn1HNMmg8K2xuAxlmboCFz0+vqa2um3MtoiR7d0JPPltg+3I7e5pfZun+EtaW409I5mUPF8hVavzdx49PvW07jK9U21/FjqKhz6hEP4lp6JQ6vqEJU4IrMR6qsN2Avc1X0Xe260S98+NSM1oIzwDXJk6IdJ4oC3NSo9E3FPpMVPWtcLpnlNqUQQ7TmljhgU9BXf8XJtKQW49KMPAp7UrD2kR3EK+lGb2IDqKNDZv8dEP4lpf2hEB1FKwbMSajFjORQpqcY71OgI6sg70xJqyjPJpGp9d1vFjIiq5D/LlDyM9/aufeJLsW0CFWkO0hVP8TH0ZehP/AFVzc1+nRwzrbGKn4aaOZoRLLLzITJnccnjHf9ak3NiZHig8qOGOYlss+1nb+RsDBHHAPXpWTRN8I6RH/wAT6tPLETE9sYgyrt2NgY4P05HHTrmqjwPLJF46u7O5fc11aTxMCcZZeevYj+vFV9F9quyuLWbwRqujSSSNNBPLHaBgGyS3G70+vtWKtwDcxRtHMHVQsiIcEEdf6U4VaVLuSTxpb3Id54RAQhdhyvf6Y9KY8DxI2uXdxMmTAWZSThQxJAo8CyuraTUdXuZpo42Q/wDJUysAcDGcd/c/3qe+mLMGeKSDhOcYVEOB2xkn0zxx3oJRXywwy4hLLJGMRxo3OP4iT3J7kmokcck9uhZwdq7QhHzJ7foM0Q0nSZlWdGUhwnRM9cepPatjY3zCZTKkRIGWbd8gz39/alfTjV+Gbr/8isdqS5mHJI649B/rWya3uD/MauZ6iMsewNaXB9ajy6fcMMc0ryCYIcujTyZBBxUdfDT+YGINReS3xcxjU6LYm3UA1o14UVMuzpGami3NBnompwtVxNZETTkclqNTNn+I123lcswPKJ27GnVgmPY1F5T+B6O1m9DTn4SY+tL90/gT8FL6V78HLUXlOYPfgJDRLpz1P7p/A4umOetGdKPej50/izfiyA21oTHuZl+boD0rl99IL+aD8RJJyx2RbCByMe9ZZ91rhNRBnVoL8lUJCKAAADtHdh9OOO9bC2NgdJOoandNtC/MXIRQfUDjJ+9H+nVZpXiDRv2i9zDexI7j5TO+wyEHgZPH9s+lUyWkll45/bMETvZ3KOAVfPlORgr6EH1FTacm0HVdCIv7q9tY1t3kYF0cZEhCkkgdskgH61jtPilk1V7gOwZpCXYAYbnnjPA7VcvSb6n21sYNSnWPcGdjlXHK4OeD6E0Ec8Wh3DzAPc3txIZI4lI5wep9B1pb7OdTZjVbjV4ij3UwhWZjuRMZC4Bx05qfqU2pWt5aQC4iuRLtVd0YznHGDV66RMu1JONQjd2W2RjkqT8uR9OKbg1ea2cxXEHloeoUYP6+lE1ReksIJ3E9iXjOegGe3pVhYXFzG5jcJsDZyACeP8VN7OOm+GJ7O0jgmldjtlUjbwMnrmuzWiRTqGReD3NH0d9S/wAIn8ooGtE/lFSYBZrn8oovwa46UhsgttvQCvMhFI9m2BpoilaZ2MU7g1pKmootohRLDEO1XajR6OOP0qQiRjtUbGjmEHYUhK+gpfISELL6UJYelTaeng3tRK3tRs9HkNExOOBz9KqJ0518TGe0gW7dF/DKPnwWVj/ivn7UfFTSSssMagq2Y2yfl56fSr1tUuoO0sdU1lHurm9e2tVcL8gJLt64/wA1Y6/4cW18I31zFLJc3CAMSRjCg85+3apt7khzzdaD4h6jYeIPhvox0OCOQxWsCSwRRgMGXKkEAc+ufc0Elvb6BaSTRp5YW2SS4ijO2OZwB/D0DZ7j75rXkyxs0ww+WNbTVbCCJBJFGDHeWXmAtj92GGf74rkc8CW8xY4/dtgsMDdkHJ6cDk4+1ZY3pvl6d0CJZ9ab+TyQwz6461lrueNfEd3M2WVJDGFPUJ7fenJu2FfFzePY6nZxi8lGEYOHUgdOv2NSNGWPUtTXUp2WLSrHhX6B36AL64pY3L7TqIOsaiLm4L2qb1Z9iZHv6ZpJLaW+vJITYhwABlmGQQOfm7AVXilFDcNBcGCVF+VioOeP/NWsF/aicfMxdiPMJ6Hn2p2f0UrcaHerc3Sx2KxyKeWZmLbcH9K+iPDEslzpdu8km9toyQABn7VN8OrsIMUhUUiJtWiCjFKADKtMyKKVOI7oKYYc1NXBpineKrEqjiM0QiNXkiHUj6U8qVBj2cUOykHtgpNgpAYjFGqAUwcVQKcGMVUTWG+K1ib3w84yoRGDMxJG0dz6VxeXwLbrE09uBMp6OG3bj9KeV0vCSzs9d2Jt7GGKKLyb+KPCvk+XIPsDhqpbXxLd2MMltqFitxbS5V4S4yR3w3f71M1s6obcPZ3Mh8OahHHExz+EuyUZSeynofrUrUbDxJeWMk+qRR2tgmNzB95YnpgDrVbxlly9TMbfHTdK1dNb0TTZgCVjtFgVVAGW3Y/xmsZ4ihA1BLePkxr8xIPzdgSf/FKLqnN4ti/nsoC8o46nFZLSkt9Q1Im9LJEzMzNux/Wqx3N1F71FkbTS7WR0t4DdOv8A8lxJ8gxzwo6/eiu7q4unj/FTkIuAoJAVB6KowBTm/aV/qAgtzNJHb2MoadyB5ig8Z9+1bFdPayhjtVz5mzBkY4XnqfWpyqsYxN/pEjXcuMfKepoodLjh2O+S+eAOn1qvl9J01fh0La6g8ayMiBASFxn6da+iPh5MX0GDhsZON9I2vycUhzUjQeaLnFIBbNAVJpHDbRmmWiOamqleEZFKVNViVpAeKJauohxadWoMRHFNE0AhY0IJpAYaiDU4Bq1EzHHBxVQmL+JMFxdeG7pIbgKQMlQDyPTIriEWt6zbZihhiuSpxt6kj2Of8UZas7Vj/i68NeI7HV7WbSdXVbC8kJMZkwNr54OTVN4l0hdPvJo5rRIryU7mVnKxso/iU9Dml4r1kb2NWl8oICQpygJ2hj709KbqDQJ7IzsbZgJNm47R/s9qqyXW0y2eL3wbPLpekm2stxmD5cFche/3xmpWqyebD8uFl/jYcZ96yt7azHpitZlkjDxP+8Yjj1ye1V1rbmC5VkAKthhleP0rbHxjlO02SFmlAgXLDoOmf9TXopMnMqLHtOAXQsM9yQM5J96oml0ucafb5tIFnlYfLNNGY1T3UDk/oKzd7LqUN2blrqSbc5ZlRTs3fSs8bN9rsq5uWS9SG4IxuQGTcCAD61TXmoQs48u2RVTgMSRn7ZqsYm1eeHJZobCdxDtaUgllPIHqMnrX0J8ILoXHh2NVUqykhizZJp0nQwgxSFBWYDtGaMKMUAJUUJUCkYGxTbBaVVAnaKAkGiUWIgajVquoOq1Oq1LRvM1CTmgiUmKRlAohTAxRdqZI91CksTKwOCMHbxXDvGfhRJby4udJMkF7bvnenJbvyf8AFFvSsVMLm31OFLbXLRYLpOBcmIYGPUEdatrC1muLSS2jktry3UdQgmTnsRncP1rK7x/4a9X/AJVOo+GVsZvMbZIGUHbbLtIYdyvt71TwWUV686NMsjghmiJycZ4JPvV7tidSVYxKttJqBWIgQQq21TnOTycVRXmox/hP3UMryMc7QhOR369KUx33aq2zqRnb5ne5gMsTRsx2hGXlj6ipjI8MQBVGYA/ISAOPU9q0Z6v2iTSoSAFYSkDMatuwPfHatZ4YSMxyzJbbHReCzH+pPT6e1LPwYeoWsW93Lh4XwxJzk9aq0tpxC8dw7Ar/ACpWeNjTKKuWNkYKGeUgbV2nP6jNTNH03fKZ9Qddqc7G4x9a3YaW9xcQvIgiVWX1QnAPtXZPhle/ho7dXjcKw7r0o10f27AkmVBGaCRzWR6NqzZp0E4oPTxJoCTUmBg1NsGpU4bZWoQh96cFRl6U4orXbPR1BzTqiptGhha9tqdm9trwWlsaKFpdtGxouKICjY0R0DjBUmsZrtmbbWcrH5KXCn5+vzAccD+9aTuFPXPfEHhV7mb8Qn7zk43x43n1x1oNEguvOWMxtbwxfl3bY1z7L1P6VGt9ba7163a6Na3+jXKea0kzrlpHfYV49cZH6Vy2/wBL/ZVwIrTUrSNFlDO+CA6EYVSWHIz3FO34iT5NfpGg2WuaPJ5V4sV/s2NPaP0x2weoz2Ncv8RRfszzbe9l8nUPLePaikfvBwGUejAgjHc1lMNyWOjHkmNsyvWv/Kz8N+E49I0b8Rq6O+oOm4s7Fyg/lHv9KyGqCKWeY+TfSRk7fLKbAc/xDvW2/wAunNr8e1no1mzDy4dJW5EaiNWluNhbPfj/AFrqNja6t+zt0QNugwDGk27cMf8AVx/aj8reqWpPYxvivWbrTWxfRQsjcATRYLfccGsdceIra4UpNprKp6tBOIiB7HGP1p4Tf8oWV14b0610y+uP3GpXEbD/AOO/gwB//RNw/VRVpfaVeeVvK27W+AqmKVdp+jHGT+tXe70ieD0mwuHnJfzY9mGCpGVHp3GDXRPDJaCeNCZSvfc3f7U/oR3DRd02nwuVAJXpU8xDuKyVt4RgUXlijRbCUFJsFGj2QoKBkFLQ2bKigIFBqhHFOq1MjqvTyt70jOBhSg0tEXIpaWgUUQp6Ba9QNvUxd2Ed4oDjoeCWP+KvD1NNP4eCINg7Y3Z6Cq+z8MQWs0krKXLnJbb1P16mtZhq7Hz6T0VLZiqwDHcgdPr/ALNZ/wAV+Frm/lF7biEycfu5l3Yx0+n+KnkwuU6PjzmN7BBoEsNjtimijmY5k8qEKPpzz96418S7q20u8gW4xe3scoeRFGWGTyd38PHQUY8XxPLk+R+217w9fWvnw6ndWcwBZ45gykkfTINQJ9LFww/CX1zcK7eYJEkVtp/lHtWPJhZdtePKWaW+i+F1mUSXk+oQkHcDgZGOxGefsc1fa1K2g6ergSS2wALMj7jg/wAQb0+tPGXW4WV70xWra+txYyOWguLByBI8ke9Fz0Eg5KE9iQ6n1rMX2h2F6ivp6S6f1YkfvoSPUbSTj/qXcB3Va2nfrG/4ZjsTphWGY+UxXcsnXzR6qRww96madFqE9wYdPYym4ba4QZTP/UpGCPr1qZ6p0yewi8P6TZi4keGaU5bbygP/AGDkD6ZFUepao8M4L+THHuG2QITuz6Ed60vXSY7p4CuRc6BBIkrSIRxmtLmsab2aLNACTQ5pCEJoGNBm2Ipl2FBqSOM1ISI0EfSKn1i4pGcWOiEdICCUuykRdtKBRsFAFe4oMqjJ45osgd9x9B0qpSpzQNYhvXa2kzuQkbiAAcentVvPAMHA49q7fZtj4qby3CjgYPY4zj3+tUtzPNZ4aP5h0CnnJ7kmovRwy1zZ6zHJZzO1rM6nDb9ufpXOPFnw9jt4pTAFVGH/ADQuWLevv1pb2pz/AEbw8yahPbiNpGjf856Y78enX/StLpvhSw0qaW9SV4Q3bcQB7YrLO96aYzU2cufFEVrIURX8ocedjkVmNU1qWxu/OtzO9jI+H8sFmtJG6Oin80T4OVPHBHDAGjG/YyQJdDma/N7axtFOy5ZrcgxlW/mU4V42HQ4GejAEc2el+E7iLdcaVL+DYnMlmuSm7+ZAeo9jkr2JFVf8TFtZeHbrUWZLuBYVkO54lO6GQ/zZ/NG/uMg9xW/0Lw1ZaLErSoqAD8x4z/5qpN9pt05r8TNWS+1ho4IJJoYwFEqtx/bg/WsyZmNnM0QIkXGQQMN7EHrRle+hJ0+hPhTdQy+ErQREcD5lB/KfStkZfrWV9WTzKXzaQIZKEye9Iwl6EsaAakcj1qNI7ehoNDSUU+kwpbLSQkop0SilsaGJaLzRS2envNr3m0DTwcmvbmpDRcn1pCfQE/WmNFyzcdvShlcrE5yFUAkseMe5ol7Fjm+l61Eb64nWWQQJcEISQrXDjrk9cD24Ue5rq2j+IIrqCBHBadgM4Ugc9+e317V3Y2S6YZT7W15bebGSD17Vn7y0Zn27iq5xgjIoyhSqe80SGbMg2q44BHIr0dxd6fbi3uYEu7XOQR+b/So1pW9qy6nsogzjTnR+SOR1rIXqyaxEI2RYiMkoucD/AM1Fxnipkzb6CDKgIJJyDkZ/pVjpWlR20yxGNSgTy2jI/Kp6gn0OB9wD2qZjIq5bXlnpCW5WJiNoJa3dgMDPVfQg9x681Mt7BWffECCpyVPG0+3++KrSdri2iiiRpHwp/M3GM+4rPeKfGUFjGbeOMXkTryqnK49yD/atJ1NpvfTnc9na3sjT2dxJNBLl/JZtzLjqAR1x34zjnHeq7VzG9kI4lRj03R8Y/Wsvtbo3wTlkSzMZkTa3O09fsa6+q5FTVQoSi2cVICVodlIxBK9sFMEaMGmnhHpT0W2aQ1ISoUfQ9KfSkDyijC0gLbRBaNDYwtKFFPRbewK9jnpRobFjsP8A7qLqbItjPkM0aqSwXq3sP9+9XjOytcX8PyyX3ie9lljljgRliij4VR12xgdcdSe/UnrXRExEDc5bglY8kjcT1Y/XoPQVtertH+NLpHi+KRltrpQshIQdlA7nNX9zLAZEX87uMhF649a6Mfym2N6ugSxqy8Kox7Cqaa2BkYsTg84zx+lKw5VZcWSuGzuI7Ad6oZNMkjkd41Ce+M1FipUWax2EuxIbHIXqaj2+nt82QeWz15/Wo0rayt7WKSPyp8ccqSeVP+lPTmO3j8522Op2tnrnsfvTkLakvrm41QBLSZYHU8HP5/v2NYDxPpFwpkuGXc6czQFe/wDOvse47H6085uDG9qXS72AyGCQmNHYcg7Wjfs3qCP7ZFRvEFvHG8kYnNvetnzEfiKVvUH+Fvfof61lj/S7/bdfDfUZrG1tTNHtwdrA8H7g13CxuEubdZIyCpFLKHLtKFLUGQikxQZQK8RTIPSgegMvElSo0paG0hIzUhE9aWgdVfanVSjRC2V4LRoxhaLbT0T22lCfrQNlCdl796rtZDyQ/h4VyXBA7VeE7TXK9LtI7HxVc27ErEqssO0HOessp9zwoP0A6VoPxX451EFvMyJwqpkrxx34P3q8jj3iiC5S0PkpslYcKqjI/wB/WqTR/DWtTu017q8itKQ2zziScDgVrwy2s+TUjqujaNJDo7QLduLl48LN+Yo3Y4P9qo/xOs6Rasl/atd3xmIAi+YNEP4hXocfFjybl6unBy82XHqybm0c+LkmufJlsLi2TeQC6/wgZyan2dyl3AJJCUMgLhW7L6/SuXLCTyumZ2qgahYu8flupaRtgJPOcelV5vEEojypbBJXPJweoqLhpUz30bl1ETIFt5N2ehPBo033KjziX42Pxzt7H7VCym1iibbMArDjpx+tQdfltFtczyKGA25cblYHsfag45lrMEFpMxmAEcmWimVcnb6H1x0rN+IGk1C2gZ//AFDwsI8r1KH8pP0/L+lYyL23FpJ+GisIPLdlEYG48MPY10rwPrKREW9zJgn8ozxRf4nL26FGwZQV5FOAVmp4ikpAQpDTAGHpQMpoDORipcQoJJjFPqKQOotOBaAMLXttAEFpQtAeK17pQCO2xTxz3qpnnx5swYLj5FLHv6iteP1OXjlHxCknsrmGSwCyyXOEDEkhY1OScdOW+vStN4Zma4ggeI4LAYbJbn2Hanl6c8ai7jijhWMxO8r/AEyx/wAVI0rSJEcPMFU54jTov1Pc1vxf4y5Gss4QqcHjuRXr1gYymMLjFdG2GmWGmW0uqbpIkZAOA3TNZvxDD5WqCEytbRSfI0oGQoPfHoKi/wBmxcugafDaX+uarqU0dzauzvaICVhiB2+aWHG056+4qlSWGe5W/sbmWWzmQIhkJBLls7lB5xtHXvmp5Ofi+Pxxl25+Hg5/3bnnZ8e/+f8AGmsY/lHAz1q7spAhHT6GsHemy7JV2SH5SOD7Vn9X05odwCLLC6kYbo3sR/mnfBHN/EFq6WstvLGk0PM1u27oQORkeq9x3UVjNCAudehOXMMh2MowSoPf35AORWa/t0bxHPPFLb+U7SCAAcjDD/NWGkXqtNDO4AkzkkinZ0Pt2vQbgXVhE4z07VagVispHFARzSELQMeaDEmDRlBimmsqjDAqRFItASUcU8rrRQdWQYoxIKALzRXvNpHp7zaUS0HovmV4PgZ/SgtI1zNtjPIz2zVBql5Db2DtKxEag8kcZ9q24k5OefEzF14YgkREkngG1dybm9zjoPqahfD2/ubdYBqLmBlwCsjHzQO3BOBn/eaLLbRL063b6jCtym4hpJR8u0ZP0Hp9a0unMWXfL1PRR2+9b8VZckWIlUYA4pu5YlenHrWzJUXQ2ISp2sOhHUGsV4qu3lXJ28A9R+al/icrqbYBLaeyn1Lz7bUP38UsEflZHlloyMkEgMCSDt9VBqh8N6JfadDaDUY50kdSwkmBJlYcH5j1x0q+X9POOb+/t536f9b+9yXC3r6/+uh2IxECeo/rU7apUMhwRXI9iAe62KVONw5HuKz3ibWmtLGV4JgxjXcU6sB7Dvig3GdZ8V3r3KyRyRbgdwGwbW78j/Sr7wRp1rLqIuoojHEcSxKCSFDdR9Acj7VGXi8fVtrEv4m6nkRy+GKny+do9aPR5ZmKqrZXvT/6SnrtPgC/ElkIWcFlrZjJFYVoUivbakybabZTTBBkUpc0yY6JzjBp5A2ciinEpGIFPxkmkDyk04uaRjGT60YBpAQU0QU+lOAQU14oTTJXagDvROoJ5qg1tt0ixvGGUEEBea34p4jIyLJLj8Tay53yJmMYzg4657muB65BceFddkeTzbm+ZyFLOTtJPXHrT5JrOwsO8W58I+MYvxkVs7tc3SgNJI7ZVOeVGODgdT07V2jRdatrlHCXMcjpwdp4H1q+LrpGffa8gcyvkggg9KmXD/uznrW7JndT3lHxnGOPfNU+lTWDeJ9OTUWijt0P5pWCqXx8o59+nvSl1ds+STLHVUfxY8SWWna2IzbTTSRbhGI4w2CT65qDdaxHfeFLUXUiPJI6vbIWzJER+fI7Aitvlu2b8n/p5swmExuu7l1/3etHCgbhxUp8KfkbqMj3rie1GM8Uak1lHJJHyV/NETj7iuS654pmvyVLMCjZQkYK+1FOKO1t5b66VQCZGOcetdW0WzfR/D4cOEfkhWPHPUH0rLK7ummM62rmCptldFRn+YMjc/Y1IWYW91l2Yg4Oc4yPcVp9J+3RPAd+I7+PacIx7ntXZoWDRqQc8Vhk0g8UhqTITQMaZGmNNswoDMxQ89KlxQ+1XotpKwDHan44KWhs8sFOrCKPiNjEIovKApfEbGqijCjtSMpUU23HSkFRJJKdQJSPcqryazF/5t1qwAjdFLZOBjNdPFO4jP7HeSNaXkUzyYCNyqjLH/xWU+KHhlde01r/AE+MeeeQQecehNLn/lscXmnFYLW/sUntdOEqzu3lGQArzjJx7KP6nPatd4D8Rx+H5IY1VYoB+UMMyzBfzTMP4Vz0z6U8PRlNPpXw9eLfaZayxk4cDaSeT7mrO6lCKFYnnk4rqrnVF1n5iercAegrJa/pEV9DcW9xCJbeZTG6MMhlIxWdKs5qMDyW8Nt+Ft8WsaxKwyDtUADP2FRLDTCkhkkAZyMcDAA9qMrj9T1z8f6e/OZZXevFyu2OIknBUVWajq0cSNk7cc/+azdrkfxC1h55VETnDDBGOh+v+KyGn6bLeyh4ASWPPqpqMqrGbdJ8K+HSrJLNEAyfmCrkH3HpVr4okdjHb2rqrdNr9G+hNZTu7a3pAuJVCQxPB5bD5WHT7imdZVImt59wwV6mtYzaDwlKjyoZWxzxt7V3rRnzZR4JIx3rLJpFhk17JqAShamDTU01BM7FL71LjkqyiUj8U+klLZ6PLJTgejY0NXo91GxoqtRhqnZvbqCQ/KaIGeurnyp3bLAD0GBWa0y8e718uzuFQkqrEDNdPF7GeXiw1gJ+Ak8xA8ruCVprQr4TQSWsm0oRgEEZwOvHajmnYwvSZP4U02eDyWt4gkn5scYHXGf71mvEHwv0m78qOytUtYhxI6E7pfQH2/pWEmmvy363XhvSDo1thpnldFC+gX2A9asXmyw3/nJ4HpXZjdztzZegnj8xsj8vWos4hxg4xtJz96pHrJ6pEBd7lHytxUZdkTDd05zWVXETUg7Rt5YGSMqe2fQ1hNWM8kskRXDbSdrdHXv9xWeWWmmOO2X/AOEnuYXlklIRc5RjnHpg96stI0yO2SJ41KMFwzj1HcVhlltrMZGmWd7ezYswWQrnIHykf4NYi7uC0oAJdFJPBz9/eqw7icvdLd/Ln06HcdrkhsEYzVbq86y2ZQdE/Ka1iKk+F52fy1KMzKc/K3WvozwdL5ulRE7hgdDWeS40OQO4pCwqDAXFNtIKBo0ZBTbyimGVic1Micg0bGkqNzUhGpA8jGnVJpUxqxo1NIzgNGDQBZoJG+U8U4TI6nAbmeVDIVUc4FZOdjaan5qknYSQOnNdPHdWM8vK17Ss9jG7YG9ecDHWsdb3DafPJMAHKEBR+XGen6Vpy/yRh439jeO9s3mgMQQM9KtWXFuXJyQc/pXM1DHOynbx8pz9yM5oYV8x5pGJypxj1rp470xyPXEpAWNRgdz3NU942VcDjblfrV5IiluvmjjJH+8VAuG/9O8mOmGxWSlReztb/KvKs2zBrM3srS7WfnDFR7VlyeNcPUaynfDpn5WAP3FRZbljer8oCtgYrnnjb7RPEd09vGsCdAQAwOCKyI32+opb7w2Vzvxg9f61tj1GWXdX37QmlQFNsfykHA64qDNMZLNyw5AOPariae8GO7yE7sFW4r6O8Es6WKoWLcZyazzaYxqdxNASahegkmhbpRCMucCo8jn0ph//2Q==
                    title: This is sample subject
              Send basic textual message with image and smil:
                summary: Send basic textual message with image and smil
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoMMS
                    messageSegments:
                    - contentId: smil
                      contentType: application/smil
                      smil: <smil><head><layout><root-layout/><region id="Text" top="70%" left="0%" height="30%" width="100%" fit="scroll"/><region id="Image" top="0%" left="0%" height="70%" width="100%" fit="meet"/></layout></head><body><par dur="10s"><img src="image_1" region="Image"/></par><par dur="10s"><text src="body.txt" region="Text"/></par></body></smil>
                    - contentId: body.txt
                      text: This is a sample message
                    - contentId: image_1
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
                    title: This is sample subject
              Send fully-featured message:
                summary: Send fully-featured message
                value:
                  messages:
                  - destinations:
                    - to: '41793026727'
                    from: InfoMMS
                    messageSegments:
                    - text: This is a sample message (part 1)
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
                    - text: This is a sample message (part 2)
                    - uploadedContentId: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
                    title: This is sample subject
              Send fully-featured messages (multiple):
                summary: Send fully-featured messages (multiple)
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - callbackData: DLR callback data
                    destinations:
                    - messageId: MESSAGE-ID-123-xyz
                      to: '41793026727'
                    - to: '41793026834'
                    from: InfoSMS
                    intermediateReport: true
                    notifyUrl: https://www.example.com/sms/advanced
                    messageSegments:
                    - text: This is a sample message (part 1)
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
                    - text: This is a sample message (part 2)
                    - uploadedContentId: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
                    validityPeriod: 720
                  - deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
                    destinations:
                    - to: '41793026700'
                    from: '41793026700'
                    messageSegments:
                    - text: This is a sample message
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
              Send fully-featured message with group destination:
                summary: Send fully-featured message with group destination
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - destinations:
                    - group:
                      - to: '41793026728'
                      - to: '41793026729'
                    from: InfoMMS
                    messageSegments:
                    - text: This is a sample message (part 1)
                    - contentId: 320px-Depth_of_field_Cat.jpg
                      contentType: image/jpeg
                      contentUrl: https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg
                    - text: This is a sample message (part 2)
                    - uploadedContentId: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
                    title: This is sample subject
          application/xml:
            schema:
              $ref: '#/components/schemas/ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.MmsAdvancedRequest'
            examples:
              Send basic textual messages with image link:
                summary: Send basic textual messages with image link
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send basic textual messages with uploaded image:
                summary: Send basic textual messages with uploaded image
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message</text>\n        </messageSegments>\n        <messageSegments>\n          <uploadedContentId>B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F</uploadedContentId>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send basic textual messages with base64 content:
                summary: Send basic textual messages with base64 content
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentBase64>/9j/4AAQSkZJRgABAQEASABIAAD/2wBDAAYEBQYFBAYGBQYHBwYIChAKCgkJChQODwwQFxQYGBcUFhYaHSUfGhsjHBYWICwgIyYnKSopGR8tMC0oMCUoKSj/2wBDAQcHBwoIChMKChMoGhYaKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCgoKCj/wAARCADVAUADASEAAhEBAxEB/8QAHAAAAQUBAQEAAAAAAAAAAAAAAgEDBAUGBwAI/8QAPhAAAgEDAwIEBAMHAgUEAwAAAQIDAAQRBRIhMUEGE1FhByJxgRQykRUjQlKhscHR8BYzYnLhJDRD8SWCg//EABkBAAMBAQEAAAAAAAAAAAAAAAABAgMEBf/EACgRAQEAAgMAAgEFAAEFAAAAAAABAhEDITESQSIEEzJRYXFCkaHB4f/aAAwDAQACEQMRAD8A3ca+lSo1r1NOJIQU8opaM8oFOKKWgcXFODFIQokQHqKdRgehpWGcBos1JiDA0uaRiBFFQCiloD1KKBotJmgnqSkNBlljhieWZ1jijBZ3Y4CgdzWP034g6Ve37wnfBGX2QvIRiTnGfb71GfJMLJV48dy8bEMCMg5HrXs1aNPZr2aY09mot4fkNBK+1P70VoE/5QpROSDP+amGGaxq4adajE4k4pU4mQudtPrLWsoY6OpMddbM+pp1TSBma+jh4JGajnWIs43D9aBvQk1mL+YVD1PxLDBGfnAxSNirv4j2sN35TTAHPrWy8OeJIr9FZHBB96zmW+lWabCGUSICKdQ5YD3oofNXif4ieJdF+IGvwafqDx2sF7JGlvIiugUH0PrXTfh/8U7bXWW11dYra7bhZEyEY+4P5T/SuXDl166c+PfnrpysCAQcgjIIoga6HOIGlzQC5rwNBlzXqCJXs0g4z8TfE0mq6n+y7J91jCSJFBIV2Hdz/YVhNWFza8C1ljhwAWK5LccnHavPyyuVuTuwxmOMjsXwi8T/ALc0aS0uJS91Zgct+ZozwCfUg8fpW8zXbxZbxjk5MdZV7cPWvbh61ozIXGOtQr2QCM0DSvtZR5w55rRxuDEKUTlESb81NmsvtU8NvwKrZZQJcUqrFZW/zJSsCKuFfWVj+tPoRXazOqRUfUrxbWAknBxSNzPX/EMrXDJC3P1rN3Gt30RJ359qXZb7Rx4ovEPO6oeo6xd3kZCuQPrS3tTG31kXmLEkseproHwv1KW2uRbyOSq9MmsscNZbXbuPoTR7tXhXntVrHMN64POadTHzV8etCfS/iPeXSLtt9TUXUZ6AtjDj7Ef1rD2V09vKrFsMDnI4Fed507p/bsvw/wDiRc2iR2uqEzWg4D9WTt9xXZtN1W2v7ZZ7aVXQ9xXRw8m/xrLl49flEvzxS+ePWttsNENwPWvfiB60HopuV9aQ3I9aCAboetZj4geJf2NocpgYfiZQFQZ9Tj+5rPly1jWnHjvKOLRRTftCUTrBPKxG5Zwy7D32gDOftU+/tHltd6aflwv/ALhZmYg/QjJP2xXHp12w78FryWw8bXFrIxIuLZ1ORjOMMP7Gu5G9HrXT+nv4ufnn5Aa/A6mgOoD1rfbHQG1EfzVXajqQEZw1K0aVen6gZbpVQ/Wt5aMTApox8RmCZwXxQ5rK+nDcudpqgu2Zbnj1pZLx9aCwGYgafdeK1niL650uor604NRUd66vknT0mrRxrlm/rWL8VeJl2uFko2NMCb1JJGd3+Y0ccgkPDBh708bLdIspu9SMR8Ha1U5lKNjPFHLrGrx7mjc0in0zVj4dufw2oI44zWUyXp2/w3qpaBOe1aEX5/mqcqJFZ8TdB/4x8EPLEm7ULEGeBgdxbaPnQfUDp6ivl99qkHs3UdDXn8k1nXZhd4xN0u6CyFGlZOMgk9623hzxtJockbLPuAOHQD849/elLq7ivZqtzbfFq1lmjRrV1VjywbPFa2y8W6deQJJFdx4YYwzYINdOPL8nPlx68Sn161QIzXEe1u+6n49VjkUMjBgehBq/kn4jbUQM80DaiApOaPlB8UC68RW9vJFG8qmaRwiRryzE9Biua+LdXj1TX7syv5lvZjyo9uSxlBySACOPfIFYcuW9Rrx467V2jy3EaLNaRiWZ32r0YIOuDnAz9z9Kt/EGtNoemje0LTEYZ0i+RG/uefSs5bI01uqbwFq0l14705riNPMZZCpUggfuzyD3FdaOocfmquLk1O08uG6Yk1D/AKqYOoH+aqvKn9sDXzH+KolxO0oIB60fPY+Gk/wtZt+J3P0zXULGMCEZ9K6OLxzck7DPbhnyBQ+RSs7EC8ORVXdWQMmcVNhxZWMeIwKkMlaTxN9cGW6GOoozeAKTkVtjfkLNM9rGouwZUb+tYzUPOkkJck+lVcdJ32rZNw6ggUVrdPE+cEist6u2mtxMuLnzIwc81WMxJyTT5M9ljNBZsGpNixMykdAayl7U6l4dvCI0GeBWoF3wPmo5svirjx2ufD2pTo8qwYfbhyh7gdcH1rk3xq8F/grh/EOhQ7tIn+a5hjX/ANq56nHZSefbNced+V26MeunIfxGPyd+h9akwkyOhkk+XOOvftilILVjZ3SxgMg2rg5I+bGOhNLeatJPbSxpKyDIKr04wKqJ2WbXp2tI40YgY6EnOf8ASpWl+KtUtii291LkdBu4rTG2Jqxbxfq/lsst5LhjkgNTzePdYMQgguGJUjnGTRsLPwtfPbW+oa9fOry2+6K13tndMRhn/wD1BwPdvaqvQbm6NhI0u+R2djEiRknIPJ9z/SsN91o1FnfXUkKCO0la8XAwVA2EjkkjAJrH+Io7n8aGvGImBJ3F+nt1xRl4ePq5+GLq/iuO6kcRJbQSs7AcEFCBkduSK6ebe5HytkEcHis5LZ00ysl7eFnO3V2pfwEuDnOKuYVFzQ7mGSIEgnFOaU4kkAatMcNIue270SFVVWFaqC42piujG6jDKbp9Z1Y9qPcPaq3tOjbsMdRUK4kXPalTiRaMCKkNirx8RXyhqmsG1JVxgiq8eI94wTgfWnw56na+Sd9HYtQjlyWbJpm5MUn5SK65lLHPqo2xScYBHvXvIiCnKrSuMvp7qDdqgyFAqC8RNcuc76awHk88mp1moXGKnH066P4V0+SWJC3U1uLfQS8YJ5qeXD5Kwz+K10fR5LO6WWFmVuh9CD2NLqbXVlJ5c3Nu67X3AsP/AK+tc+XHqaa457rhHxA8LWEwurnR7eO0voHaSW1ib5JUyclfRuhwOOa5/BZ/iIzLHOgK4ARgR9ftUS/2qwdzY3ViDveLy1bqG6qO+P8AFR/lyomb5QdzA9W4q5/aalWdnJqTgQq7BQSERcnApx8WTMm0GQYJbsB6VUIrpLNdW8YiaNrgAxBs/MD3HqKkD8TBpk9pErLOkrRuwGPMPoT9Pepypw4dVC+H9LtEYKkSHepHO/eSf8daas7uQLKoYknI4kOFJPOPX+1ZxW1to800837Omuruz8wY82HDN9/Wmda064tJjCt3d3EZPAuExz68Eg/0oqptJvm/Z2k2P7NmkjXU4/LuJO/EgBXPbJ/pX02lvFPuYD5s4Ip8c9Lmt6Ox2K96WSzQDpWrDao1HTgQcAVmXgNnc7sYFVC202kaooAAYVfR3+QMN/WlvTTWz6X3PWnv2gB/EKJkPibfUAf4qiS3e5lwaqZbK46XOlsSOe9WBNbTxjfXyR8TdJuIJ/MhUlc8gVzsSsrYOR7His8vxuly/KJkF4yjk1MjvCehOfrTmdFxSYruTPY1MW43LyK1x5L9ouIVQOSSKCVCRhFyfYUWzWxA2+lXly3yIQPU1qtC8ITPKjTZPPSspuqrrvhzRVtkQbK2drbJgDArVlU1bdO3FUHi6xkuLTzY7kRyJwvyL0785FZZzbTDLTj/AIxtzcBbmB0abBV93I/7uDnJwOvtXJLyILcPKsLRqXKuXA+U8lenIzXHfXV9BvY9kj29vmdpVVXwCQgOOckdPb2NWPjK1i0q0txFLbPPsVMIoJAPO4H3z35FXE0/p95t8Hv5FvawKqlJJFOGORgkjOT/AKn2rJXJWGPyNwYoNueecjOefc04lY61qVxcwWUqXLJcWxygPGCQMkEfQUlvczXVuJLssZEQoCvQDJ5wO/PPfv2pU0SMByZopF3oxZh0IHT75/zWgsrAvZMWBEi4DKqYx3OT681FVFUs8xUoIFhBJJYqASvbHfNVMaMq4ViFJzyfze4/1p6KVttOltp/A09kQw33sGx35MfzbnYH/tFd+8Fav+PsY5g2Vl7bgcH7Clje1ZTcasNijY7h1rZgjTIGBBGazur2YIPFOFYywme1uNuSATxWn02ZpEHzcmo5Zrtrx1ZqrY6mjEbHqTWUrQaw885qXBEuR61rhUZL7T8DFWJGeldcu45bO3F/FlnHMjkqD9q4Z4psQlw3lqOvaly9w+NmjFKv8JpxDKvVTXPttpOtvOcjbGx+1XVnYX05ASFvvVzNNjS6T4WuZ2BlVgPpxWz03wWgA3J/StN79RWjs/C0MRGY8/atBY6RFFj5QMVSVxFAqLwKkR/LjilstJIfjiqfXZrFLdzfqDH3qMta7VjLvpyy/m027nnext5SI3wx27t4x2z6VhNTtYJZ/M6Sh/LJXvknHJH6ehrjv8nZPESXQ8SosSeawLYZABg4Jw/PUc5+/tReJdKsb+133u618nczEnlG5Gwevbj296qVGlPcaPN4e8OyveSkl5VzCgAZASBlgeeR+lZwQLLrE5GGRSXjUnG/njrVbJfvo9xPYJFNb7rjay4VQOTnPPcj1qBaeTJBbiFTbosajb+c79xGPU5xU7MzLYyxT/v1ixt65BAHXGKlWt9cRKrAyPEhLEcFT3I/z/egLqw1LRr6/wB2q29wIdv7tDgLu9WOOfuePSmPHltp62cU2jqhVTsZywy5znC89O5PsBwOKJewqdGee3EMU8Dxxb9+5eQM8fTPNdr8BSRWQaKMkwuVZCW6H0pfavp1SMhkBGOlEvHWtmBJMYqvvI/MQ0Bjtbs+SwHSntAmAIVm5FGc3Dwuq2EAR0BFSFjU1zNzgjUUShQacyKxNtptvSrKCcECuvizYZ4uQ6hHcToQFz9ayt14TkvJSZEGD6U7upx1CJ8P0fqhP2qbb/D2JSP3a/cUpgq5L/TvAtumCYlz7Cr+18KwRrxEv6VcxkRta2+jxR4+UfTFWEdoiKMAU0ieIDpiliTmlsaSAoxQEc0j0SR9qHkgiuVeKrm512edXkMVtEdgKEHd68d/pWXJdRrxzdYJPEP4KA2EcLSNEeHZmZduepK8g/Xig/EyXdxLLDPCbiGQCQmINGi5BI5P5u/Fc97bH01WCW4FpC0U1wxCW7lf+YCcEvj2JAPHp6UKWCXfiuCB5fNTSl/ETHgGYjlVYDr2/UU9+UKvxVqP4/wbLfNGQ08bSkN0WQOMY9wDzn096wFiqS6hDtQKsxjAJzhdzA5Pt1/WqiWovY7yXxjp5tp/Kt2QyqN+Mopxz7nGffiqg6hEdenghiAi27A0eR83qB9zS9NHnsL+LVTZQIWmDHy1Xljn6jH1PtxU5LeV8NcsIXEki7lYYYjHYdqKEdskEvFKSFI8tTlR/wBx+vOKYaZrNJIYlBixsZTgtn1HNMmg8K2xuAxlmboCFz0+vqa2um3MtoiR7d0JPPltg+3I7e5pfZun+EtaW409I5mUPF8hVavzdx49PvW07jK9U21/FjqKhz6hEP4lp6JQ6vqEJU4IrMR6qsN2Avc1X0Xe260S98+NSM1oIzwDXJk6IdJ4oC3NSo9E3FPpMVPWtcLpnlNqUQQ7TmljhgU9BXf8XJtKQW49KMPAp7UrD2kR3EK+lGb2IDqKNDZv8dEP4lpf2hEB1FKwbMSajFjORQpqcY71OgI6sg70xJqyjPJpGp9d1vFjIiq5D/LlDyM9/aufeJLsW0CFWkO0hVP8TH0ZehP/AFVzc1+nRwzrbGKn4aaOZoRLLLzITJnccnjHf9ak3NiZHig8qOGOYlss+1nb+RsDBHHAPXpWTRN8I6RH/wAT6tPLETE9sYgyrt2NgY4P05HHTrmqjwPLJF46u7O5fc11aTxMCcZZeevYj+vFV9F9quyuLWbwRqujSSSNNBPLHaBgGyS3G70+vtWKtwDcxRtHMHVQsiIcEEdf6U4VaVLuSTxpb3Id54RAQhdhyvf6Y9KY8DxI2uXdxMmTAWZSThQxJAo8CyuraTUdXuZpo42Q/wDJUysAcDGcd/c/3qe+mLMGeKSDhOcYVEOB2xkn0zxx3oJRXywwy4hLLJGMRxo3OP4iT3J7kmokcck9uhZwdq7QhHzJ7foM0Q0nSZlWdGUhwnRM9cepPatjY3zCZTKkRIGWbd8gz39/alfTjV+Gbr/8isdqS5mHJI649B/rWya3uD/MauZ6iMsewNaXB9ajy6fcMMc0ryCYIcujTyZBBxUdfDT+YGINReS3xcxjU6LYm3UA1o14UVMuzpGami3NBnompwtVxNZETTkclqNTNn+I123lcswPKJ27GnVgmPY1F5T+B6O1m9DTn4SY+tL90/gT8FL6V78HLUXlOYPfgJDRLpz1P7p/A4umOetGdKPej50/izfiyA21oTHuZl+boD0rl99IL+aD8RJJyx2RbCByMe9ZZ91rhNRBnVoL8lUJCKAAADtHdh9OOO9bC2NgdJOoandNtC/MXIRQfUDjJ+9H+nVZpXiDRv2i9zDexI7j5TO+wyEHgZPH9s+lUyWkll45/bMETvZ3KOAVfPlORgr6EH1FTacm0HVdCIv7q9tY1t3kYF0cZEhCkkgdskgH61jtPilk1V7gOwZpCXYAYbnnjPA7VcvSb6n21sYNSnWPcGdjlXHK4OeD6E0Ec8Wh3DzAPc3txIZI4lI5wep9B1pb7OdTZjVbjV4ij3UwhWZjuRMZC4Bx05qfqU2pWt5aQC4iuRLtVd0YznHGDV66RMu1JONQjd2W2RjkqT8uR9OKbg1ea2cxXEHloeoUYP6+lE1ReksIJ3E9iXjOegGe3pVhYXFzG5jcJsDZyACeP8VN7OOm+GJ7O0jgmldjtlUjbwMnrmuzWiRTqGReD3NH0d9S/wAIn8ooGtE/lFSYBZrn8oovwa46UhsgttvQCvMhFI9m2BpoilaZ2MU7g1pKmootohRLDEO1XajR6OOP0qQiRjtUbGjmEHYUhK+gpfISELL6UJYelTaeng3tRK3tRs9HkNExOOBz9KqJ0518TGe0gW7dF/DKPnwWVj/ivn7UfFTSSssMagq2Y2yfl56fSr1tUuoO0sdU1lHurm9e2tVcL8gJLt64/wA1Y6/4cW18I31zFLJc3CAMSRjCg85+3apt7khzzdaD4h6jYeIPhvox0OCOQxWsCSwRRgMGXKkEAc+ufc0Elvb6BaSTRp5YW2SS4ijO2OZwB/D0DZ7j75rXkyxs0ww+WNbTVbCCJBJFGDHeWXmAtj92GGf74rkc8CW8xY4/dtgsMDdkHJ6cDk4+1ZY3pvl6d0CJZ9ab+TyQwz6461lrueNfEd3M2WVJDGFPUJ7fenJu2FfFzePY6nZxi8lGEYOHUgdOv2NSNGWPUtTXUp2WLSrHhX6B36AL64pY3L7TqIOsaiLm4L2qb1Z9iZHv6ZpJLaW+vJITYhwABlmGQQOfm7AVXilFDcNBcGCVF+VioOeP/NWsF/aicfMxdiPMJ6Hn2p2f0UrcaHerc3Sx2KxyKeWZmLbcH9K+iPDEslzpdu8km9toyQABn7VN8OrsIMUhUUiJtWiCjFKADKtMyKKVOI7oKYYc1NXBpineKrEqjiM0QiNXkiHUj6U8qVBj2cUOykHtgpNgpAYjFGqAUwcVQKcGMVUTWG+K1ib3w84yoRGDMxJG0dz6VxeXwLbrE09uBMp6OG3bj9KeV0vCSzs9d2Jt7GGKKLyb+KPCvk+XIPsDhqpbXxLd2MMltqFitxbS5V4S4yR3w3f71M1s6obcPZ3Mh8OahHHExz+EuyUZSeynofrUrUbDxJeWMk+qRR2tgmNzB95YnpgDrVbxlly9TMbfHTdK1dNb0TTZgCVjtFgVVAGW3Y/xmsZ4ihA1BLePkxr8xIPzdgSf/FKLqnN4ti/nsoC8o46nFZLSkt9Q1Im9LJEzMzNux/Wqx3N1F71FkbTS7WR0t4DdOv8A8lxJ8gxzwo6/eiu7q4unj/FTkIuAoJAVB6KowBTm/aV/qAgtzNJHb2MoadyB5ig8Z9+1bFdPayhjtVz5mzBkY4XnqfWpyqsYxN/pEjXcuMfKepoodLjh2O+S+eAOn1qvl9J01fh0La6g8ayMiBASFxn6da+iPh5MX0GDhsZON9I2vycUhzUjQeaLnFIBbNAVJpHDbRmmWiOamqleEZFKVNViVpAeKJauohxadWoMRHFNE0AhY0IJpAYaiDU4Bq1EzHHBxVQmL+JMFxdeG7pIbgKQMlQDyPTIriEWt6zbZihhiuSpxt6kj2Of8UZas7Vj/i68NeI7HV7WbSdXVbC8kJMZkwNr54OTVN4l0hdPvJo5rRIryU7mVnKxso/iU9Dml4r1kb2NWl8oICQpygJ2hj709KbqDQJ7IzsbZgJNm47R/s9qqyXW0y2eL3wbPLpekm2stxmD5cFche/3xmpWqyebD8uFl/jYcZ96yt7azHpitZlkjDxP+8Yjj1ye1V1rbmC5VkAKthhleP0rbHxjlO02SFmlAgXLDoOmf9TXopMnMqLHtOAXQsM9yQM5J96oml0ucafb5tIFnlYfLNNGY1T3UDk/oKzd7LqUN2blrqSbc5ZlRTs3fSs8bN9rsq5uWS9SG4IxuQGTcCAD61TXmoQs48u2RVTgMSRn7ZqsYm1eeHJZobCdxDtaUgllPIHqMnrX0J8ILoXHh2NVUqykhizZJp0nQwgxSFBWYDtGaMKMUAJUUJUCkYGxTbBaVVAnaKAkGiUWIgajVquoOq1Oq1LRvM1CTmgiUmKRlAohTAxRdqZI91CksTKwOCMHbxXDvGfhRJby4udJMkF7bvnenJbvyf8AFFvSsVMLm31OFLbXLRYLpOBcmIYGPUEdatrC1muLSS2jktry3UdQgmTnsRncP1rK7x/4a9X/AJVOo+GVsZvMbZIGUHbbLtIYdyvt71TwWUV686NMsjghmiJycZ4JPvV7tidSVYxKttJqBWIgQQq21TnOTycVRXmox/hP3UMryMc7QhOR369KUx33aq2zqRnb5ne5gMsTRsx2hGXlj6ipjI8MQBVGYA/ISAOPU9q0Z6v2iTSoSAFYSkDMatuwPfHatZ4YSMxyzJbbHReCzH+pPT6e1LPwYeoWsW93Lh4XwxJzk9aq0tpxC8dw7Ar/ACpWeNjTKKuWNkYKGeUgbV2nP6jNTNH03fKZ9Qddqc7G4x9a3YaW9xcQvIgiVWX1QnAPtXZPhle/ho7dXjcKw7r0o10f27AkmVBGaCRzWR6NqzZp0E4oPTxJoCTUmBg1NsGpU4bZWoQh96cFRl6U4orXbPR1BzTqiptGhha9tqdm9trwWlsaKFpdtGxouKICjY0R0DjBUmsZrtmbbWcrH5KXCn5+vzAccD+9aTuFPXPfEHhV7mb8Qn7zk43x43n1x1oNEguvOWMxtbwxfl3bY1z7L1P6VGt9ba7163a6Na3+jXKea0kzrlpHfYV49cZH6Vy2/wBL/ZVwIrTUrSNFlDO+CA6EYVSWHIz3FO34iT5NfpGg2WuaPJ5V4sV/s2NPaP0x2weoz2Ncv8RRfszzbe9l8nUPLePaikfvBwGUejAgjHc1lMNyWOjHkmNsyvWv/Kz8N+E49I0b8Rq6O+oOm4s7Fyg/lHv9KyGqCKWeY+TfSRk7fLKbAc/xDvW2/wAunNr8e1no1mzDy4dJW5EaiNWluNhbPfj/AFrqNja6t+zt0QNugwDGk27cMf8AVx/aj8reqWpPYxvivWbrTWxfRQsjcATRYLfccGsdceIra4UpNprKp6tBOIiB7HGP1p4Tf8oWV14b0610y+uP3GpXEbD/AOO/gwB//RNw/VRVpfaVeeVvK27W+AqmKVdp+jHGT+tXe70ieD0mwuHnJfzY9mGCpGVHp3GDXRPDJaCeNCZSvfc3f7U/oR3DRd02nwuVAJXpU8xDuKyVt4RgUXlijRbCUFJsFGj2QoKBkFLQ2bKigIFBqhHFOq1MjqvTyt70jOBhSg0tEXIpaWgUUQp6Ba9QNvUxd2Ed4oDjoeCWP+KvD1NNP4eCINg7Y3Z6Cq+z8MQWs0krKXLnJbb1P16mtZhq7Hz6T0VLZiqwDHcgdPr/ALNZ/wAV+Frm/lF7biEycfu5l3Yx0+n+KnkwuU6PjzmN7BBoEsNjtimijmY5k8qEKPpzz96418S7q20u8gW4xe3scoeRFGWGTyd38PHQUY8XxPLk+R+217w9fWvnw6ndWcwBZ45gykkfTINQJ9LFww/CX1zcK7eYJEkVtp/lHtWPJhZdtePKWaW+i+F1mUSXk+oQkHcDgZGOxGefsc1fa1K2g6ergSS2wALMj7jg/wAQb0+tPGXW4WV70xWra+txYyOWguLByBI8ke9Fz0Eg5KE9iQ6n1rMX2h2F6ivp6S6f1YkfvoSPUbSTj/qXcB3Va2nfrG/4ZjsTphWGY+UxXcsnXzR6qRww96madFqE9wYdPYym4ba4QZTP/UpGCPr1qZ6p0yewi8P6TZi4keGaU5bbygP/AGDkD6ZFUepao8M4L+THHuG2QITuz6Ed60vXSY7p4CuRc6BBIkrSIRxmtLmsab2aLNACTQ5pCEJoGNBm2Ipl2FBqSOM1ISI0EfSKn1i4pGcWOiEdICCUuykRdtKBRsFAFe4oMqjJ45osgd9x9B0qpSpzQNYhvXa2kzuQkbiAAcentVvPAMHA49q7fZtj4qby3CjgYPY4zj3+tUtzPNZ4aP5h0CnnJ7kmovRwy1zZ6zHJZzO1rM6nDb9ufpXOPFnw9jt4pTAFVGH/ADQuWLevv1pb2pz/AEbw8yahPbiNpGjf856Y78enX/StLpvhSw0qaW9SV4Q3bcQB7YrLO96aYzU2cufFEVrIURX8ocedjkVmNU1qWxu/OtzO9jI+H8sFmtJG6Oin80T4OVPHBHDAGjG/YyQJdDma/N7axtFOy5ZrcgxlW/mU4V42HQ4GejAEc2el+E7iLdcaVL+DYnMlmuSm7+ZAeo9jkr2JFVf8TFtZeHbrUWZLuBYVkO54lO6GQ/zZ/NG/uMg9xW/0Lw1ZaLErSoqAD8x4z/5qpN9pt05r8TNWS+1ho4IJJoYwFEqtx/bg/WsyZmNnM0QIkXGQQMN7EHrRle+hJ0+hPhTdQy+ErQREcD5lB/KfStkZfrWV9WTzKXzaQIZKEye9Iwl6EsaAakcj1qNI7ehoNDSUU+kwpbLSQkop0SilsaGJaLzRS2envNr3m0DTwcmvbmpDRcn1pCfQE/WmNFyzcdvShlcrE5yFUAkseMe5ol7Fjm+l61Eb64nWWQQJcEISQrXDjrk9cD24Ue5rq2j+IIrqCBHBadgM4Ugc9+e317V3Y2S6YZT7W15bebGSD17Vn7y0Zn27iq5xgjIoyhSqe80SGbMg2q44BHIr0dxd6fbi3uYEu7XOQR+b/So1pW9qy6nsogzjTnR+SOR1rIXqyaxEI2RYiMkoucD/AM1Fxnipkzb6CDKgIJJyDkZ/pVjpWlR20yxGNSgTy2jI/Kp6gn0OB9wD2qZjIq5bXlnpCW5WJiNoJa3dgMDPVfQg9x681Mt7BWffECCpyVPG0+3++KrSdri2iiiRpHwp/M3GM+4rPeKfGUFjGbeOMXkTryqnK49yD/atJ1NpvfTnc9na3sjT2dxJNBLl/JZtzLjqAR1x34zjnHeq7VzG9kI4lRj03R8Y/Wsvtbo3wTlkSzMZkTa3O09fsa6+q5FTVQoSi2cVICVodlIxBK9sFMEaMGmnhHpT0W2aQ1ISoUfQ9KfSkDyijC0gLbRBaNDYwtKFFPRbewK9jnpRobFjsP8A7qLqbItjPkM0aqSwXq3sP9+9XjOytcX8PyyX3ie9lljljgRliij4VR12xgdcdSe/UnrXRExEDc5bglY8kjcT1Y/XoPQVtertH+NLpHi+KRltrpQshIQdlA7nNX9zLAZEX87uMhF649a6Mfym2N6ugSxqy8Kox7Cqaa2BkYsTg84zx+lKw5VZcWSuGzuI7Ad6oZNMkjkd41Ce+M1FipUWax2EuxIbHIXqaj2+nt82QeWz15/Wo0rayt7WKSPyp8ccqSeVP+lPTmO3j8522Op2tnrnsfvTkLakvrm41QBLSZYHU8HP5/v2NYDxPpFwpkuGXc6czQFe/wDOvse47H6085uDG9qXS72AyGCQmNHYcg7Wjfs3qCP7ZFRvEFvHG8kYnNvetnzEfiKVvUH+Fvfof61lj/S7/bdfDfUZrG1tTNHtwdrA8H7g13CxuEubdZIyCpFLKHLtKFLUGQikxQZQK8RTIPSgegMvElSo0paG0hIzUhE9aWgdVfanVSjRC2V4LRoxhaLbT0T22lCfrQNlCdl796rtZDyQ/h4VyXBA7VeE7TXK9LtI7HxVc27ErEqssO0HOessp9zwoP0A6VoPxX451EFvMyJwqpkrxx34P3q8jj3iiC5S0PkpslYcKqjI/wB/WqTR/DWtTu017q8itKQ2zziScDgVrwy2s+TUjqujaNJDo7QLduLl48LN+Yo3Y4P9qo/xOs6Rasl/atd3xmIAi+YNEP4hXocfFjybl6unBy82XHqybm0c+LkmufJlsLi2TeQC6/wgZyan2dyl3AJJCUMgLhW7L6/SuXLCTyumZ2qgahYu8flupaRtgJPOcelV5vEEojypbBJXPJweoqLhpUz30bl1ETIFt5N2ehPBo033KjziX42Pxzt7H7VCym1iibbMArDjpx+tQdfltFtczyKGA25cblYHsfag45lrMEFpMxmAEcmWimVcnb6H1x0rN+IGk1C2gZ//AFDwsI8r1KH8pP0/L+lYyL23FpJ+GisIPLdlEYG48MPY10rwPrKREW9zJgn8ozxRf4nL26FGwZQV5FOAVmp4ikpAQpDTAGHpQMpoDORipcQoJJjFPqKQOotOBaAMLXttAEFpQtAeK17pQCO2xTxz3qpnnx5swYLj5FLHv6iteP1OXjlHxCknsrmGSwCyyXOEDEkhY1OScdOW+vStN4Zma4ggeI4LAYbJbn2Hanl6c8ai7jijhWMxO8r/AEyx/wAVI0rSJEcPMFU54jTov1Pc1vxf4y5Gss4QqcHjuRXr1gYymMLjFdG2GmWGmW0uqbpIkZAOA3TNZvxDD5WqCEytbRSfI0oGQoPfHoKi/wBmxcugafDaX+uarqU0dzauzvaICVhiB2+aWHG056+4qlSWGe5W/sbmWWzmQIhkJBLls7lB5xtHXvmp5Ofi+Pxxl25+Hg5/3bnnZ8e/+f8AGmsY/lHAz1q7spAhHT6GsHemy7JV2SH5SOD7Vn9X05odwCLLC6kYbo3sR/mnfBHN/EFq6WstvLGk0PM1u27oQORkeq9x3UVjNCAudehOXMMh2MowSoPf35AORWa/t0bxHPPFLb+U7SCAAcjDD/NWGkXqtNDO4AkzkkinZ0Pt2vQbgXVhE4z07VagVispHFARzSELQMeaDEmDRlBimmsqjDAqRFItASUcU8rrRQdWQYoxIKALzRXvNpHp7zaUS0HovmV4PgZ/SgtI1zNtjPIz2zVBql5Db2DtKxEag8kcZ9q24k5OefEzF14YgkREkngG1dybm9zjoPqahfD2/ubdYBqLmBlwCsjHzQO3BOBn/eaLLbRL063b6jCtym4hpJR8u0ZP0Hp9a0unMWXfL1PRR2+9b8VZckWIlUYA4pu5YlenHrWzJUXQ2ISp2sOhHUGsV4qu3lXJ28A9R+al/icrqbYBLaeyn1Lz7bUP38UsEflZHlloyMkEgMCSDt9VBqh8N6JfadDaDUY50kdSwkmBJlYcH5j1x0q+X9POOb+/t536f9b+9yXC3r6/+uh2IxECeo/rU7apUMhwRXI9iAe62KVONw5HuKz3ibWmtLGV4JgxjXcU6sB7Dvig3GdZ8V3r3KyRyRbgdwGwbW78j/Sr7wRp1rLqIuoojHEcSxKCSFDdR9Acj7VGXi8fVtrEv4m6nkRy+GKny+do9aPR5ZmKqrZXvT/6SnrtPgC/ElkIWcFlrZjJFYVoUivbakybabZTTBBkUpc0yY6JzjBp5A2ciinEpGIFPxkmkDyk04uaRjGT60YBpAQU0QU+lOAQU14oTTJXagDvROoJ5qg1tt0ixvGGUEEBea34p4jIyLJLj8Tay53yJmMYzg4657muB65BceFddkeTzbm+ZyFLOTtJPXHrT5JrOwsO8W58I+MYvxkVs7tc3SgNJI7ZVOeVGODgdT07V2jRdatrlHCXMcjpwdp4H1q+LrpGffa8gcyvkggg9KmXD/uznrW7JndT3lHxnGOPfNU+lTWDeJ9OTUWijt0P5pWCqXx8o59+nvSl1ds+STLHVUfxY8SWWna2IzbTTSRbhGI4w2CT65qDdaxHfeFLUXUiPJI6vbIWzJER+fI7Aitvlu2b8n/p5swmExuu7l1/3etHCgbhxUp8KfkbqMj3rie1GM8Uak1lHJJHyV/NETj7iuS654pmvyVLMCjZQkYK+1FOKO1t5b66VQCZGOcetdW0WzfR/D4cOEfkhWPHPUH0rLK7ummM62rmCptldFRn+YMjc/Y1IWYW91l2Yg4Oc4yPcVp9J+3RPAd+I7+PacIx7ntXZoWDRqQc8Vhk0g8UhqTITQMaZGmNNswoDMxQ89KlxQ+1XotpKwDHan44KWhs8sFOrCKPiNjEIovKApfEbGqijCjtSMpUU23HSkFRJJKdQJSPcqryazF/5t1qwAjdFLZOBjNdPFO4jP7HeSNaXkUzyYCNyqjLH/xWU+KHhlde01r/AE+MeeeQQecehNLn/lscXmnFYLW/sUntdOEqzu3lGQArzjJx7KP6nPatd4D8Rx+H5IY1VYoB+UMMyzBfzTMP4Vz0z6U8PRlNPpXw9eLfaZayxk4cDaSeT7mrO6lCKFYnnk4rqrnVF1n5iercAegrJa/pEV9DcW9xCJbeZTG6MMhlIxWdKs5qMDyW8Nt+Ft8WsaxKwyDtUADP2FRLDTCkhkkAZyMcDAA9qMrj9T1z8f6e/OZZXevFyu2OIknBUVWajq0cSNk7cc/+azdrkfxC1h55VETnDDBGOh+v+KyGn6bLeyh4ASWPPqpqMqrGbdJ8K+HSrJLNEAyfmCrkH3HpVr4okdjHb2rqrdNr9G+hNZTu7a3pAuJVCQxPB5bD5WHT7imdZVImt59wwV6mtYzaDwlKjyoZWxzxt7V3rRnzZR4JIx3rLJpFhk17JqAShamDTU01BM7FL71LjkqyiUj8U+klLZ6PLJTgejY0NXo91GxoqtRhqnZvbqCQ/KaIGeurnyp3bLAD0GBWa0y8e718uzuFQkqrEDNdPF7GeXiw1gJ+Ak8xA8ruCVprQr4TQSWsm0oRgEEZwOvHajmnYwvSZP4U02eDyWt4gkn5scYHXGf71mvEHwv0m78qOytUtYhxI6E7pfQH2/pWEmmvy363XhvSDo1thpnldFC+gX2A9asXmyw3/nJ4HpXZjdztzZegnj8xsj8vWos4hxg4xtJz96pHrJ6pEBd7lHytxUZdkTDd05zWVXETUg7Rt5YGSMqe2fQ1hNWM8kskRXDbSdrdHXv9xWeWWmmOO2X/AOEnuYXlklIRc5RjnHpg96stI0yO2SJ41KMFwzj1HcVhlltrMZGmWd7ezYswWQrnIHykf4NYi7uC0oAJdFJPBz9/eqw7icvdLd/Ln06HcdrkhsEYzVbq86y2ZQdE/Ka1iKk+F52fy1KMzKc/K3WvozwdL5ulRE7hgdDWeS40OQO4pCwqDAXFNtIKBo0ZBTbyimGVic1Micg0bGkqNzUhGpA8jGnVJpUxqxo1NIzgNGDQBZoJG+U8U4TI6nAbmeVDIVUc4FZOdjaan5qknYSQOnNdPHdWM8vK17Ss9jG7YG9ecDHWsdb3DafPJMAHKEBR+XGen6Vpy/yRh439jeO9s3mgMQQM9KtWXFuXJyQc/pXM1DHOynbx8pz9yM5oYV8x5pGJypxj1rp470xyPXEpAWNRgdz3NU942VcDjblfrV5IiluvmjjJH+8VAuG/9O8mOmGxWSlReztb/KvKs2zBrM3srS7WfnDFR7VlyeNcPUaynfDpn5WAP3FRZbljer8oCtgYrnnjb7RPEd09vGsCdAQAwOCKyI32+opb7w2Vzvxg9f61tj1GWXdX37QmlQFNsfykHA64qDNMZLNyw5AOPariae8GO7yE7sFW4r6O8Es6WKoWLcZyazzaYxqdxNASahegkmhbpRCMucCo8jn0ph//2Q==</contentBase64>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send basic textual message with image and smil:
                summary: Send basic textual message with image and smil
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <contentId>smil</contentId>\n          <contentType>application/smil</contentType>\n          <smil>&lt;smil&gt;&lt;head&gt;&lt;layout&gt;&lt;root-layout/&gt;&lt;region id=\"Text\" top=\"70%\" left=\"0%\" height=\"30%\" width=\"100%\" fit=\"scroll\"/&gt;&lt;region id=\"Image\" top=\"0%\" left=\"0%\" height=\"70%\" width=\"100%\" fit=\"meet\"/&gt;&lt;/layout&gt;&lt;/head&gt;&lt;body&gt;&lt;par dur=\"10s\"&gt;&lt;img src=\"image_1\" region=\"Image\"/&gt;&lt;/par&gt;&lt;par dur=\"10s\"&gt;&lt;text src=\"body.txt\" region=\"Text\"/&gt;&lt;/par&gt;&lt;/body&gt;&lt;/smil&gt;</smil>\n        </messageSegments>\n        <messageSegments>\n          <contentId>body.txt</contentId>\n          <text>This is a sample message</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>image_1</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send fully-featured message:
                summary: Send fully-featured message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <to>41793026727</to>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 1)</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 2)</text>\n        </messageSegments>\n        <messageSegments>\n          <uploadedContentId>B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F</uploadedContentId>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send fully-featured messages (multiple):
                summary: Send fully-featured messages (multiple)
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <message>\n      <callbackData>DLR callback data</callbackData>\n      <destinations>\n        <destination>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n          <to>41793026727</to>\n        </destination>\n        <destination>\n          <to>41793026834</to>\n        </destination>\n      </destinations>\n      <from>InfoSMS</from>\n      <intermediateReport>true</intermediateReport>\n      <notifyUrl>https://www.example.com/sms/advanced</notifyUrl>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 1)</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 2)</text>\n        </messageSegments>\n        <messageSegments>\n          <uploadedContentId>B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F</uploadedContentId>\n        </messageSegments>\n      </messageSegments>\n      <validityPeriod>720</validityPeriod>\n    </message>\n    <message>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n          <days>SATURDAY</days>\n          <days>SUNDAY</days>\n        </days>\n        <from>\n          <hour>6</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>15</hour>\n          <minute>30</minute>\n        </to>\n      </deliveryTimeWindow>\n      <destinations>\n        <destination>\n          <to>41793026700</to>\n        </destination>\n      </destinations>\n      <from>41793026700</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n      </messageSegments>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
              Send fully-featured message with group destination:
                summary: Send fully-featured message with group destination
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsAdvancedRequest>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <message>\n      <destinations>\n        <destination>\n          <group>\n            <group>\n              <to>41793026728</to>\n            </group>\n            <group>\n              <to>41793026729</to>\n            </group>\n          </group>\n        </destination>\n      </destinations>\n      <from>InfoMMS</from>\n      <messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 1)</text>\n        </messageSegments>\n        <messageSegments>\n          <contentId>320px-Depth_of_field_Cat.jpg</contentId>\n          <contentType>image/jpeg</contentType>\n          <contentUrl>https://upload.wikimedia.org/wikipedia/commons/thumb/6/60/Depth_of_field_Cat.jpg/320px-Depth_of_field_Cat.jpg</contentUrl>\n        </messageSegments>\n        <messageSegments>\n          <text>This is a sample message (part 2)</text>\n        </messageSegments>\n        <messageSegments>\n          <uploadedContentId>B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F</uploadedContentId>\n        </messageSegments>\n      </messageSegments>\n      <title>This is sample subject</title>\n    </message>\n  </messages>\n</MmsAdvancedRequest>\n"
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.SendResult'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value:
                    bulkId: '2034072219640523073'
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      messageId: '2033247207850523791'
                    - to: '41793026834'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      messageId: '2033247207850523792'
                Response for request with multiple group destinations:
                  summary: Response for request with multiple group destinations
                  value:
                    bulkId: '2034072219640523073'
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      messageId: '2033247207850523791'
                    - to: '41793026834'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      messageId: '2033247207850523792'
            application/xml:
              schema:
                $ref: '#/components/schemas/ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.SendResult'
              examples:
                Response for request with one destination:
                  summary: Response for request with one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SendResult>\n  <bulkId>2034072219640523072</bulkId>\n  <messages>\n    <messages>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n    </messages>\n  </messages>\n</SendResult>\n"
                Response for request with multiple destinations:
                  summary: Response for request with multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SendResult>\n  <bulkId>2034072219640523073</bulkId>\n  <messages>\n    <messages>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>2033247207850523791</messageId>\n    </messages>\n    <messages>\n      <to>41793026834</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>2033247207850523792</messageId>\n    </messages>\n  </messages>\n</SendResult>\n"
                Response for request with multiple group destinations:
                  summary: Response for request with multiple group destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SendResult>\n  <bulkId>2034072219640523073</bulkId>\n  <messages>\n    <messages>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>2033247207850523791</messageId>\n    </messages>\n    <messages>\n      <to>41793026834</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>2033247207850523792</messageId>\n    </messages>\n  </messages>\n</SendResult>\n"
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8c0d480c425c41d88986e9a339e209ff8333292c731a8b410c00a517bc3a95fb.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/8c0d480c425c41d88986e9a339e209ff8333292c731a8b410c00a517bc3a95fb.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mms:message:send
      - mms:manage
      x-deprecationInformation:
        deprecation: 2024-04-26T10:00:00.00+0000
        successorOperationId: send-mms-messages
      x-additionalInfo:
        markdown: '### Related

          - [Buy numbers for sending and receiving messages](#platform-connectivity/numbers)

          '
  /mms/1/content:
    post:
      tags:
      - channels
      summary: Upload binary content
      description: This method allows you to upload binary content that you can reference when sending MMS messages.
      operationId: upload-binary
      parameters:
      - name: X-Content-Id
        in: header
        description: ContentId that uniquely identifies the binary content.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: image_1_jpg
      - name: X-Media-Type
        in: header
        description: Content mime type. Should be populated by standard MIME types (IANA media types).
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: image/jpeg
      - name: X-Validity-Period-Minutes
        in: header
        description: 'Validity period in minutes after which the content will be deleted. (default: 69120 minutes).'
        required: false
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          default: 69120
        example: 70000
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              cURL:
                summary: Upload jpeg image using curl
                description: cURL
                value: 'curl -L -X POST ''https://{baseUrl}/mms/1/content'' \

                  -H ''Authorization: {authorization}'' \

                  -H ''Content-Type: application/octet-stream'' \

                  -H ''Accept: application/json'' \

                  -H ''X-Media-Type: image/jpeg'' \

                  -H ''X-Content-Id: image_1_jpg'' \

                  --data-binary "@/path/to/image1.jpg"

                  '
              Java:
                summary: Upload jpeg image using Java
                description: Java
                value: "OkHttpClient client = new OkHttpClient().newBuilder().build();\nRequestBody body = RequestBody.create(new File(\"path/to/image1.jpg\"), MediaType.parse(\"image/jpeg\"));\nRequest request = new Request.Builder()\n        .url(\"https://{baseUrl}/mms/1/content\")\n        .method(\"POST\", body)\n        .addHeader(\"Authorization\", \"{authorization}\")\n        .addHeader(\"Content-Type\", \"application/octet-stream\")\n        .addHeader(\"Accept\", \"application/json\")\n        .addHeader(\"X-Content-Id\", \"image_1_jpg\")\n        .addHeader(\"X-Media-Type\", \"image/jpeg\")\n        .build();\nResponse response = client.newCall(request).execute();\n"
              HTTP:
                summary: Upload jpeg image using HTTP
                description: HTTP
                value: 'POST /mms/1/content HTTP/1.1

                  Host: {baseUrl}

                  Authorization: {authorization}

                  Content-Type: application/octet-stream

                  Accept: application/json

                  X-Content-Id: image_1_jpg

                  X-Media-Type: image/jpeg


                  (data)'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UploadBinaryResult'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
              examples:
                Response example:
                  summary: Response example
                  value:
                    bulkId: ''
                    messages: []
                    errorMessage: Required request header 'X-Content-Id' for method parameter type String is not present
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mms:manage
      x-additionalInfo:
        markdown: '### Related

          - [Buy numbers for sending and receiving messages](#platform-connectivity/numbers)

          '
  /mms/1/inbox/reports:
    get:
      tags:
      - channels
      summary: Get inbound MMS messages
      description: If for some reason you are unable to receive incoming MMS at 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 following API request will return only new messages that arrived since the last API request.
      operationId: get-inbound-mms-messages
      parameters:
      - name: limit
        in: query
        description: Maximum number of delivery reports that will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 2
      - name: applicationId
        in: query
        description: '[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: ApplicationExample
      - name: entityId
        in: query
        description: '[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: EntityExample
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoReportResponse'
              examples:
                Response for single MO:
                  summary: Response for single MO
                  value:
                    results:
                    - messageId: '817790313235066447'
                      to: '25256'
                      from: '41793026727'
                      message: '{"mms_parts":[{"origin":"text","contentType":"text/plain; charset=utf-8","contentId":"content0","value":"Sample text"}],"userAgent":"motogstylus5g","priority":null,"subject":null}'
                      receivedAt: 2016-10-06T09:28:39.220+0000
                      mmsCount: 1
                      callbackData: Some custom data
                      price:
                        pricePerMessage: 0
                        currency: Euro
                Response for MO sent to the group:
                  summary: Response for MO sent to the group
                  value:
                    results:
                    - messageId: '817790313235066447'
                      to: '25256'
                      from: '41793026727'
                      message: '{"mms_parts":[{"origin":"text","contentType":"text/plain; charset=utf-8","contentId":"content0","value":"Sample text"}],"userAgent":"motogstylus5g","priority":null,"subject":null}'
                      group:
                      - to: '25256'
                      - cc: '41793026888'
                      receivedAt: 2016-10-06T09:28:39.220+0000
                      mmsCount: 1
                      callbackData: Some custom data
                      price:
                        pricePerMessage: 0
                        currency: Euro
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - mms:inbound-message:read
      - mms:manage
      x-additionalInfo:
        markdown: '### Related

          - [Buy numbers for sending and receiving messages](#platform-connectivity/numbers)

          '
  /mms/2/reports:
    get:
      tags:
      - channels
      summary: Get MMS delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: get-outbound-mms-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '3746923784'
                      price:
                        pricePerMessage: 1
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      messageId: 43u2ih-6453jbh-897kfs90u2nj
                      sender: '441134960000'
                      sentAt: 2026-07-07T06:32:15.101+0000
                      doneAt: 2026-07-07T06:32:15.101+0000
                      messageCount: 3
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mms:message:send
      - mms:manage
  /mms/1/reports:
    get:
      tags:
      - channels
      summary: Get outbound MMS message delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      operationId: deprecated-get-outbound-mms-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: ID of bulk for which a delivery report is requested.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: ID of MMS for which a delivery report is requested.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: MESSAGE-ID-123-xyz
      - name: limit
        in: query
        description: Maximum number of delivery reports that will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 2
      - name: applicationId
        in: query
        description: '[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: ApplicationExample
      - name: entityId
        in: query
        description: '[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: EntityExample
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mms:message:send
      - mms:manage
      x-deprecationInformation:
        deprecation: 2024-04-26T10:00:00.00+0000
        sunset: 2026-06-01T00:00:00.00+0000
        successorOperationId: get-outbound-mms-message-delivery-reports
  /mms/2/logs:
    get:
      tags:
      - channels
      summary: Get MMS message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-mms-message-logs
      parameters:
      - name: mcc
        in: query
        description: Filter logs by mobile country code.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Filter logs by mobile country code.
      - name: mnc
        in: query
        description: Filter logs by mobile network code.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Filter logs by mobile network code.
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.LogResponseMmsUnificationLogMmsOutboundContent'
              examples:
                Logs:
                  summary: Logs
                  value:
                    results:
                    - title: Message title
                      mccMnc: '22801'
                      sender: '441134960000'
                      destination: '441134960001'
                      bulkId: '3746923784'
                      messageId: 43u2ih-6453jbh-897kfs90u2nj
                      sentAt: 2026-07-07T06:32:15.966+0000
                      doneAt: 2026-07-07T06:32:15.966+0000
                      messageCount: 3
                      price:
                        pricePerMessage: 1
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      content:
                        title: Some title
                        messageSegments:
                        - text: Some text
                          type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mms:manage
      - mms:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /mms/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound MMS message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours and you can only retrieve maximum of 1000 logs per call. See [message delivery reports](#channels/mms/get-outbound-mms-message-delivery-reports) if your use case is to verify message delivery.
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: deprecated-get-outbound-mms-message-logs
      parameters:
      - name: from
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 10950
      - name: to
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 41793026727
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 3746923784
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 43u2ih-6453jbh-897kfs90u2nj
      - name: generalStatus
        in: query
        description: Sent [message status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes).
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeneralStatus'
        example: ACCEPTED
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it together with sentUntil to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2023-04-16T12:00:00.390Z'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it together with sentBefore to return a time range or if you want to fetch more than 1000 logs allowed per call. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '2023-04-17T12:00:00.390Z'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h. If you have more than 1000 logs in that period, you can retrieve remaining logs by using sentBefore and sentUntil.
        required: false
        style: form
        explode: true
        schema:
          type: number
        example: 100
      - name: mcc
        in: query
        description: Mobile Country Code.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 22801
      - name: mnc
        in: query
        description: Mobile Network Code.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 22823
      - name: applicationId
        in: query
        description: The application used when sending 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: test-application
      - name: entityId
        in: query
        description: The entity used when sending 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: test-entity
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLogsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - bulkId: '3746923784'
                      messageId: 43u2ih-6453jbh-897kfs90u2nj
                      to: To name
                      from: Company name
                      title: Message title
                      messageSegments:
                      - contentId: contentId
                        text: some text
                      - contentId: contentId
                        contentType: image/png
                        contentUrl: host.com/image.png
                      - contentId: contentId
                        text: some other text
                      sentAt: 2023-01-01T17:42:05.390+0100
                      doneAt: 2023-01-01T17:42:10.390+0100
                      mmsCount: 3
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 1
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8c0d480c425c41d88986e9a339e209ff8333292c731a8b410c00a517bc3a95fb.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mms:logs:read
      - mms:manage
      x-deprecationInformation:
        deprecation: 2024-04-26T10:00:00.00+0000
        sunset: 2026-06-01T00:00:00.00+0000
        successorOperationId: get-outbound-mms-message-logs
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/configurations:
    get:
      tags:
      - channels
      summary: Get calls configurations
      description: Get calls configurations.
      operationId: get-calls-configurations
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallsConfigurationPage'
              examples:
                List of calls configurations:
                  summary: List of calls configurations
                  value:
                    results:
                    - id: 63467c6e2885a5389ba11d80
                      name: Calls configuration
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create calls configuration
      description: Create calls configuration.
      operationId: create-calls-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationCreateRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  id: 63467c6e2885a5389ba11d80
                  name: Calls configuration
        required: true
      responses:
        '201':
          description: Calls configuration created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 63467c6e2885a5389ba11d80
                    name: Calls configuration
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/configurations/{callsConfigurationId}:
    get:
      tags:
      - channels
      summary: Get calls configuration
      description: Get a single calls configuration.
      operationId: get-calls-configuration
      parameters:
      - name: callsConfigurationId
        in: path
        description: Calls configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 63467c6e2885a5389ba11d80
                    name: Calls configuration
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update calls configuration
      description: Update calls configuration.
      operationId: update-calls-configuration
      parameters:
      - name: callsConfigurationId
        in: path
        description: Calls configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationUpdateRequest'
            examples:
              Update request example:
                summary: Update request example
                value:
                  name: Calls configuration
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse'
              examples:
                Update response example:
                  summary: Update response example
                  value:
                    id: 63467c6e2885a5389ba11d80
                    name: Calls configuration
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete calls configuration
      description: Delete calls configuration.
      operationId: delete-calls-configuration
      parameters:
      - name: callsConfigurationId
        in: path
        description: Calls configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse'
              examples:
                Delete response example:
                  summary: Delete response example
                  value:
                    id: 63467c6e2885a5389ba11d80
                    name: Calls configuration
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls:
    get:
      tags:
      - channels
      summary: Get calls
      description: Get calls with pagination.
      operationId: get-calls
      parameters:
      - name: type
        in: query
        description: Call endpoint type.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
        example: PHONE
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: from
        in: query
        description: Caller identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790123456
      - name: to
        in: query
        description: Callee identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790987654
      - name: direction
        in: query
        description: Call direction.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        example: OUTBOUND
      - name: status
        in: query
        description: Call state.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState'
        example: FINISHED
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the call has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: conferenceId
        in: query
        description: Conference ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: dialogId
        in: query
        description: Dialog ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 6c73cbdc-c956-4bf5-a026-318236559167
      - name: bulkId
        in: query
        description: Bulk ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: bde6deaa-23af-4340-aac7-f3fa063c4215
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create call
      description: Create an outbound call to a given endpoint.
      operationId: create-call
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.CallRequest'
            examples:
              Basic call request:
                summary: Basic call request
                value:
                  endpoint:
                    type: PHONE
                    phoneNumber: '41792036727'
                  from: '41793026834'
                  connectTimeout: 30
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
              Call request to WEBRTC endpoint:
                summary: Call request to WEBRTC endpoint
                value:
                  endpoint:
                    type: WEBRTC
                    identity: Bob
                    displayName: Bob
                  from: '41793026834'
                  connectTimeout: 30
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
              Call request to SIP endpoint:
                summary: Call request to SIP endpoint
                value:
                  endpoint:
                    type: SIP
                    username: username
                  from: '41793026834'
                  connectTimeout: 30
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
              Call request to WEBSOCKET endpoint:
                summary: Call request to WEBSOCKET endpoint
                value:
                  endpoint:
                    type: WEBSOCKET
                    websocketEndpointConfigId: websocket-config-id
                    identifier: identifier
                  from: '41793026834'
                  connectTimeout: 30
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
              Call request to VIBER endpoint:
                summary: Call request to VIBER endpoint
                value:
                  endpoint:
                    type: VIBER
                    phoneNumber: '41792036727'
                  from: '41793026834'
                  connectTimeout: 30
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
              Advanced Call request:
                summary: Advanced Call request
                value:
                  endpoint:
                    type: VIBER
                    phoneNumber: '41792036727'
                  from: '41793026834'
                  connectTimeout: 30
                  recording:
                    recordingType: AUDIO
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
              Call request with machine detection:
                summary: Call request with machine detection
                value:
                  endpoint:
                    type: VIBER
                    phoneNumber: '41792036727'
                  from: '41793026834'
                  connectTimeout: 30
                  recording:
                    recordingType: AUDIO
                  machineDetection:
                    enabled: true
                  maxDuration: 300
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
        required: true
      responses:
        '201':
          description: Call created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
              examples:
                PHONE call response:
                  summary: PHONE call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                WEBRTC call response:
                  summary: WEBRTC call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WEBRTC
                      identity: Bob
                      displayName: Bob
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                SIP call response:
                  summary: SIP call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: SIP
                      username: username
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                VIBER call response:
                  summary: VIBER call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: VIBER
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                WHATSAPP call response:
                  summary: WHATSAPP call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WHATSAPP
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 6
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}:
    get:
      tags:
      - channels
      summary: Get call
      description: Get a single call.
      operationId: get-call
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
              examples:
                PHONE call response:
                  summary: PHONE call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                WEBRTC call response:
                  summary: WEBRTC call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WEBRTC
                      identity: Bob
                      displayName: Bob
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                SIP call response:
                  summary: SIP call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: SIP
                      username: username
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                VIBER call response:
                  summary: VIBER call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: VIBER
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
                WHATSAPP call response:
                  summary: WHATSAPP call response
                  value:
                    id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WHATSAPP
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: ESTABLISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    customData:
                      key1: value1
                      key2: value2
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/history:
    get:
      tags:
      - channels
      summary: Get calls history
      description: Get calls history with pagination. Calls history retention period is 5 days.
      operationId: get-calls-history
      parameters:
      - name: type
        in: query
        description: Call endpoint type.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
        example: PHONE
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: from
        in: query
        description: Caller identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790123456
      - name: to
        in: query
        description: Callee identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790987654
      - name: direction
        in: query
        description: Call direction.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        example: OUTBOUND
      - name: status
        in: query
        description: Call state.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState'
        example: FINISHED
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the call has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: conferenceId
        in: query
        description: Conference ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: dialogId
        in: query
        description: Dialog ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 6c73cbdc-c956-4bf5-a026-318236559167
      - name: bulkId
        in: query
        description: Bulk ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: bde6deaa-23af-4340-aac7-f3fa063c4215
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/history:
    get:
      tags:
      - channels
      summary: Get call history
      description: Get a single call history. Call history retention period is 5 days.
      operationId: get-call-history
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog'
              examples:
                PHONE call response:
                  summary: PHONE call response
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: FINISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    ringDuration: 5
                    callsConfigurationIds:
                    - dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    conferenceIds:
                    - e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    duration: 25
                    customData:
                      key1: value1
                      key2: value2
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                WEBRTC call response:
                  summary: WEBRTC call response
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WEBRTC
                      identity: Bob
                      displayName: Bob
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: FINISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    ringDuration: 5
                    callsConfigurationIds:
                    - dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    conferenceIds:
                    - e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    duration: 25
                    customData:
                      key1: value1
                      key2: value2
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                SIP call response:
                  summary: SIP call response
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: SIP
                      username: username
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: FINISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    ringDuration: 5
                    callsConfigurationIds:
                    - dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    conferenceIds:
                    - e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    duration: 25
                    customData:
                      key1: value1
                      key2: value2
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                VIBER call response:
                  summary: VIBER call response
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: VIBER
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: FINISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    ringDuration: 5
                    callsConfigurationIds:
                    - dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    conferenceIds:
                    - e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    duration: 25
                    customData:
                      key1: value1
                      key2: value2
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                WHATSAPP call response:
                  summary: WHATSAPP call response
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: WHATSAPP
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    to: '41792036727'
                    direction: OUTBOUND
                    state: FINISHED
                    startTime: 2026-01-15T11:59:30.000+0000
                    answerTime: 2026-01-15T11:59:35.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    ringDuration: 5
                    callsConfigurationIds:
                    - dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    conferenceIds:
                    - e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    duration: 25
                    customData:
                      key1: value1
                      key2: value2
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/connect:
    post:
      tags:
      - channels
      summary: Connect calls
      description: Connect calls in a conference.
      operationId: connect-calls
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConnectRequest'
            examples:
              Connect request:
                summary: Connect request
                value:
                  callIds:
                  - d8d84155-3831-43fb-91c9-bb897149a79d
                  - 6539fcb4-4b2a-4ac9-a43a-d60807af29b0
                  - d6d6058c-5077-49f9-a030-2fc40e8ca195
              Connect request with conference:
                summary: Connect request with conference
                value:
                  callIds:
                  - d8d84155-3831-43fb-91c9-bb897149a79d
                  - 6539fcb4-4b2a-4ac9-a43a-d60807af29b0
                  - d6d6058c-5077-49f9-a030-2fc40e8ca195
                  conferenceRequest:
                    name: Example conference
                    recording:
                      recordingType: AUDIO
                      conferenceComposition:
                        enabled: true
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
        required: true
      responses:
        '200':
          description: Calls connected.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
              examples:
                Conference response:
                  summary: Conference response
                  value:
                    id: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    name: Example conference
                    participants: []
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: One or more calls not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/connect:
    post:
      tags:
      - channels
      summary: Connect with new call
      description: Connect an existing call with a new call in a conference.
      operationId: connect-with-new-call
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ConnectWithNewCallRequest'
            examples:
              Connect with new call request:
                summary: Connect with new call request
                value:
                  callRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                  connectOnEarlyMedia: false
              Connect with new call and conference request:
                summary: Connect with new call and conference request
                value:
                  callRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    maxDuration: 300
                  connectOnEarlyMedia: false
                  conferenceRequest:
                    name: Example conference
                    recording:
                      recordingType: AUDIO
                      conferenceComposition:
                        enabled: true
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
        required: true
      responses:
        '200':
          description: Calls connected in the conference.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall'
              examples:
                Conference with new outbound call:
                  summary: Conference with new outbound call
                  value:
                    conference:
                      id: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                      name: Example conference
                      participants: []
                      callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                    call:
                      id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41792036727'
                      from: '41793026834'
                      to: '41792036727'
                      direction: OUTBOUND
                      state: ESTABLISHED
                      startTime: 2026-01-15T11:59:30.000+0000
                      answerTime: 2026-01-15T11:59:35.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      customData:
                        key1: value1
                        key2: value2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Call or application not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 6
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/send-ringing:
    post:
      tags:
      - channels
      summary: Send ringing
      description: Send SIP ringtone to an unanswered inbound call.
      operationId: send-ringing
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/pre-answer:
    post:
      tags:
      - channels
      summary: Pre-answer
      description: Pre-answer a call to handle early media.
      operationId: pre-answer-call
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPreAnswerRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/answer:
    post:
      tags:
      - channels
      summary: Answer
      description: Answer a call.
      operationId: answer-call
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnswerRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/hangup:
    post:
      tags:
      - channels
      summary: Hangup
      description: Hang up a call.
      operationId: hangup-call
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/74d8b21d2b740d37eba3fa2f7296b180343b1bcffffec58c82756c7c83775e15.PublicHangupRequest'
            examples:
              Basic hangup request example.:
                summary: Basic hangup request example.
                value: {}
              Basic hangup request example with error code.:
                summary: Basic hangup request example with error code.
                value:
                  errorCode: NORMAL_HANGUP
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/play:
    post:
      tags:
      - channels
      summary: Play file
      description: Play an audio file on a call.
      operationId: call-play-file
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPlayRequest'
            examples:
              Play audio from file:
                summary: Play audio from file
                value:
                  content:
                    fileId: 65f0b3d7c8b6a00001a2b3c4
                    type: FILE
              Play audio from URL:
                summary: Play audio from URL
                value:
                  content:
                    fileUrl: https://example.com/example-audio.wav
                    type: URL
              Play audio from TEXT:
                summary: Play audio from TEXT
                value:
                  content:
                    text: This is an example of text to speech
                    language: en
                    type: TEXT
              Play TTY audio from TEXT:
                summary: Play TTY audio from TEXT
                value:
                  content:
                    text: This is a TTY example
                    type: TTY
              Play audio in loop:
                summary: Play audio in loop
                value:
                  loopCount: 3
                  content:
                    fileUrl: https://example.com/example-audio.wav
                    type: URL
              Play audio with offset and timeout:
                summary: Play audio with offset and timeout
                value:
                  timeout: 30000
                  offset: 5000
                  content:
                    fileId: 65f0b3d7c8b6a00001a2b3c4
                    type: FILE
              Play audio with stop on DTMF option:
                summary: Play audio with stop on DTMF option
                value:
                  content:
                    fileId: 65f0b3d7c8b6a00001a2b3c4
                    type: FILE
                  stopOn:
                    terminator: '5'
                    type: DTMF
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/stop-play:
    post:
      tags:
      - channels
      summary: Stop playing file
      description: Stop playing an audio file on a call.
      operationId: call-stop-playing-file
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicStopPlayRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/say:
    post:
      tags:
      - channels
      summary: Say text
      description: Say text on a call.
      operationId: call-say-text
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicSayRequest'
            examples:
              Basic say request example:
                summary: Basic say request example
                value:
                  text: This is an example of text to speech
                  language: en
              Advanced say request example:
                summary: Advanced say request example
                value:
                  text: This is an advanced example of text to speech
                  language: en
                  speechRate: 1.5
                  loopCount: 2
                  preferences:
                    voiceGender: MALE
                  stopOn:
                    terminator: '#'
                    type: DTMF
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/send-dtmf:
    post:
      tags:
      - channels
      summary: Send DTMF
      description: Send a DTMF on a call.
      operationId: call-send-dtmf
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/94dad8b938c4159f751dc1ff0b70e7beab7409955ce0b31399dbe9488973d3a6.DtmfSendRequest'
            examples:
              Send DTMF with single digit:
                summary: Send DTMF with single digit
                value:
                  dtmf: '3'
              Send DTMF with multiple digits:
                summary: Send DTMF with multiple digits
                value:
                  dtmf: 341#
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/capture/dtmf:
    post:
      tags:
      - channels
      summary: Capture DTMF
      description: Capture a DTMF on a call.
      operationId: call-capture-dtmf
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.DtmfCaptureRequest'
            examples:
              Capture DTMF request example:
                summary: Capture DTMF request example
                value:
                  maxLength: 4
                  timeout: 5000
                  terminator: '#'
                  digitTimeout: 3000
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/capture/speech:
    post:
      tags:
      - channels
      summary: Capture Speech
      description: Capture speech on a call.
      operationId: call-capture-speech
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.SpeechCaptureRequest'
            examples:
              Start speech capture request:
                summary: Start speech capture request
                value:
                  language: en-GB
                  timeout: 30
                  maxSilence: 3
                  keyPhrases:
                  - word
                  - phrase
                  customDictionary:
                  - custom
                  - word
                  advancedFormatting: true
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/start-transcription:
    post:
      tags:
      - channels
      summary: Start transcription
      description: Start call transcription.
      operationId: call-start-transcription
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicStartTranscriptionRequest'
            examples:
              Start transcription request:
                summary: Start transcription request
                value:
                  transcription:
                    language: en-GB
                    sendInterimResults: true
                    customDictionary:
                    - custom
                    - word
                    advancedFormatting: true
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/stop-transcription:
    post:
      tags:
      - channels
      summary: Stop transcription
      description: Stop call transcription.
      operationId: call-stop-transcription
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/start-recording:
    post:
      tags:
      - channels
      summary: Start recording
      description: Start a recording on a call.
      operationId: call-start-recording
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.RecordingStartRequest'
            examples:
              Start audio recording:
                summary: Start audio recording
                value:
                  recording:
                    recordingType: AUDIO
              Start audio recording with additional options:
                summary: Start audio recording with additional options
                value:
                  recording:
                    recordingType: AUDIO
                    maxSilence: 5
                    beep: true
                    maxDuration: 20
                    customData:
                      key1: value1
                      key2: value2
                    filePrefix: customFilename
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/stop-recording:
    post:
      tags:
      - channels
      summary: Stop recording
      description: Stop a recording on a call.
      operationId: call-stop-recording
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/start-media-stream:
    post:
      tags:
      - channels
      summary: Start streaming media
      description: Start streaming media.
      operationId: start-media-stream
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.StartMediaStreamRequest'
            examples:
              Start media stream request example:
                summary: Start media stream request example
                value:
                  mediaStream:
                    audioProperties:
                      mediaStreamConfigId: 63467c6e2885a5389ba11d80
                      replaceMedia: false
                      multiChannel:
                        enabled: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/stop-media-stream:
    post:
      tags:
      - channels
      summary: Stop streaming media
      description: Stop streaming media.
      operationId: stop-media-stream
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/send-message:
    post:
      tags:
      - channels
      summary: Send message
      description: Send a message to a specific WebRTC call leg.
      operationId: call-send-message
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallSendMessageRequest'
            examples:
              Send message to WebRTC endpoint:
                summary: Send message to WebRTC endpoint
                value:
                  message: This meeting will end in 5 minutes.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/application-transfer:
    post:
      tags:
      - channels
      summary: Request application transfer
      description: Request application transfer.
      operationId: application-transfer
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferRequest'
            examples:
              Application transfer request:
                summary: Application transfer request
                value:
                  destinationCallsConfigurationId: dc5942707c704551a00cd2ea
                  timeout: 20
              Application transfer request with platform:
                summary: Application transfer request with platform
                value:
                  destinationCallsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
                  timeout: 20
              Application transfer request with propagation options:
                summary: Application transfer request with propagation options
                value:
                  destinationCallsConfigurationId: dc5942707c704551a00cd2ea
                  timeout: 20
                  propagationOptions:
                    recordingTransferOptions:
                      continueCallRecording: true
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/application-transfer/{transferId}/accept:
    post:
      tags:
      - channels
      summary: Accept application transfer
      description: Accept application transfer.
      operationId: application-transfer-accept
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: transferId
        in: path
        description: The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/calls/{callId}/application-transfer/{transferId}/reject:
    post:
      tags:
      - channels
      summary: Reject application transfer
      description: Reject application transfer.
      operationId: application-transfer-reject
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: transferId
        in: path
        description: The unique identifier of a transfer, sent to the receiving application in an `ApplicationTransferRequestedEvent`.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences:
    get:
      tags:
      - channels
      summary: Get conferences
      description: Get conferences with pagination.
      operationId: get-conferences
      parameters:
      - name: name
        in: query
        description: Conference name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Conference
      - name: callId
        in: query
        description: Call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferencePage'
              examples:
                Conference page response.:
                  summary: Conference page response.
                  value:
                    results:
                    - id: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                      name: Example conference
                      participants: []
                      callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create conference
      description: Create a conference.
      operationId: create-conference
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceRequest'
            examples:
              Conference request:
                summary: Conference request
                value:
                  name: Example conference
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
              Conference request with recording:
                summary: Conference request with recording
                value:
                  name: Example conference
                  recording:
                    recordingType: AUDIO
                    conferenceComposition:
                      enabled: true
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
        required: true
      responses:
        '201':
          description: Conference created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
              examples:
                Conference response:
                  summary: Conference response
                  value:
                    id: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    name: Example conference
                    participants: []
                    callsConfigurationId: dc5942707c704551a00cd2ea
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Application not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}:
    get:
      tags:
      - channels
      summary: Get conference
      description: Get a single conference.
      operationId: get-conference
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Update all calls
      description: Update all calls in a conference.
      operationId: update-conference
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateRequest'
            examples:
              Mute all conference calls:
                summary: Mute all conference calls
                value:
                  muted: true
              Deaf all conference calls:
                summary: Deaf all conference calls
                value:
                  deaf: true
              Blind all conference calls:
                summary: Blind all conference calls
                value:
                  blind: true
              Unmute and deaf all conference calls:
                summary: Unmute and deaf all conference calls
                value:
                  muted: false
                  deaf: true
              Deaf and blind all conference calls (blinding applies only to WebRTC endpoints):
                summary: Deaf and blind all conference calls (blinding applies only to WebRTC endpoints)
                value:
                  deaf: true
                  blind: true
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/history:
    get:
      tags:
      - channels
      summary: Get conferences history
      description: Get conferences history with pagination. Conferences history retention period is 5 days.
      operationId: get-conferences-history
      parameters:
      - name: name
        in: query
        description: Conference name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Conference
      - name: callId
        in: query
        description: Call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the conference has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: endTimeBefore
        in: query
        description: 'Date and time for when the conference has been finished. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:26:45.125+0000
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceLogPage'
              examples:
                Conference log page response.:
                  summary: Conference log page response.
                  value:
                    results:
                    - conferenceId: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                      name: Example conference
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      startTime: 2026-01-15T11:57:30.000+0000
                      endTime: 2026-01-15T11:59:20.000+0000
                      duration: 110
                      sessions:
                      - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        joinTime: 2026-01-15T11:58:00.000+0000
                        leaveTime: 2026-01-15T11:59:00.000+0000
                      - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        joinTime: 2026-01-15T11:57:30.000+0000
                        leaveTime: 2026-01-15T11:59:20.000+0000
                      recording:
                        composedFiles:
                        - id: 65f0b3d7c8b6a00001a2b3d5
                          name: example-recording.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.000+0000
                          duration: 10
                          startTime: 2026-01-15T11:57:30.000+0000
                          endTime: 2026-01-15T11:59:20.000+0000
                          location: HOSTED
                        callRecordings:
                        - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          endpoint:
                            type: PHONE
                            phoneNumber: '41793026834'
                          direction: INBOUND
                          files:
                          - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                            name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                            fileFormat: WAV
                            size: 67564
                            creationTime: 2026-01-15T12:00:00.150+0000
                            duration: 10
                            startTime: 2026-01-15T11:59:50.000+0000
                            endTime: 2026-01-15T12:00:00.000+0000
                            location: HOSTED
                            customData:
                              key1: value1
                              key2: value2
                          status: SUCCESSFUL
                        - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                          endpoint:
                            type: PHONE
                            phoneNumber: '41793026834'
                          direction: INBOUND
                          files:
                          - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                            name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                            fileFormat: WAV
                            size: 67564
                            creationTime: 2026-01-15T12:00:00.150+0000
                            duration: 10
                            startTime: 2026-01-15T11:59:50.000+0000
                            endTime: 2026-01-15T12:00:00.000+0000
                            location: HOSTED
                            customData:
                              key1: value1
                              key2: value2
                          status: SUCCESSFUL
                      errorCode:
                        id: 10000
                        name: NORMAL_HANGUP
                        description: The call has ended with hangup initiated by caller, callee or API
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/history:
    get:
      tags:
      - channels
      summary: Get conference history
      description: Get a single conference history. Conference history retention period is 5 days.
      operationId: get-conference-history
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse'
              examples:
                Conference history log:
                  summary: Conference history log
                  value:
                    conferenceId: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    name: Example conference
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    startTime: 2026-01-15T11:57:30.000+0000
                    endTime: 2026-01-15T11:59:20.000+0000
                    duration: 110
                    sessions:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      joinTime: 2026-01-15T11:58:00.000+0000
                      leaveTime: 2026-01-15T11:59:00.000+0000
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      joinTime: 2026-01-15T11:57:30.000+0000
                      leaveTime: 2026-01-15T11:59:20.000+0000
                    recording:
                      composedFiles:
                      - id: 65f0b3d7c8b6a00001a2b3d5
                        name: example-recording.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.000+0000
                        duration: 10
                        startTime: 2026-01-15T11:57:30.000+0000
                        endTime: 2026-01-15T11:59:20.000+0000
                        location: HOSTED
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                      - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                    errorCode:
                      id: 10000
                      name: NORMAL_HANGUP
                      description: The call has ended with hangup initiated by caller, callee or API
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/call:
    post:
      tags:
      - channels
      summary: Add new call
      description: Create a new outbound call and add it to a conference.
      operationId: add-new-conference-call
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddNewCallRequest'
            examples:
              Add new call:
                summary: Add new call
                value:
                  callRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                  connectOnEarlyMedia: false
              Add new call and connect on early media:
                summary: Add new call and connect on early media
                value:
                  callRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                  connectOnEarlyMedia: true
              Add new call with a specific role:
                summary: Add new call with a specific role
                value:
                  callRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                  connectOnEarlyMedia: false
                  role:
                    type: MONITOR
        required: true
      responses:
        '200':
          description: Call added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall'
              examples:
                Add new call response example:
                  summary: Add new call response example
                  value:
                    conference:
                      id: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                      name: Example conference
                      participants: []
                      callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                    call:
                      id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41792036727'
                      from: '41793026834'
                      to: '41792036727'
                      direction: OUTBOUND
                      state: ESTABLISHED
                      startTime: 2026-01-15T11:59:30.000+0000
                      answerTime: 2026-01-15T11:59:35.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      customData:
                        key1: value1
                        key2: value2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Conference or application not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 6
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/call/{callId}:
    put:
      tags:
      - channels
      summary: Add existing call
      description: Add an existing call to a conference.
      operationId: add-existing-conference-call
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddExistingCallRequest'
            examples:
              Add existing call:
                summary: Add existing call
                value:
                  connectOnEarlyMedia: false
              Add existing call and connect on early media:
                summary: Add existing call and connect on early media
                value:
                  connectOnEarlyMedia: true
              Add existing call with a specific role:
                summary: Add existing call with a specific role
                value:
                  connectOnEarlyMedia: false
                  role:
                    type: MONITOR
      responses:
        '200':
          description: Call added.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Conference or call not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Remove call
      description: Remove a call from a conference. The call stays active after this action.
      operationId: remove-conference-call
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Conference or call not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Update call
      description: Update a call in a conference.
      operationId: update-conference-call
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateCallRequest'
            examples:
              Mute single conference call:
                summary: Mute single conference call
                value:
                  muted: true
              Deaf single conference call:
                summary: Deaf single conference call
                value:
                  deaf: true
              Unmute and deaf single conference call:
                summary: Unmute and deaf single conference call
                value:
                  muted: false
                  deaf: true
              Blind single conference call:
                summary: Blind single conference call
                value:
                  blind: true
              Change role inside the conference:
                summary: Change role inside the conference
                value:
                  role:
                    type: MONITOR
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Conference or call not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/hangup:
    post:
      tags:
      - channels
      summary: Hangup conference
      description: Hang up a conference. This action also hangs up all calls in the conference.
      operationId: hangup-conference
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/play:
    post:
      tags:
      - channels
      summary: Play file
      description: Play an audio file on a conference.
      operationId: conference-play-file
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferencePlayRequest'
            examples:
              Play audio from file:
                summary: Play audio from file
                value:
                  content:
                    fileId: 218eceba-c044-430d-9f26-8f1a7f0g2d03
                    type: FILE
              Play audio from URL:
                summary: Play audio from URL
                value:
                  content:
                    fileUrl: https://www.example.com/file.wav
                    type: URL
              Play audio in loop:
                summary: Play audio in loop
                value:
                  loopCount: 3
                  content:
                    fileUrl: https://www.example.com/file.wav
                    type: URL
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/stop-play:
    post:
      tags:
      - channels
      summary: Stop playing file
      description: Stop playing an audio file on a conference.
      operationId: conference-stop-playing-file
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/say:
    post:
      tags:
      - channels
      summary: Say text
      description: Say text on a conference.
      operationId: conference-say-text
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSayRequest'
            examples:
              Say request:
                summary: Say request
                value:
                  text: Hello world
                  language: en
              Say request with additional options:
                summary: Say request with additional options
                value:
                  text: Hello world
                  language: en
                  speechRate: 1.2
                  loopCount: 3
                  preferences:
                    voiceGender: FEMALE
                    voiceName: Joanna
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/start-recording:
    post:
      tags:
      - channels
      summary: Start recording
      description: Start recording a conference.
      operationId: conference-start-recording
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest'
            examples:
              Start recording request:
                summary: Start recording request
                value:
                  recordingType: AUDIO_AND_VIDEO
              Start recording request with composition:
                summary: Start recording request with composition
                value:
                  recordingType: AUDIO
                  conferenceComposition:
                    enabled: true
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/stop-recording:
    post:
      tags:
      - channels
      summary: Stop recording
      description: Stop recording a conference.
      operationId: conference-stop-recording
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/broadcast-webrtc-text:
    post:
      tags:
      - channels
      summary: Broadcast text
      description: Broadcasts a text message to conference WebRTC participants with open data channel.
      operationId: conference-broadcast-webrtc-text
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceBroadcastWebrtcTextRequest'
            examples:
              Conference broadcast WebRTC text request:
                summary: Conference broadcast WebRTC text request
                value:
                  text: This meeting will end in 5 minutes.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-deprecationInformation:
        deprecation: 2025-11-06T12:00:00.000+0000
        sunset: 2026-01-11T12:00:00.000+0000
        successorOperationId: conference-send-message
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/conferences/{conferenceId}/send-message:
    post:
      tags:
      - channels
      summary: Send message
      description: Send a message to all WebRTC participants in a conference.
      operationId: conference-send-message
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSendMessageRequest'
            examples:
              Send a message to all WebRTC participants in a conference:
                summary: Send a message to all WebRTC participants in a conference
                value:
                  message: This meeting will end in 5 minutes.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs:
    get:
      tags:
      - channels
      summary: Get dialogs
      description: Get dialogs with pagination.
      operationId: get-dialogs
      parameters:
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: state
        in: query
        description: Dialog state.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState'
        example: ESTABLISHED
      - name: parentCallId
        in: query
        description: Parent call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: childCallId
        in: query
        description: Child call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 072675c6-3db6-0fb9-b632-031264d09ck2
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogPage'
              examples:
                Dialog page response.:
                  summary: Dialog page response.
                  value:
                    results:
                    - id: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      state: ESTABLISHED
                      startTime: 2026-01-15T12:00:00.000+0000
                      establishTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      parentCall:
                        id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        state: ESTABLISHED
                        media:
                          audio:
                            muted: false
                            deaf: false
                          video:
                            camera: false
                            screenShare: false
                            blind: false
                        startTime: 2026-01-15T12:00:00.000+0000
                        answerTime: 2026-01-15T12:00:02.000+0000
                        endTime: 2026-01-15T12:01:00.000+0000
                        ringDuration: 2
                        platform:
                          applicationId: 61c060db2675060027d8c7a6
                        dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                      childCall:
                        id: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        endpoint:
                          type: PHONE
                          phoneNumber: '41792036727'
                        direction: OUTBOUND
                        state: ESTABLISHED
                        media:
                          audio:
                            muted: false
                            deaf: false
                          video:
                            camera: false
                            screenShare: false
                            blind: false
                        startTime: 2026-01-15T12:00:00.000+0000
                        answerTime: 2026-01-15T12:00:02.000+0000
                        endTime: 2026-01-15T12:01:00.000+0000
                        ringDuration: 2
                        platform:
                          applicationId: 61c060db2675060027d8c7a6
                        dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create dialog
      description: Create a dialog.
      operationId: create-dialog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogRequest'
            examples:
              Dialog request:
                summary: Dialog request
                value:
                  parentCallId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                  childCallRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
                    connectTimeout: 60
                    machineDetection:
                      enabled: true
                    customData:
                      key1: value1
                      key2: value2
                  recording:
                    recordingType: AUDIO
                    dialogComposition:
                      enabled: false
                  maxDuration: 3600
                  propagationOptions:
                    childCallHangup: false
        required: true
      responses:
        '201':
          description: Dialog created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
              examples:
                Created dialog response:
                  summary: Created dialog response
                  value:
                    id: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    state: ESTABLISHED
                    startTime: 2026-01-15T12:00:00.000+0000
                    establishTime: 2026-01-15T12:00:02.000+0000
                    endTime: 2026-01-15T12:01:00.000+0000
                    parentCall:
                      id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      state: ESTABLISHED
                      media:
                        audio:
                          muted: false
                          deaf: false
                        video:
                          camera: false
                          screenShare: false
                          blind: false
                      startTime: 2026-01-15T12:00:00.000+0000
                      answerTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      ringDuration: 2
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    childCall:
                      id: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41792036727'
                      direction: OUTBOUND
                      state: ESTABLISHED
                      media:
                        audio:
                          muted: false
                          deaf: false
                        video:
                          camera: false
                          screenShare: false
                          blind: false
                      startTime: 2026-01-15T12:00:00.000+0000
                      answerTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      ringDuration: 2
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Application not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/parent-call/{parentCallId}/child-call/{childCallId}:
    post:
      tags:
      - channels
      summary: Create dialog with existing calls
      description: Create a dialog with existing calls.
      operationId: create-dialog-with-existing-calls
      parameters:
      - name: parentCallId
        in: path
        description: Call ID of the parent call to be connected in a dialog.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 126f327b-dd4e-456d-8a10-1cb78a23bc8a
      - name: childCallId
        in: path
        description: Call ID of the child call to be connected in a dialog. Needs to have been created using [create method](#create-call) with `parentCallId` parameter equal to the parent call ID above.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogWithExistingCallsRequest'
            examples:
              Dialog with existing call request:
                summary: Dialog with existing call request
                value:
                  recording:
                    recordingType: AUDIO
                    dialogComposition:
                      enabled: false
                    customData:
                      property1: value1
                      string: string
                  maxDuration: 28800
                  propagationOptions:
                    childCallHangup: true
                    childCallRinging: false
                    ringbackGeneration:
                      enabled: false
        required: true
      responses:
        '201':
          description: Dialog created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Application not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}:
    get:
      tags:
      - channels
      summary: Get dialog
      description: Get a single dialog.
      operationId: get-dialog
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
              examples:
                Dialog response:
                  summary: Dialog response
                  value:
                    id: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    state: ESTABLISHED
                    startTime: 2026-01-15T12:00:00.000+0000
                    establishTime: 2026-01-15T12:00:02.000+0000
                    endTime: 2026-01-15T12:01:00.000+0000
                    parentCall:
                      id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      state: ESTABLISHED
                      media:
                        audio:
                          muted: false
                          deaf: false
                        video:
                          camera: false
                          screenShare: false
                          blind: false
                      startTime: 2026-01-15T12:00:00.000+0000
                      answerTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      ringDuration: 2
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    childCall:
                      id: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41792036727'
                      direction: OUTBOUND
                      state: ESTABLISHED
                      media:
                        audio:
                          muted: false
                          deaf: false
                        video:
                          camera: false
                          screenShare: false
                          blind: false
                      startTime: 2026-01-15T12:00:00.000+0000
                      answerTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      ringDuration: 2
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/history:
    get:
      tags:
      - channels
      summary: Get dialogs history
      description: Get dialogs history with pagination. Dialogs history retention period is 5 days.
      operationId: get-dialogs-history
      parameters:
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: state
        in: query
        description: Dialog state.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState'
        example: ESTABLISHED
      - name: parentCallId
        in: query
        description: Parent call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 066675c6-0db6-0db9-b032-031964d09af4
      - name: childCallId
        in: query
        description: Child call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 072675c6-3db6-0fb9-b632-031264d09ck2
      - name: startTimeAfter
        in: query
        description: 'Date and time for when the dialog has been created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.125+0000
      - name: endTimeBefore
        in: query
        description: 'Date and time for when the dialog has been finished. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:26:45.125+0000
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogLogPage'
              examples:
                Dialog log page response.:
                  summary: Dialog log page response.
                  value:
                    results:
                    - dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      state: ESTABLISHED
                      startTime: 2026-01-15T12:00:00.000+0000
                      establishTime: 2026-01-15T12:00:02.000+0000
                      endTime: 2026-01-15T12:01:00.000+0000
                      parentCallId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      childCallId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      duration: 60
                      recording:
                        composedFiles:
                        - id: 65f0b3d7c8b6a00001a2b3d5
                          name: example-recording.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.000+0000
                          duration: 10
                          startTime: 2026-01-15T11:57:30.000+0000
                          endTime: 2026-01-15T11:59:20.000+0000
                          location: SFTP
                          sftpUploadStatus: UPLOADED
                        callRecordings:
                        - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          endpoint:
                            type: PHONE
                            phoneNumber: '41793026834'
                          direction: INBOUND
                          files:
                          - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                            name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                            fileFormat: WAV
                            size: 67564
                            creationTime: 2026-01-15T12:00:00.150+0000
                            duration: 10
                            startTime: 2026-01-15T11:59:50.000+0000
                            endTime: 2026-01-15T12:00:00.000+0000
                            location: HOSTED
                            customData:
                              key1: value1
                              key2: value2
                          status: SUCCESSFUL
                        - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                          endpoint:
                            type: PHONE
                            phoneNumber: '41793026834'
                          direction: INBOUND
                          files:
                          - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                            name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                            fileFormat: WAV
                            size: 67564
                            creationTime: 2026-01-15T12:00:00.150+0000
                            duration: 10
                            startTime: 2026-01-15T11:59:50.000+0000
                            endTime: 2026-01-15T12:00:00.000+0000
                            location: HOSTED
                            customData:
                              key1: value1
                              key2: value2
                          status: SUCCESSFUL
                      errorCode:
                        id: 10000
                        name: NORMAL_HANGUP
                        description: The call has ended with hangup initiated by caller, callee or API
                      hangupSource: CHILD_ENDPOINT
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/history:
    get:
      tags:
      - channels
      summary: Get dialog history
      description: Get a single dialog history. Dialog history retention period is 5 days.
      operationId: get-dialog-history
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse'
              examples:
                Dialog log response:
                  summary: Dialog log response
                  value:
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    state: ESTABLISHED
                    startTime: 2026-01-15T12:00:00.000+0000
                    establishTime: 2026-01-15T12:00:02.000+0000
                    endTime: 2026-01-15T12:01:00.000+0000
                    parentCallId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    childCallId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                    duration: 60
                    recording:
                      composedFiles:
                      - id: 65f0b3d7c8b6a00001a2b3d5
                        name: example-recording.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.000+0000
                        duration: 10
                        startTime: 2026-01-15T11:57:30.000+0000
                        endTime: 2026-01-15T11:59:20.000+0000
                        location: SFTP
                        sftpUploadStatus: UPLOADED
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                      - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                    errorCode:
                      id: 10000
                      name: NORMAL_HANGUP
                      description: The call has ended with hangup initiated by caller, callee or API
                    hangupSource: CHILD_ENDPOINT
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/hangup:
    post:
      tags:
      - channels
      summary: Hangup dialog
      description: Hang up a dialog. This action also hangs up all calls in the dialog.
      operationId: hangup-dialog
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/play:
    post:
      tags:
      - channels
      summary: Play file
      description: Play an audio file on a dialog.
      operationId: dialog-play-file
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogPlayRequest'
            examples:
              Play audio from file:
                summary: Play audio from file
                value:
                  content:
                    fileId: 65f0b3d7c8b6a00001a2b3c4
                    type: FILE
              Play audio from URL:
                summary: Play audio from URL
                value:
                  content:
                    fileUrl: https://example.com/example-audio.wav
                    type: URL
              Play audio in loop:
                summary: Play audio in loop
                value:
                  loopCount: 3
                  content:
                    fileUrl: https://example.com/example-audio.wav
                    type: URL
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/say:
    post:
      tags:
      - channels
      summary: Say text
      description: Say text on a dialog.
      operationId: dialog-say-text
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSayRequest'
            examples:
              Simple say request:
                summary: Simple say request
                value:
                  text: Hello world
                  language: en
              Say request with additional options:
                summary: Say request with additional options
                value:
                  text: Hello world
                  language: en
                  speechRate: 1.2
                  loopCount: 3
                  preferences:
                    voiceGender: FEMALE
                    voiceName: Joanna
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/stop-play:
    post:
      tags:
      - channels
      summary: Stop playing file
      description: Stop playing an audio file on a dialog.
      operationId: dialog-stop-playing-file
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/start-recording:
    post:
      tags:
      - channels
      summary: Start recording
      description: Start recording a dialog.
      operationId: dialog-start-recording
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest'
            examples:
              Request dialog recording.:
                summary: Request dialog recording.
                value:
                  recordingType: AUDIO_AND_VIDEO
                  dialogComposition:
                    enabled: true
                  customData:
                    key: value
                  filePrefix: customFilename
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/stop-recording:
    post:
      tags:
      - channels
      summary: Stop recording
      description: Stop recording a dialog.
      operationId: dialog-stop-recording
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:record
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/broadcast-webrtc-text:
    post:
      tags:
      - channels
      summary: Broadcast text
      description: Broadcasts a text message to dialog WebRTC call legs with open data channel.
      operationId: dialog-broadcast-webrtc-text
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogBroadcastWebrtcTextRequest'
            examples:
              Broadcast text to dialog WebRTC call legs with open data channel.:
                summary: Broadcast text to dialog WebRTC call legs with open data channel.
                value:
                  text: This dialog will end in 5 minutes.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-deprecationInformation:
        deprecation: 2025-11-06T12:00:00.000+0000
        sunset: 2026-01-11T12:00:00.000+0000
        successorOperationId: dialog-send-message
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/send-message:
    post:
      tags:
      - channels
      summary: Send message
      description: Send a message to all WebRTC call legs in a dialog.
      operationId: dialog-send-message
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSendMessageRequest'
            examples:
              Send a message to all WebRTC call legs in a dialog:
                summary: Send a message to all WebRTC call legs in a dialog
                value:
                  message: This meeting will end in 5 minutes.
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/transfer/accept:
    post:
      tags:
      - channels
      summary: Dialog transfer accept
      description: Accepts a dialog transfer request.
      operationId: dialog-transfer-accept
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogAcceptTransferRequest'
            examples:
              Accept transfer request:
                summary: Accept transfer request
                value:
                  targetCallRequest:
                    endpoint:
                      type: PHONE
                      phoneNumber: '41792036727'
                    from: '41793026834'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 6
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/dialogs/{dialogId}/transfer/reject:
    post:
      tags:
      - channels
      summary: Dialog transfer reject
      description: Rejects a dialog transfer request.
      operationId: dialog-transfer-reject
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:receive
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/sip-trunks:
    get:
      tags:
      - channels
      summary: Get SIP trunks
      description: Get SIP trunks with pagination.
      operationId: get-sip-trunks
      parameters:
      - name: name
        in: query
        description: SIP trunk name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: My SIP trunk
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkPage'
              examples:
                SIP trunk page response.:
                  summary: SIP trunk page response.
                  value:
                    results:
                    - id: 62eb6ff07b18cc6cdf5cf001
                      type: STATIC
                      name: Static SIP Trunk
                      location: NEW_YORK
                      tls: false
                      codecs:
                      - PCMU
                      - PCMA
                      dtmf: INBAND
                      fax: T38
                      numberFormat: US_NATIONAL
                      internationalCallsAllowed: false
                      channelLimit: 10
                      anonymization: REMOTE_PARTY_ID
                      billingPackage:
                        packageType: UNLIMITED
                        countryCode: USA
                        addressId: '562949953421333'
                      sbcHosts:
                        primary:
                        - 111.111.111.111:5060
                        backup:
                        - 222.222.222.222:5060
                        subnets:
                        - 11.22.33.44/24
                      sipOptions:
                        enabled: false
                      sourceHosts:
                      - 10.10.10.10
                      destinationHosts:
                      - 100.100.100.100:5060
                      - my.destination.com
                      - my.destination.com:5060
                      strategy: ROUND_ROBIN
                    - id: 62eb6ff07b18cc6cdf5cf001
                      type: REGISTERED
                      name: Registered SIP Trunk
                      location: SAO_PAULO
                      tls: true
                      codecs:
                      - G729
                      dtmf: RFC2833
                      fax: NONE
                      numberFormat: E164
                      internationalCallsAllowed: true
                      channelLimit: 999
                      anonymization: PREFERRED_IDENTITY
                      billingPackage:
                        packageType: METERED
                      sbcHosts:
                        primary:
                        - 111.111.111.111:5061
                        backup:
                        - 222.222.222.222:5061
                        subnets:
                        - 11.22.33.44/24
                      username: 426c8402-691c-11ee-8c99-0242ac120002
                      inviteAuthentication: true
                    paging:
                      page: 0
                      size: 2
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create SIP trunk
      description: Create a SIP trunk. Fields not sent in request body will take default values. This operation is asynchronous. The SIP trunk will be created in the background.
      operationId: create-sip-trunk
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest'
            examples:
              Static SIP trunk:
                summary: Static SIP trunk
                value:
                  type: STATIC
                  name: Static SIP trunk
                  location: NEW_YORK
                  internationalCallsAllowed: false
                  channelLimit: 10
                  billingPackage:
                    packageType: UNLIMITED
                    countryCode: USA
                    addressId: '562949953421333'
                  tls: false
                  codecs:
                  - PCMU
                  - PCMA
                  dtmf: INBAND
                  fax: T38
                  numberFormat: US_NATIONAL
                  anonymization: REMOTE_PARTY_ID
                  sourceHosts:
                  - 10.10.10.10
                  destinationHosts:
                  - 100.100.100.101:5060
                  - my.destination.com
                  - my.destination.com:5060
                  strategy: ROUND_ROBIN
                  sipOptions:
                    enabled: false
              Registered SIP trunk:
                summary: Registered SIP trunk
                value:
                  type: REGISTERED
                  name: Registered SIP trunk
                  location: SAO_PAULO
                  internationalCallsAllowed: true
                  channelLimit: 999
                  billingPackage:
                    packageType: METERED
                  tls: true
                  codecs:
                  - G729
                  dtmf: RFC2833
                  fax: NONE
                  numberFormat: E164
                  anonymization: PREFERRED_IDENTITY
                  inviteAuthentication: true
              Freshworks Provider SIP trunk:
                summary: Freshworks Provider SIP trunk
                value:
                  type: PROVIDER
                  name: Freshworks Provider SIP trunk
                  location: SAO_PAULO
                  internationalCallsAllowed: true
                  channelLimit: 10
                  billingPackage:
                    packageType: METERED
                  provider:
                    accountSid: '223344'
                    sipDomain: 123456-sip.domain.com
                    type: FRESHWORKS
              Genesys Cloud Provider SIP trunk:
                summary: Genesys Cloud Provider SIP trunk
                value:
                  type: PROVIDER
                  name: Genesys Provider SIP trunk
                  internationalCallsAllowed: true
                  channelLimit: 10
                  billingPackage:
                    packageType: METERED
                  tls: true
                  provider:
                    region: NA_US_EAST_1
                    type: GENESYS_CLOUD
              Cisco Webex Provider SIP trunk:
                summary: Cisco Webex Provider SIP trunk
                value:
                  type: PROVIDER
                  name: Cisco Webex SIP trunk
                  location: NEW_YORK
                  internationalCallsAllowed: true
                  channelLimit: 10
                  billingPackage:
                    packageType: METERED
                  provider:
                    ciscoUUID: b48b3fdd-d0e4-4da6-b350-58600ec1ffec
                    type: CISCO_WEBEX
              OpenAI Realtime Provider SIP trunk:
                summary: OpenAI Realtime Provider SIP trunk
                value:
                  type: PROVIDER
                  name: OpenAI Realtime SIP trunk
                  location: FRANKFURT
                  internationalCallsAllowed: true
                  channelLimit: 10
                  billingPackage:
                    packageType: METERED
                  provider:
                    projectId: proj_123456
                    type: OPENAI_REALTIME
        required: true
      responses:
        '202':
          description: Create SIP trunk request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse'
              examples:
                Static SIP trunk:
                  summary: Static SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: STATIC
                    name: Static SIP Trunk
                    location: NEW_YORK
                    internationalCallsAllowed: false
                    channelLimit: 10
                    billingPackage:
                      packageType: UNLIMITED
                      countryCode: USA
                      addressId: '562949953421333'
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5060
                      backup:
                      - 222.222.222.222:5060
                      subnets:
                      - 11.22.33.44/24
                    tls: false
                    codecs:
                    - PCMU
                    - PCMA
                    dtmf: INBAND
                    fax: T38
                    numberFormat: US_NATIONAL
                    anonymization: REMOTE_PARTY_ID
                    sourceHosts:
                    - 10.10.10.10
                    destinationHosts:
                    - 100.100.100.100:5060
                    - my.destination.com
                    - my.destination.com:5060
                    strategy: ROUND_ROBIN
                    sipOptions:
                      enabled: false
                Registered SIP trunk:
                  summary: Registered SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: REGISTERED
                    name: Registered SIP Trunk
                    location: SAO_PAULO
                    internationalCallsAllowed: true
                    channelLimit: 999
                    billingPackage:
                      packageType: METERED
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5061
                      backup:
                      - 222.222.222.222:5061
                      subnets:
                      - 11.22.33.44/24
                    tls: true
                    codecs:
                    - G729
                    dtmf: RFC2833
                    fax: NONE
                    numberFormat: E164
                    anonymization: PREFERRED_IDENTITY
                    username: 426c8402-691c-11ee-8c99-0242ac120002
                    password: fkZ1921tM87
                    inviteAuthentication: true
                Freshworks Provider SIP trunk:
                  summary: Freshworks Provider SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: PROVIDER
                    name: Freshworks Provider SIP trunk
                    location: FRANKFURT
                    internationalCallsAllowed: true
                    channelLimit: 10
                    billingPackage:
                      packageType: METERED
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5061
                      backup:
                      - 222.222.222.222:5061
                      subnets:
                      - 11.22.33.44/24
                    provider:
                      accountSid: '223344'
                      sipDomain: 123456-sip.domain.com
                      type: FRESHWORKS
                Genesys Cloud Provider SIP trunk:
                  summary: Genesys Cloud Provider SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: PROVIDER
                    name: Genesys Provider SIP trunk
                    location: NEW_YORK
                    internationalCallsAllowed: true
                    channelLimit: 10
                    billingPackage:
                      packageType: METERED
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5061
                      backup:
                      - 222.222.222.222:5061
                    provider:
                      region: NA_US_EAST_1
                      outboundTerminationFQDN: b48b3fdd-d0e4-4da6-b350-58600ec1ffec
                      inboundTerminationIdentifier: b48b3fdd-d0e4-4da6-b350-58600ec1ffec
                      type: GENESYS_CLOUD
                Cisco Webex Provider SIP trunk:
                  summary: Cisco Webex Provider SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: PROVIDER
                    name: Cisco Webex SIP trunk
                    location: NEW_YORK
                    internationalCallsAllowed: true
                    channelLimit: 10
                    billingPackage:
                      packageType: METERED
                    provider:
                      ciscoUUID: b48b3fdd-d0e4-4da6-b350-58600ec1ffec
                      type: CISCO_WEBEX
                OpenAI Realtime Provider SIP trunk:
                  summary: OpenAI Realtime Provider SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: PROVIDER
                    name: OpenAI Realtime SIP trunk
                    location: FRANKFURT
                    internationalCallsAllowed: true
                    channelLimit: 10
                    billingPackage:
                      packageType: METERED
                    provider:
                      projectId: proj_123456
                      type: OPENAI_REALTIME
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/sip-trunks/{sipTrunkId}:
    get:
      tags:
      - channels
      summary: Get SIP trunk
      description: Get a single SIP trunk.
      operationId: get-sip-trunk
      parameters:
      - name: sipTrunkId
        in: path
        description: SIP trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse'
              examples:
                Static SIP trunk:
                  summary: Static SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: STATIC
                    name: Static SIP Trunk
                    location: NEW_YORK
                    tls: false
                    codecs:
                    - PCMU
                    - PCMA
                    dtmf: INBAND
                    fax: T38
                    numberFormat: US_NATIONAL
                    internationalCallsAllowed: false
                    channelLimit: 10
                    anonymization: REMOTE_PARTY_ID
                    billingPackage:
                      packageType: UNLIMITED
                      countryCode: USA
                      addressId: '562949953421333'
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5060
                      backup:
                      - 222.222.222.222:5060
                      subnets:
                      - 11.22.33.44/24
                    sipOptions:
                      enabled: false
                    sourceHosts:
                    - 10.10.10.10
                    destinationHosts:
                    - 100.100.100.100:5060
                    - my.destination.com
                    - my.destination.com:5060
                    strategy: ROUND_ROBIN
                Registered SIP trunk:
                  summary: Registered SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: REGISTERED
                    name: Registered SIP Trunk
                    location: SAO_PAULO
                    tls: true
                    codecs:
                    - G729
                    dtmf: RFC2833
                    fax: NONE
                    numberFormat: E164
                    internationalCallsAllowed: true
                    channelLimit: 999
                    anonymization: PREFERRED_IDENTITY
                    billingPackage:
                      packageType: METERED
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5061
                      backup:
                      - 222.222.222.222:5061
                      subnets:
                      - 11.22.33.44/24
                    username: 426c8402-691c-11ee-8c99-0242ac120002
                    inviteAuthentication: true
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update SIP trunk
      description: Update a SIP trunk. Fields not sent in request body will take default values and overwrite the existing ones. This operation is asynchronous. The SIP trunk will be updated in the background.
      operationId: update-sip-trunk
      parameters:
      - name: sipTrunkId
        in: path
        description: Sip Trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest'
            examples:
              Static SIP trunk:
                summary: Static SIP trunk
                value:
                  type: STATIC
                  name: Static SIP trunk
                  internationalCallsAllowed: false
                  channelLimit: 10
                  sourceHosts:
                  - 10.10.10.10
                  destinationHosts:
                  - 100.100.100.101:5060
                  - my.destination.com
                  - my.destination.com:5060
                  codecs:
                  - PCMA
                  - PCMU
                  dtmf: INBAND
                  fax: T38
                  anonymization: REMOTE_PARTY_ID
                  numberFormat: US_NATIONAL
                  sipOptions:
                    enabled: false
              Registered SIP trunk:
                summary: Registered SIP trunk
                value:
                  type: REGISTERED
                  name: Registered SIP trunk
                  internationalCallsAllowed: true
                  channelLimit: 999
                  inviteAuthentication: true
                  codecs:
                  - G729
                  dtmf: RFC2833
                  fax: NONE
                  anonymization: PREFERRED_IDENTITY
                  numberFormat: E164
        required: true
      responses:
        '202':
          description: Update SIP trunk request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete SIP trunk
      description: Delete a SIP trunk. This operation is asynchronous. The SIP trunk will be deleted in the background.
      operationId: delete-sip-trunk
      parameters:
      - name: sipTrunkId
        in: path
        description: SIP trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '202':
          description: Delete SIP trunk request accepted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse'
              examples:
                Static SIP trunk:
                  summary: Static SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: STATIC
                    name: Static SIP Trunk
                    location: NEW_YORK
                    tls: false
                    codecs:
                    - PCMU
                    - PCMA
                    dtmf: INBAND
                    fax: T38
                    numberFormat: US_NATIONAL
                    internationalCallsAllowed: false
                    channelLimit: 10
                    anonymization: REMOTE_PARTY_ID
                    billingPackage:
                      packageType: UNLIMITED
                      countryCode: USA
                      addressId: '562949953421333'
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5060
                      backup:
                      - 222.222.222.222:5060
                      subnets:
                      - 11.22.33.44/24
                    sipOptions:
                      enabled: false
                    sourceHosts:
                    - 10.10.10.10
                    destinationHosts:
                    - 100.100.100.100:5060
                    - my.destination.com
                    - my.destination.com:5060
                    strategy: ROUND_ROBIN
                Registered SIP trunk:
                  summary: Registered SIP trunk
                  value:
                    id: 62eb6ff07b18cc6cdf5cf001
                    type: REGISTERED
                    name: Registered SIP Trunk
                    location: SAO_PAULO
                    tls: true
                    codecs:
                    - G729
                    dtmf: RFC2833
                    fax: NONE
                    numberFormat: E164
                    internationalCallsAllowed: true
                    channelLimit: 999
                    anonymization: PREFERRED_IDENTITY
                    billingPackage:
                      packageType: METERED
                    sbcHosts:
                      primary:
                      - 111.111.111.111:5061
                      backup:
                      - 222.222.222.222:5061
                      subnets:
                      - 11.22.33.44/24
                    username: 426c8402-691c-11ee-8c99-0242ac120002
                    inviteAuthentication: true
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/sip-trunks/{sipTrunkId}/reset-password:
    post:
      tags:
      - channels
      summary: Reset SIP trunk credentials
      description: Reset credentials. For `REGISTERED` SIP trunks, resets the registration password. For `AUTHENTICATED` SIP trunks, resets the authentication secrets (header value and digest credentials).
      operationId: reset-sip-trunk-password
      parameters:
      - name: sipTrunkId
        in: path
        description: SIP trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Successfully reset credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse'
              examples:
                Registered SIP trunk credentials:
                  summary: Registered SIP trunk credentials
                  value:
                    username: 426c8402-691c-11ee-8c99-0242ac120002
                    password: fkZ1921tM87
                    type: REGISTERED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/sip-trunks/{sipTrunkId}/status:
    get:
      tags:
      - channels
      summary: Get SIP trunk status
      description: Get a SIP trunk status. Successfully deleted SIP trunk does not have status.
      operationId: get-sip-trunk-status
      parameters:
      - name: sipTrunkId
        in: path
        description: Sip Trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: SIP trunk status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ExtendedSipTrunkStatusResponse'
              examples:
                Response example 1:
                  summary: Response example 1
                  value:
                    adminStatus: ENABLED
                    actionStatus:
                      status: SUCCESS
                    activeCalls: 100
                Response example 2:
                  summary: Response example 2
                  value:
                    adminStatus: DISABLED
                    actionStatus:
                      status: FAILED
                      reason: Invalid source IP.
                    activeCalls: 0
                Response example 3:
                  summary: Response example 3
                  value:
                    adminStatus: DISABLED
                    actionStatus:
                      status: RESET
                      reason: Not enough credits.
                    registrationStatus: UNREGISTERED
                    activeCalls: 0
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    post:
      tags:
      - channels
      summary: Set SIP trunk status
      description: Set a SIP trunk's status.
      operationId: set-sip-trunk-status
      parameters:
      - name: sipTrunkId
        in: path
        description: Sip Trunk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkStatusRequest'
            examples:
              Request example 1:
                summary: Request example 1
                value:
                  adminStatus: ENABLED
              Request example 2:
                summary: Request example 2
                value:
                  adminStatus: DISABLED
        required: true
      responses:
        '200':
          description: SIP trunk status set.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkStatusResponse'
              examples:
                Response example 1:
                  summary: Response example 1
                  value:
                    adminStatus: ENABLED
                Response example 2:
                  summary: Response example 2
                  value:
                    adminStatus: DISABLED
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/sip-trunks/service-addresses:
    get:
      tags:
      - channels
      summary: Get SIP trunk service addresses
      description: Get SIP trunk service addresses.
      operationId: get-sip-trunk-service-addresses
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkServiceAddressPage'
              examples:
                SIP trunk service address page response.:
                  summary: SIP trunk service address page response.
                  value:
                    results:
                    - id: abc-def-ghi
                      name: Location address name
                      street: Location address street
                      city: My city
                      postCode: '71000'
                      suite: '1030'
                      country:
                        name: Croatia
                        code: HRV
                      region:
                        name: Zagreb County
                        code: HR-01
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create SIP trunk service address
      description: Create a SIP trunk service address.
      operationId: create-sip-trunk-service-address
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest'
            examples:
              SIP trunk service address request:
                summary: SIP trunk service address request
                value:
                  name: Location address name
                  street: Location address street
                  city: My city
                  postCode: '71000'
                  suite: '1030'
                  countryCode: HRV
                  countryRegionCode: HR-01
        required: true
      responses:
        '201':
          description: SIP trunk service address created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: abc-def-ghi
                    name: Location address name
                    street: Location address street
                    city: My city
                    postCode: '71000'
                    suite: '1030'
                    country:
                      name: Croatia
                      code: HRV
                    region:
                      name: Zagreb County
                      code: HR-01
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/sip-trunks/service-addresses/{sipTrunkServiceAddressId}:
    get:
      tags:
      - channels
      summary: Get SIP trunk service address
      description: Get SIP trunk service address.
      operationId: get-sip-trunk-service-address
      parameters:
      - name: sipTrunkServiceAddressId
        in: path
        description: SIP trunk service address ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: abc-def-ghi
                    name: Location address name
                    street: Location address street
                    city: My city
                    postCode: '71000'
                    suite: '1030'
                    country:
                      name: Croatia
                      code: HRV
                    region:
                      name: Zagreb County
                      code: HR-01
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    put:
      tags:
      - channels
      summary: Update SIP trunk service address
      description: Update SIP trunk service address.
      operationId: update-sip-trunk-service-address
      parameters:
      - name: sipTrunkServiceAddressId
        in: path
        description: SIP trunk service address ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: abc-def-ghi
                    name: Location address name
                    street: Location address street
                    city: My city
                    postCode: '71000'
                    suite: '1030'
                    country:
                      name: Croatia
                      code: HRV
                    region:
                      name: Zagreb County
                      code: HR-01
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete SIP trunk service address
      description: Delete SIP trunk service address.
      operationId: delete-sip-trunk-service-address
      parameters:
      - name: sipTrunkServiceAddressId
        in: path
        description: SIP trunk service address ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: abc-def-ghi
                    name: Location address name
                    street: Location address street
                    city: My city
                    postCode: '71000'
                    suite: '1030'
                    country:
                      name: Croatia
                      code: HRV
                    region:
                      name: Zagreb County
                      code: HR-01
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/sip-trunks/service-addresses/countries:
    get:
      tags:
      - channels
      summary: Get countries
      description: Get countries with shortcodes you'd need for a SIP trunk address.
      operationId: get-countries
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - name: New Zealand
                    code: NZL
                  - name: Fiji
                    code: FJI
                  - name: Guadeloupe
                    code: GLP
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/sip-trunks/service-addresses/countries/regions:
    get:
      tags:
      - channels
      summary: Get regions
      description: Get regions with shortcodes you'd need for a SIP trunk address.
      operationId: get-regions
      parameters:
      - name: countryCode
        in: query
        description: Country code.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: HRV
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - name: Dubrovnik-Neretva County
                    code: HR-19
                    countryCode: HRV
                  - name: Međimurje County
                    code: HR-20
                    countryCode: HRV
                  - name: City of Zagreb
                    code: HR-21
                    countryCode: HRV
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/files:
    get:
      tags:
      - channels
      summary: Get files
      description: Get files with pagination. Maximum number of pages is 100.
      operationId: get-calls-files
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Upload audio file
      description: Upload an audio file. Uploaded files can be played on calls, dialogs or conferences. The file will be removed if it is not used for 90 days.
      operationId: upload-calls-audio-file
      requestBody:
        description: Audio file to be uploaded.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/files/{fileId}:
    get:
      tags:
      - channels
      summary: Get file
      description: Get a single file.
      operationId: get-calls-file
      parameters:
      - name: fileId
        in: path
        description: File ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete file
      description: Delete a file.
      operationId: delete-calls-file
      parameters:
      - name: fileId
        in: path
        description: File ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/calls:
    get:
      tags:
      - channels
      summary: Get calls recordings
      description: Get the recordings of calls with pagination.
      operationId: get-calls-recordings
      parameters:
      - name: callId
        in: query
        description: Call ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: entityId
        in: query
        description: Entity ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: endpointIdentifier
        in: query
        description: Endpoint identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790123456
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.134+0000
      - name: endTimeBefore
        in: query
        description: Date and time when the (last) call recording ended.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:35:45.154+0000
      - name: direction
        in: query
        description: Call direction.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        example: OUTBOUND
      - name: endpointType
        in: query
        description: Endpoint type.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
        example: WEBRTC
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallRecordingPage'
              examples:
                Call recording page response.:
                  summary: Call recording page response.
                  value:
                    results:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: PARTIALLY_FAILED
                      reason: Recording postprocessing failed
                    paging:
                      page: 0
                      size: 2
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/calls/{callId}:
    get:
      tags:
      - channels
      summary: Get call recordings
      description: Get the recordings for a single call.
      operationId: get-call-recordings
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
              examples:
                Call recording:
                  summary: Call recording
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: PHONE
                      phoneNumber: '41793026834'
                    direction: INBOUND
                    files:
                    - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    status: SUCCESSFUL
                Failed call recording:
                  summary: Failed call recording
                  value:
                    callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                    endpoint:
                      type: PHONE
                      phoneNumber: '41793026834'
                    direction: INBOUND
                    files:
                    - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    status: PARTIALLY_FAILED
                    reason: Recording postprocessing failed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete call recordings
      description: Delete the recordings for a single call.
      operationId: delete-call-recordings
      parameters:
      - name: callId
        in: path
        description: Call ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
              examples:
                Call recording:
                  summary: Call recording
                  value:
                    callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                    endpoint:
                      type: PHONE
                      phoneNumber: '41793026834'
                    direction: INBOUND
                    files:
                    - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    status: SUCCESSFUL
                Failed call recording:
                  summary: Failed call recording
                  value:
                    callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                    endpoint:
                      type: PHONE
                      phoneNumber: '41793026834'
                    direction: INBOUND
                    files:
                    - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    status: PARTIALLY_FAILED
                    reason: Recording postprocessing failed
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:delete
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/conferences:
    get:
      tags:
      - channels
      summary: Get conferences recordings
      description: Get the recordings of conferences with pagination.
      operationId: get-conferences-recordings
      parameters:
      - name: conferenceId
        in: query
        description: Conference ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: entityId
        in: query
        description: Entity ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: conferenceName
        in: query
        description: Conference name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Conference
      - name: callId
        in: query
        description: Filter all conference recordings where call ID was included in the recording.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callEndpointType
        in: query
        description: Filter all conference recordings where calls with endpoint type were included in the recording.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
        example: WEBRTC
      - name: callEndpointIdentifier
        in: query
        description: Filter all conference recordings where calls with endpoint identifier were included in the recording.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790123456
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) conference recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.134+0000
      - name: endTimeBefore
        in: query
        description: Date and time when the (last) conference recording ended.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:35:45.154+0000
      - name: composition
        in: query
        description: Flag indicating whether auto-compose feature was turned on for the recording.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceRecordingPage'
              examples:
                Conference recording page response.:
                  summary: Conference recording page response.
                  value:
                    results:
                    - conferenceId: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                      conferenceName: Example conference
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      composedFiles:
                      - id: 65f0b3d7c8b6a00001a2b3d5
                        name: example-recording.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: SFTP
                        sftpUploadStatus: UPLOADED
                        customData:
                          key1: value1
                          key2: value2
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                      - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/conferences/{conferenceId}:
    get:
      tags:
      - channels
      summary: Get conference recordings
      description: Get the recordings for a single conference.
      operationId: get-conference-recordings
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording'
              examples:
                Conference recording response:
                  summary: Conference recording response
                  value:
                    conferenceId: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    conferenceName: Example conference
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    composedFiles:
                    - id: 65f0b3d7c8b6a00001a2b3d5
                      name: example-recording.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: SFTP
                      sftpUploadStatus: UPLOADED
                      customData:
                        key1: value1
                        key2: value2
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete conference recordings
      description: Delete the recordings for a single conference.
      operationId: delete-conference-recordings
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording'
              examples:
                Conference recording response:
                  summary: Conference recording response
                  value:
                    conferenceId: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
                    conferenceName: Example conference
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    composedFiles:
                    - id: 65f0b3d7c8b6a00001a2b3d5
                      name: example-recording.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: SFTP
                      sftpUploadStatus: UPLOADED
                      customData:
                        key1: value1
                        key2: value2
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value: Bad request
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:delete
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/conferences/{conferenceId}/compose:
    post:
      tags:
      - channels
      summary: Compose conference recording on calls
      description: Compose conference recording on calls. All calls will be merged into a single audio or video file.
      operationId: compose-conference-recording
      parameters:
      - name: conferenceId
        in: path
        description: Conference ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/dialogs:
    get:
      tags:
      - channels
      summary: Get dialogs recordings
      description: Get the recordings of dialogs with pagination.
      operationId: get-dialogs-recordings
      parameters:
      - name: dialogId
        in: query
        description: Dialog ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callsConfigurationId
        in: query
        description: Calls Configuration ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: dc5942707c704551a00cd2ea
      - name: applicationId
        in: query
        description: Application ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 61c060db2675060027d8c7a6
      - name: entityId
        in: query
        description: Entity ID.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callId
        in: query
        description: Filter all dialog recordings where call ID was included in the recording.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 64d214c5-70b7-4ea6-b2a6-8334d1f34fb4
      - name: callEndpointType
        in: query
        description: Filter all dialog recordings where calls with endpoint type were included in the recording.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
        example: WEBRTC
      - name: callEndpointIdentifier
        in: query
        description: Filter all dialog recordings where calls with endpoint identifier were included in the recording.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 44790123456
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) dialog recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:25:45.134+0000
      - name: endTimeBefore
        in: query
        description: Date and time when the (last) dialog recording ended.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2022-05-01T14:35:45.154+0000
      - name: composition
        in: query
        description: Flag indicating whether auto-compose feature was turned on for the recording.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogRecordingPage'
              examples:
                Dialog recording page response.:
                  summary: Dialog recording page response.
                  value:
                    results:
                    - dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      composedFiles:
                      - id: 65f0b3d7c8b6a00001a2b3d5
                        name: example-recording.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                      - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                        endpoint:
                          type: PHONE
                          phoneNumber: '41793026834'
                        direction: INBOUND
                        files:
                        - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                          name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                          fileFormat: WAV
                          size: 67564
                          creationTime: 2026-01-15T12:00:00.150+0000
                          duration: 10
                          startTime: 2026-01-15T11:59:50.000+0000
                          endTime: 2026-01-15T12:00:00.000+0000
                          location: HOSTED
                          customData:
                            key1: value1
                            key2: value2
                        status: SUCCESSFUL
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/dialogs/{dialogId}:
    get:
      tags:
      - channels
      summary: Get dialog recordings
      description: Get the recordings for a single dialog.
      operationId: get-dialog-recordings
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording'
              examples:
                Dialog recording response:
                  summary: Dialog recording response
                  value:
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    composedFiles:
                    - id: 65f0b3d7c8b6a00001a2b3d5
                      name: example-recording.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete dialog recordings
      description: Delete the recordings for a single dialog.
      operationId: delete-dialog-recordings
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording'
              examples:
                Dialog recording response:
                  summary: Dialog recording response
                  value:
                    dialogId: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
                    platform:
                      applicationId: 61c060db2675060027d8c7a6
                    composedFiles:
                    - id: 65f0b3d7c8b6a00001a2b3d5
                      name: example-recording.wav
                      fileFormat: WAV
                      size: 67564
                      creationTime: 2026-01-15T12:00:00.150+0000
                      duration: 10
                      startTime: 2026-01-15T11:59:50.000+0000
                      endTime: 2026-01-15T12:00:00.000+0000
                      location: HOSTED
                      customData:
                        key1: value1
                        key2: value2
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-10b5a8d628a0
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
                    - callId: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
                      endpoint:
                        type: PHONE
                        phoneNumber: '41793026834'
                      direction: INBOUND
                      files:
                      - id: d8d84155-3831-43fb-91c9-10b5a8d628a0
                        name: d8d84155-3831-43fb-91c9-10b5a8d628a0_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        creationTime: 2026-01-15T12:00:00.150+0000
                        duration: 10
                        startTime: 2026-01-15T11:59:50.000+0000
                        endTime: 2026-01-15T12:00:00.000+0000
                        location: HOSTED
                        customData:
                          key1: value1
                          key2: value2
                      status: SUCCESSFUL
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:delete
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/dialogs/{dialogId}/compose:
    post:
      tags:
      - channels
      summary: Compose dialog recording on calls
      description: Compose dialog recording on calls. Both calls will be merged into a single audio or video file.
      operationId: compose-dialog-recording
      parameters:
      - name: dialogId
        in: path
        description: Dialog ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/recordings/files/{fileId}:
    get:
      tags:
      - channels
      summary: Download recording file
      description: Download a recording file.
      operationId: download-recording-file
      parameters:
      - name: fileId
        in: path
        description: File ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      - name: Range
        in: header
        description: Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: bytes=0-1023
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: File binary stream response
        '206':
          description: Partial content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: Partial file binary stream response
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '416':
          description: Requested range not satisfiable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: REQUESTED_RANGE_NOT_SATISFIABLE
                        text: Requested range is invalid.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete recording file
      description: Delete a single file from a call or conference recording. The call or conference recording metadata will still exist after deleting the file, but the file will not show up anymore in the file list of that call or conference recording.
      operationId: delete-recording-file
      parameters:
      - name: fileId
        in: path
        description: File ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
              examples:
                Recording file response:
                  summary: Recording file response
                  value:
                    id: 65f0b3d7c8b6a00001a2b3d5
                    name: 65f0b3d7c8b6a00001a2b3d5_1652725357412.wav
                    fileFormat: WAV
                    size: 67564
                    creationTime: 2026-01-15T12:00:00.150+0000
                    duration: 10
                    startTime: 2026-01-15T11:59:50.000+0000
                    endTime: 2026-01-15T12:00:00.000+0000
                    location: HOSTED
                    customData:
                      key1: value1
                      key2: value2
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:recording:delete
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/media-stream-configs:
    get:
      tags:
      - channels
      summary: Get media-stream configs
      description: Get media-stream configs.
      operationId: get-media-stream-configs
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.MediaStreamConfigPage'
              examples:
                Media stream config page response.:
                  summary: Media stream config page response.
                  value:
                    results:
                    - id: 63467c6e2885a5389ba11d80
                      type: MEDIA_STREAMING
                      name: Media-stream config
                      url: ws://example-web-socket.com:3001
                      audioEncoding: RAW
                    - id: 63467c6e2885a5389ba11d81
                      type: WEBSOCKET_ENDPOINT
                      name: Media-stream config
                      url: ws://example-web-socket.com:3001
                      sampleRate: '8000'
                    paging:
                      page: 0
                      size: 2
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create a media-stream configuration
      description: Create a media-stream configuration. For more details, see [documentation](https://www.infobip.com/docs/voice-and-video/calls#media-streaming-understanding-calls-api).
      operationId: create-media-stream-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest'
            examples:
              Media streaming config request:
                summary: Media streaming config request
                value:
                  type: MEDIA_STREAMING
                  name: Media-stream config
                  url: ws://example-web-socket.com:3001
                  securityConfig:
                    username: my-username
                    password: my-password
                    type: BASIC
                  audioEncoding: RAW
              WebSocket endpoint config request:
                summary: WebSocket endpoint config request
                value:
                  type: WEBSOCKET_ENDPOINT
                  name: Media-stream config
                  url: ws://example-web-socket.com:3001
                  sampleRate: '8000'
        required: true
      responses:
        '201':
          description: Media stream config created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse'
              examples:
                Media streaming config response:
                  summary: Media streaming config response
                  value:
                    id: 63467c6e2885a5389ba11d80
                    type: MEDIA_STREAMING
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    audioEncoding: RAW
                WebSocket endpoint config response:
                  summary: WebSocket endpoint config response
                  value:
                    id: 63467c6e2885a5389ba11d81
                    type: WEBSOCKET_ENDPOINT
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    sampleRate: '8000'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /calls/1/media-stream-configs/{mediaStreamConfigId}:
    get:
      tags:
      - channels
      summary: Get media-stream configuration
      description: Get a single media-stream configuration.
      operationId: get-media-stream-config
      parameters:
      - name: mediaStreamConfigId
        in: path
        description: Media-stream configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse'
              examples:
                Media streaming config response:
                  summary: Media streaming config response
                  value:
                    id: 63467c6e2885a5389ba11d80
                    type: MEDIA_STREAMING
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    audioEncoding: RAW
                WebSocket endpoint config response:
                  summary: WebSocket endpoint config response
                  value:
                    id: 63467c6e2885a5389ba11d81
                    type: WEBSOCKET_ENDPOINT
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    sampleRate: '8000'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update a media-stream configuration
      description: Update a media-stream configuration.
      operationId: update-media-stream-config
      parameters:
      - name: mediaStreamConfigId
        in: path
        description: Media-stream configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest'
            examples:
              Media streaming config request:
                summary: Media streaming config request
                value:
                  type: MEDIA_STREAMING
                  name: Media-stream config
                  url: ws://example-web-socket.com:3001
                  securityConfig:
                    username: my-username
                    password: my-password
                    type: BASIC
                  audioEncoding: RAW
              WebSocket endpoint config request:
                summary: WebSocket endpoint config request
                value:
                  type: WEBSOCKET_ENDPOINT
                  name: Media-stream config
                  url: ws://example-web-socket.com:3001
                  sampleRate: '8000'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse'
              examples:
                Media streaming config response:
                  summary: Media streaming config response
                  value:
                    id: 63467c6e2885a5389ba11d80
                    type: MEDIA_STREAMING
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    audioEncoding: RAW
                WebSocket endpoint config response:
                  summary: WebSocket endpoint config response
                  value:
                    id: 63467c6e2885a5389ba11d81
                    type: WEBSOCKET_ENDPOINT
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    sampleRate: '8000'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete a media-stream configuration
      description: Delete a media-stream configuration.
      operationId: delete-media-stream-config
      parameters:
      - name: mediaStreamConfigId
        in: path
        description: Media-stream configuration ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse'
              examples:
                Media streaming config response:
                  summary: Media streaming config response
                  value:
                    id: 63467c6e2885a5389ba11d80
                    type: MEDIA_STREAMING
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    audioEncoding: RAW
                WebSocket endpoint config response:
                  summary: WebSocket endpoint config response
                  value:
                    id: 63467c6e2885a5389ba11d81
                    type: WEBSOCKET_ENDPOINT
                    name: Media-stream config
                    url: ws://example-web-socket.com:3001
                    sampleRate: '8000'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks:
    post:
      tags:
      - channels
      summary: Create bulk of calls
      description: 'Create a bulk of outbound calls. Currently, only `PHONE` endpoints are supported.

        When retry options are specified, bulk calls are retried if they meet internal or client retry criteria.

        Client retry criteria are met when call reaches the end device and fails. Internal retry criteria are met when call fails before reaching the end device.'
      operationId: create-bulk
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkRequest'
            examples:
              Basic bulk request:
                summary: Basic bulk request
                value:
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
                  items:
                  - from: '41793026834'
                    callRequests:
                    - endpoint:
                        phoneNumber: '41792036727'
                        type: PHONE
                    - endpoint:
                        phoneNumber: '41792036728'
                        type: PHONE
                    - endpoint:
                        phoneNumber: '41792036729'
                        type: PHONE
              Advanced bulk request:
                summary: Advanced bulk request
                value:
                  bulkId: 46ab0413-448f-4153-ada9-b68b14242dc3
                  callsConfigurationId: dc5942707c704551a00cd2ea
                  platform:
                    applicationId: 61c060db2675060027d8c7a6
                  items:
                  - from: '41793026834'
                    callRequests:
                    - externalId: your-external-id-1
                      endpoint:
                        phoneNumber: '41792036727'
                        type: PHONE
                    - externalId: your-external-id-2
                      endpoint:
                        phoneNumber: '41792036728'
                        type: PHONE
                    - externalId: your-external-id-3
                      endpoint:
                        phoneNumber: '41792036729'
                        type: PHONE
                    recording:
                      recordingType: AUDIO
                    machineDetection:
                      enabled: true
                    maxDuration: 28000
                    connectTimeout: 30
                    callRate:
                      maxCalls: 10
                      timeUnit: MINUTES
                    validityPeriod: 60
                    retryOptions:
                      minWaitPeriod: 5
                      maxWaitPeriod: 10
                      maxAttempts: 5
                    schedulingOptions:
                      startTime: 2026-01-15T12:00:00.000+0000
                      callingTimeWindow:
                        from:
                          hour: 9
                          minute: 0
                        to:
                          hour: 17
                          minute: 0
                        days:
                        - MONDAY
                        - TUESDAY
                        - WEDNESDAY
                        - THURSDAY
                        - FRIDAY
                    customData:
                      key1: value1
                      key2: value2
        required: true
      responses:
        '201':
          description: Bulk created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkResponse'
              examples:
                Basic bulk request:
                  summary: Basic bulk request
                  value:
                    bulkId: 46ab0413-448f-4153-ada9-b68b14242dc3
                    calls:
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 266f8375-33d3-482f-a258-51e86b5ae9ac
                      externalId: your-external-id-1
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036727'
                        type: PHONE
                      status: PENDING
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 366f8375-33d3-482f-a258-51e86b5ae9ad
                      externalId: your-external-id-2
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036728'
                        type: PHONE
                      status: PENDING
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 466f8375-33d3-482f-a258-51e86b5ae9ae
                      externalId: your-external-id-3
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036729'
                        type: PHONE
                      status: PENDING
                Bulk Response:
                  summary: Bulk Response
                  value:
                    bulkId: 46ab0413-448f-4153-ada9-b68b14242dc3
                    calls:
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 266f8375-33d3-482f-a258-51e86b5ae9ac
                      externalId: your-external-id-1
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036727'
                        type: PHONE
                      status: PENDING
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 366f8375-33d3-482f-a258-51e86b5ae9ad
                      externalId: your-external-id-2
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036728'
                        type: PHONE
                      status: PENDING
                    - callsConfigurationId: dc5942707c704551a00cd2ea
                      platform:
                        applicationId: 61c060db2675060027d8c7a6
                      callId: 466f8375-33d3-482f-a258-51e86b5ae9ae
                      externalId: your-external-id-3
                      from: '41793026834'
                      endpoint:
                        phoneNumber: '41792036729'
                        type: PHONE
                      status: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Request is invalid.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Application not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:traffic:send
      x-throttling-info:
      - type: time
        numberOfRequests: 2000
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks/{bulkId}:
    get:
      tags:
      - channels
      summary: Get bulk status
      description: Get a single bulk status. Bulk has a status if it was created with scheduling options.
      operationId: get-bulk-status
      parameters:
      - name: bulkId
        in: path
        description: Bulk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks/{bulkId}/reschedule:
    post:
      tags:
      - channels
      summary: Reschedule
      description: Reschedule a bulk. Rescheduling is possible only if the bulk was created with scheduling options and has not started yet.
      operationId: reschedule-bulk
      parameters:
      - name: bulkId
        in: path
        description: Bulk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RescheduleRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:bulk:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks/{bulkId}/pause:
    post:
      tags:
      - channels
      summary: Pause
      description: Pause a bulk. Bulk can be paused if it is in progress and was created with scheduling options.
      operationId: pause-bulk
      parameters:
      - name: bulkId
        in: path
        description: Bulk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:bulk:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks/{bulkId}/resume:
    post:
      tags:
      - channels
      summary: Resume
      description: Resume a bulk. Bulk can be resumed if it is paused and was created with scheduling options.
      operationId: resume-bulk
      parameters:
      - name: bulkId
        in: path
        description: Bulk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:bulk:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /calls/1/bulks/{bulkId}/cancel:
    post:
      tags:
      - channels
      summary: Cancel
      description: Cancel a bulk. Bulk can be cancelled if it was created with scheduling options and has not finished yet.
      operationId: cancel-bulk
      parameters:
      - name: bulkId
        in: path
        description: Bulk ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Resource was not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calls:manage
      - calls:bulk:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /markuplanguage/1/create:
    post:
      tags:
      - channels
      summary: Create markup language call.
      description: Create a new markup language call which will be processed according to provided markup instructions.
      operationId: create-markup-language-call
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupRequest'
            examples:
              Minimal markup call:
                summary: Minimal markup call
                value:
                  callback:
                    url: https://example.com/cml/markup
                    errorUrl: https://example.com/cml/error
                    method: POST
                  endpoint:
                    phoneNumber: '41793026835'
                    type: PHONE
                  from: '41793026834'
              Markup call with notify URL and external ID:
                summary: Markup call with notify URL and external ID
                value:
                  callback:
                    url: https://example.com/cml/markup
                    errorUrl: https://example.com/cml/error
                    method: POST
                  endpoint:
                    phoneNumber: '41793026835'
                    type: PHONE
                  from: '41793026834'
                  externalId: call-external-id-123
                  notifyUrl: https://example.com/cml/notify
              Markup call with synchronous machine detection:
                summary: Markup call with synchronous machine detection
                value:
                  callback:
                    url: https://example.com/cml/markup
                    errorUrl: https://example.com/cml/error
                    method: POST
                  endpoint:
                    phoneNumber: '41793026835'
                    type: PHONE
                  from: '41793026834'
                  machineDetection:
                    detectionTime: 3.0
                    mode:
                      type: SYNC
              Markup call with asynchronous machine detection and message detection:
                summary: Markup call with asynchronous machine detection and message detection
                value:
                  callback:
                    url: https://example.com/cml/markup
                    errorUrl: https://example.com/cml/error
                    method: POST
                  endpoint:
                    phoneNumber: '41793026835'
                    type: PHONE
                  from: '41793026834'
                  machineDetection:
                    detectionTime: 3.0
                    mode:
                      asyncUrl: https://example.com/cml/amd
                      asyncUrlMethod: POST
                      type: ASYNC
                    messageDetection:
                      timeout: 30
        required: true
      responses:
        '201':
          description: Markup Language Call Successfully Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupResponse'
              examples:
                Minimal markup call response:
                  summary: Minimal markup call response
                  value:
                    callback:
                      url: https://example.com/cml/markup
                      errorUrl: https://example.com/cml/error
                      method: POST
                    endpoint:
                      phoneNumber: '41793026835'
                      type: PHONE
                    from: '41793026834'
                Markup call response with duration and external ID:
                  summary: Markup call response with duration and external ID
                  value:
                    callback:
                      url: https://example.com/cml/markup
                      errorUrl: https://example.com/cml/error
                      method: POST
                    endpoint:
                      phoneNumber: '41793026835'
                      type: PHONE
                    from: '41793026834'
                    externalId: call-external-id-123
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /markuplanguage/1/config:
    get:
      tags:
      - channels
      summary: Get markup language configurations
      description: Get existing markup language configurations with pagination.
      operationId: get-markup-language-config-list
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/526c8fd5dbec2ed6659284b76850ff4085b7915f78d3266fedb5e0b5300d882a.MarkupLanguageConfigResponsePage'
              examples:
                Markup language configuration response page example:
                  summary: Markup language configuration response page example
                  description: Example of a page of markup language configuration responses with different HTTP methods and URL setups.
                  value:
                    results:
                    - id: 123
                      name: BasicMarkupConfiguration
                      markupUrl: https://example.com/cml/markup
                      httpMethod: POST
                      createTime: '2024-01-15T10:30:00'
                      updateTime: '2024-01-15T10:30:00'
                    - id: 124
                      name: FullMarkupConfiguration
                      markupUrl: https://example.com/cml/markup
                      notifyUrl: https://example.com/cml/notify
                      errorUrl: https://example.com/cml/error
                      httpMethod: POST
                      createTime: '2024-02-10T09:00:00'
                      updateTime: '2024-06-20T14:00:00'
                    - id: 125
                      name: GetMethodMarkupConfiguration
                      markupUrl: https://example.com/cml/markup
                      httpMethod: GET
                      createTime: '2024-03-05T12:00:00'
                      updateTime: '2024-03-05T12:00:00'
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 3
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    post:
      tags:
      - channels
      summary: Create a markup language configuration
      description: Create a new markup language configuration.
      operationId: create-markup-language-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest'
            examples:
              Basic markup language configuration:
                summary: Basic markup language configuration
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  httpMethod: POST
              Full markup language configuration with notify and error URLs:
                summary: Full markup language configuration with notify and error URLs
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  notifyUrl: https://example.com/cml/notify
                  errorUrl: https://example.com/cml/error
                  httpMethod: POST
              Markup language configuration using GET HTTP method:
                summary: Markup language configuration using GET HTTP method
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  httpMethod: GET
        required: true
      responses:
        '201':
          description: Markup Language Configuration Successfully Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse'
              examples:
                Basic markup language configuration response:
                  summary: Basic markup language configuration response
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
                Full markup language configuration response with notify and error URLs:
                  summary: Full markup language configuration response with notify and error URLs
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    notifyUrl: https://example.com/cml/notify
                    errorUrl: https://example.com/cml/error
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-06-20T14:00:00'
                Markup language configuration response using GET HTTP method:
                  summary: Markup language configuration response using GET HTTP method
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: GET
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /markuplanguage/1/config/{configId}:
    get:
      tags:
      - channels
      summary: Get a markup language configuration
      description: Get an existing markup language configuration.
      operationId: get-markup-language-config
      parameters:
      - name: configId
        in: path
        description: Configuration identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse'
              examples:
                Basic markup language configuration response:
                  summary: Basic markup language configuration response
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
                Full markup language configuration response with notify and error URLs:
                  summary: Full markup language configuration response with notify and error URLs
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    notifyUrl: https://example.com/cml/notify
                    errorUrl: https://example.com/cml/error
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-06-20T14:00:00'
                Markup language configuration response using GET HTTP method:
                  summary: Markup language configuration response using GET HTTP method
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: GET
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    put:
      tags:
      - channels
      summary: Update a markup language configuration
      description: Update an already existing markup language configuration. Fields that are not sent in the request body will take default values and overwrite existing ones.
      operationId: update-markup-language-config
      parameters:
      - name: configId
        in: path
        description: Configuration identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 123
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest'
            examples:
              Basic markup language configuration:
                summary: Basic markup language configuration
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  httpMethod: POST
              Full markup language configuration with notify and error URLs:
                summary: Full markup language configuration with notify and error URLs
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  notifyUrl: https://example.com/cml/notify
                  errorUrl: https://example.com/cml/error
                  httpMethod: POST
              Markup language configuration using GET HTTP method:
                summary: Markup language configuration using GET HTTP method
                value:
                  name: UniqueMarkupConfiguration
                  markupUrl: https://example.com/cml/markup
                  httpMethod: GET
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse'
              examples:
                Basic markup language configuration response:
                  summary: Basic markup language configuration response
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
                Full markup language configuration response with notify and error URLs:
                  summary: Full markup language configuration response with notify and error URLs
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    notifyUrl: https://example.com/cml/notify
                    errorUrl: https://example.com/cml/error
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-06-20T14:00:00'
                Markup language configuration response using GET HTTP method:
                  summary: Markup language configuration response using GET HTTP method
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: GET
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete a markup language configuration
      description: Delete an existing markup language configuration.
      operationId: delete-markup-language-config
      parameters:
      - name: configId
        in: path
        description: Configuration identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 123
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse'
              examples:
                Basic markup language configuration response:
                  summary: Basic markup language configuration response
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
                Full markup language configuration response with notify and error URLs:
                  summary: Full markup language configuration response with notify and error URLs
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    notifyUrl: https://example.com/cml/notify
                    errorUrl: https://example.com/cml/error
                    httpMethod: POST
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-06-20T14:00:00'
                Markup language configuration response using GET HTTP method:
                  summary: Markup language configuration response using GET HTTP method
                  value:
                    id: 123
                    name: UniqueMarkupConfiguration
                    markupUrl: https://example.com/cml/markup
                    httpMethod: GET
                    createTime: '2024-01-15T10:30:00'
                    updateTime: '2024-01-15T10:30:00'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - markuplanguage:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /tts/3/single:
    post:
      tags:
      - channels
      summary: Send single voice message
      description: This method allows you to send single voice message to one or more destination addresses.
      externalDocs:
        description: Learn more about voice messages
        url: https://www.infobip.com/docs/voice-and-video/voice-messages
      operationId: send-single-voice-tts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest'
            examples:
              Single voice message with text:
                summary: Single voice message with text
                description: Single voice message with text
                value:
                  text: Test Voice message.
                  language: en
                  voice:
                    gender: female
                    name: Joanna
                  from: '41793026700'
                  to: '41793026727'
              Single voice message with audio file:
                summary: Single voice message with audio file
                description: Single voice message with audio file
                value:
                  audioFileUrl: https://www.example.com/audio/greeting.mp3
                  from: '41793026700'
                  to: '41793026727'
          application/xml:
            schema:
              $ref: '#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest'
            examples:
              Single voice message with text:
                summary: Single voice message with text
                description: Single voice message with text
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n    \n  <text>Test Voice message.</text>\n    \n  <language>en</language>\n    \n  <voice>\n        \n    <gender>female</gender>\n        \n    <name>Joanna</name>\n      \n  </voice>\n    \n  <from>41793026700</from>\n    \n  <to>41793026727</to>\n  \n</request>\n"
              Single voice message with audio file:
                summary: Single voice message with audio file
                description: Single voice message with audio file
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n    \n  <audioFileUrl>https://www.example.com/audio/greeting.mp3</audioFileUrl>\n    \n  <from>41793026700</from>\n    \n  <to>41793026727</to>\n  \n</request>\n"
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest'
            examples:
              Single voice message with text:
                summary: Single voice message with text
                description: Single voice message with text
                value: 'curl -L -g ''https://{baseUrl}/tts/3/single'' \

                  -H ''Authorization: {authorization}'' \

                  -H ''Content-Type: application/x-www-form-urlencoded'' \

                  --data-urlencode ''from=442032864231'' \

                  --data-urlencode ''to=41793026727'' \

                  --data-urlencode ''language=en'' \

                  --data-urlencode ''text=Test Voice message'' \

                  --data-urlencode ''voice.gender=female'' \

                  --data-urlencode ''voice.name=Joanna''

                  '
              Single voice message with audio file:
                summary: Single voice message with audio file
                description: Single voice message with audio file
                value: 'curl -L -g ''https://{baseUrl}/tts/3/single'' \

                  -H ''Authorization: {authorization}'' \

                  -H ''Content-Type: application/x-www-form-urlencoded'' \

                  --data-urlencode ''from=442032864231'' \

                  --data-urlencode ''to=41793026727'' \

                  --data-urlencode ''audioFileUrl=https://www.example.com/audio/greeting.mp3''

                  '
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value:
                    bulkId: 4fda521a-c680-470d-b134-83d468f7ac80
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
            application/xml:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceResponse>\n  <bulkId>4fda521a-c680-470d-b134-83d468f7ac80</bulkId>\n  <messages>\n    <message>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message accepted, pending for delivery.</description>\n      </status>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n    </message>\n  </messages>\n</voiceResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2000
        numberOfTimeUnits: 0
        timeUnit: s
  /tts/3/multi:
    post:
      tags:
      - channels
      summary: Send multiple voice messages
      description: This method allows you to send multiple voice messages to one or more destination addresses.
      externalDocs:
        description: Learn more about voice messages
        url: https://www.infobip.com/docs/voice-and-video/voice-messages
      operationId: send-multiple-voice-tts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest'
            examples:
              Multiple voice messages with text:
                summary: Multiple voice messages with text
                value:
                  messages:
                  - text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    from: '41793026700'
                    to:
                    - '41793026727'
                    - '41793026731'
              Multiple voice messages with audio file:
                summary: Multiple voice messages with audio file
                value:
                  messages:
                  - audioFileUrl: https://www.example.com/audio/greeting.mp3
                    from: '41793026700'
                    to:
                    - '41793026727'
                    - '41793026731'
          application/xml:
            schema:
              $ref: '#/components/schemas/faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest'
            examples:
              Multiple voice messages with text:
                summary: Multiple voice messages with text
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <from>41793026700</from>\n      <to>\n        <to>41793026727</to>\n        <to>41793026731</to>\n      </to>\n    </messages>\n  </messages>\n</request>\n"
              Multiple voice messages with audio file:
                summary: Multiple voice messages with audio file
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <audioFileUrl>https://www.example.com/audio/greeting.mp3</audioFileUrl>\n      <from>41793026700</from>\n      <to>\n        <to>41793026727</to>\n        <to>41793026731</to>\n      </to>\n    </messages>\n  </messages>\n</request>\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value:
                    bulkId: 4fda521a-c680-470d-b134-83d468f7ac80
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
            application/xml:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceResponse>\n  <bulkId>4fda521a-c680-470d-b134-83d468f7ac80</bulkId>\n  <messages>\n    <message>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message accepted, pending for delivery.</description>\n      </status>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n    </message>\n  </messages>\n</voiceResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2000
        numberOfTimeUnits: 0
        timeUnit: s
  /tts/3/advanced:
    post:
      tags:
      - channels
      summary: Send advanced voice message
      description: This method allows you to send advanced voice messages to one or more destination addresses.
      externalDocs:
        description: Learn more about voice messages
        url: https://www.infobip.com/docs/voice-and-video/voice-messages
      operationId: send-advanced-voice-tts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest'
            examples:
              Advanced voice message request example:
                summary: Advanced voice message request example
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                      messageId: MESSAGE-ID-123-xyz
                    - to: '41793026731'
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    speechRate: 1.0
                    notifyUrl: https://www.example.com/voice/notify
                    notifyContentType: application/json
                    callbackData: DLR callback data
                    validityPeriod: 720
                    sendAt: 2023-08-10T07:36:42.005+0000
                    repeatDtmf: '123'
                    maxDtmf: 1
                    ringTimeout: 45
                    dtmfTimeout: 10
                    callTimeout: 130
                    callTransfers:
                    - callTransferMaxDuration: 45
                      equals: '2'
                      transferTo: '41793026700'
                      if: DTMF
                    - callTransferMaxDuration: 45
                      transferTo: '41793026701'
                      if: anyDtmf
                    pause: 3
                    retry:
                      minPeriod: 1
                      maxPeriod: 5
                      maxCount: 5
                    sendingSpeed:
                      speed: 5
                      timeUnit: minute
                    machineDetection: continue
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
              OTP message example:
                summary: OTP message example
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Hello, your code is,, 5,, 8,, 4,, 2
                    language: en
                    voice:
                      gender: female
                      name: Joanna
              Audio file message:
                summary: Audio file message
                value:
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    audioFileUrl: https://www.example.com/audio/greeting.mp3
              Machine detection with hangup:
                summary: Machine detection with hangup
                value:
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    machineDetection: hangup
              DTMF input collection with call transfer:
                summary: DTMF input collection with call transfer
                value:
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    repeatDtmf: '123'
                    maxDtmf: 3
                    ringTimeout: 30
                    dtmfTimeout: 10
                    callTimeout: 120
                    callTransfers:
                    - callTransferMaxDuration: 60
                      equals: '1'
                      transferTo: '41793026700'
                      if: DTMF
                    - callTransferMaxDuration: 60
                      transferTo: '41793026701'
                      if: anyDtmf
              Campaign broadcast with sending speed limit:
                summary: Campaign broadcast with sending speed limit
                value:
                  bulkId: BULK-ID-CAMPAIGN-001
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Hello! You have an incoming call from our support team. Please hold while we connect you.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    sendingSpeed:
                      speed: 50
                      timeUnit: minute
              Retry on failed delivery with scheduled time window:
                summary: Retry on failed delivery with scheduled time window
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    retry:
                      minPeriod: 5
                      maxPeriod: 30
                      maxCount: 3
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      from:
                        hour: 8
                        minute: 0
                      to:
                        hour: 20
                        minute: 0
              Callback data with delivery report:
                summary: Callback data with delivery report
                value:
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    callbackData: DLR callback data
              Bulk request with multiple messages:
                summary: Bulk request with multiple messages
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                      messageId: MSG-001
                    text: Connecting your first call.
                    language: en
                  - from: '41793026700'
                    destinations:
                    - to: '41793026731'
                      messageId: MSG-002
                    text: Connecting your second call.
                    language: en
              German language with male voice:
                summary: German language with male voice
                value:
                  messages:
                  - from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    text: Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.
                    language: de
                    voice:
                      gender: male
                      name: Hans
          application/xml:
            schema:
              $ref: '#/components/schemas/329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest'
            examples:
              Advanced voice message request example:
                summary: Advanced voice message request example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n          <messageId>MESSAGE-ID-123-xyz</messageId>\n        </destinations>\n        <destinations>\n          <to>41793026731</to>\n        </destinations>\n      </destinations>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <speechRate>1.0</speechRate>\n      <notifyUrl>https://www.example.com/voice/notify</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <callbackData>DLR callback data</callbackData>\n      <validityPeriod>720</validityPeriod>\n      <sendAt>2023-08-10T07:36:42.005+0000</sendAt>\n      <repeatDtmf>123</repeatDtmf>\n      <maxDtmf>1</maxDtmf>\n      <ringTimeout>45</ringTimeout>\n      <dtmfTimeout>10</dtmfTimeout>\n      <callTimeout>130</callTimeout>\n      <callTransfers>\n        <callTransfers>\n          <callTransferMaxDuration>45</callTransferMaxDuration>\n          <equals>2</equals>\n          <transferTo>41793026700</transferTo>\n          <if>DTMF</if>\n        </callTransfers>\n        <callTransfers>\n          <callTransferMaxDuration>45</callTransferMaxDuration>\n          <transferTo>41793026701</transferTo>\n          <if>anyDtmf</if>\n        </callTransfers>\n      </callTransfers>\n      <pause>3</pause>\n      <retry>\n        <minPeriod>1</minPeriod>\n        <maxPeriod>5</maxPeriod>\n        <maxCount>5</maxCount>\n      </retry>\n      <sendingSpeed>\n        <speed>5</speed>\n        <timeUnit>minute</timeUnit>\n      </sendingSpeed>\n      <machineDetection>continue</machineDetection>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n          <days>SATURDAY</days>\n          <days>SUNDAY</days>\n        </days>\n        <from>\n          <hour>6</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>15</hour>\n          <minute>30</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              OTP message example:
                summary: OTP message example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Hello, your code is,, 5,, 8,, 4,, 2</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n    </messages>\n  </messages>\n</request>\n"
              Audio file message:
                summary: Audio file message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <audioFileUrl>https://www.example.com/audio/greeting.mp3</audioFileUrl>\n    </messages>\n  </messages>\n</request>\n"
              Machine detection with hangup:
                summary: Machine detection with hangup
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <machineDetection>hangup</machineDetection>\n    </messages>\n  </messages>\n</request>\n"
              DTMF input collection with call transfer:
                summary: DTMF input collection with call transfer
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <repeatDtmf>123</repeatDtmf>\n      <maxDtmf>3</maxDtmf>\n      <ringTimeout>30</ringTimeout>\n      <dtmfTimeout>10</dtmfTimeout>\n      <callTimeout>120</callTimeout>\n      <callTransfers>\n        <callTransfers>\n          <callTransferMaxDuration>60</callTransferMaxDuration>\n          <equals>1</equals>\n          <transferTo>41793026700</transferTo>\n          <if>DTMF</if>\n        </callTransfers>\n        <callTransfers>\n          <callTransferMaxDuration>60</callTransferMaxDuration>\n          <transferTo>41793026701</transferTo>\n          <if>anyDtmf</if>\n        </callTransfers>\n      </callTransfers>\n    </messages>\n  </messages>\n</request>\n"
              Campaign broadcast with sending speed limit:
                summary: Campaign broadcast with sending speed limit
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-CAMPAIGN-001</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Hello! You have an incoming call from our support team. Please hold while we connect you.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <sendingSpeed>\n        <speed>50</speed>\n        <timeUnit>minute</timeUnit>\n      </sendingSpeed>\n    </messages>\n  </messages>\n</request>\n"
              Retry on failed delivery with scheduled time window:
                summary: Retry on failed delivery with scheduled time window
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <retry>\n        <minPeriod>5</minPeriod>\n        <maxPeriod>30</maxPeriod>\n        <maxCount>3</maxCount>\n      </retry>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n        </days>\n        <from>\n          <hour>8</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>20</hour>\n          <minute>0</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              Callback data with delivery report:
                summary: Callback data with delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <callbackData>DLR callback data</callbackData>\n    </messages>\n  </messages>\n</request>\n"
              Bulk request with multiple messages:
                summary: Bulk request with multiple messages
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n          <messageId>MSG-001</messageId>\n        </destinations>\n      </destinations>\n      <text>Connecting your first call.</text>\n      <language>en</language>\n    </messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026731</to>\n          <messageId>MSG-002</messageId>\n        </destinations>\n      </destinations>\n      <text>Connecting your second call.</text>\n      <language>en</language>\n    </messages>\n  </messages>\n</request>\n"
              German language with male voice:
                summary: German language with male voice
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinations>\n        <destinations>\n          <to>41793026727</to>\n        </destinations>\n      </destinations>\n      <text>Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.</text>\n      <language>de</language>\n      <voice>\n        <gender>male</gender>\n        <name>Hans</name>\n      </voice>\n    </messages>\n  </messages>\n</request>\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value:
                    bulkId: 4fda521a-c680-470d-b134-83d468f7ac80
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
            application/xml:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceResponse>\n  <bulkId>4fda521a-c680-470d-b134-83d468f7ac80</bulkId>\n  <messages>\n    <message>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message accepted, pending for delivery.</description>\n      </status>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n    </message>\n  </messages>\n</voiceResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2000
        numberOfTimeUnits: 0
        timeUnit: s
  /tts/3/voices/{language}:
    get:
      tags:
      - channels
      summary: Get Voices
      description: This method allows you to retrieve all voices for the given language
      operationId: get-voices
      parameters:
      - name: language
        in: path
        description: Represents the language abbreviation. (e.g. `en`). You can find the list of supported languages in corresponding section for sending voice message.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: includeNeural
        in: query
        description: 'Indicates whether neural voices should be included in the response.

          If set to `false` or omitted, only standard voices will be included in the response.

          If set to `true`, both standard and neural voices will be included in the response.

          '
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    voices:
                    - name: Benjamin
                      gender: male
                      supplier: Microsoft
                      ssmlSupported: false
                      isDefault: false
                      isNeural: false
                    - name: Ivy
                      gender: female
                      supplier: Amazon
                      ssmlSupported: true
                      isDefault: false
                      isNeural: false
                    - name: Joanna
                      gender: female
                      supplier: Amazon
                      ssmlSupported: true
                      isDefault: true
                      isNeural: false
                    - name: Joey
                      gender: male
                      supplier: Amazon
                      ssmlSupported: true
                      isDefault: false
                      isNeural: false
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><GetVoicesResponse>\n    \n  <voices>\n        \n    <voices>\n            \n      <name>Benjamin</name>\n            \n      <gender>male</gender>\n            \n      <supplier>Microsoft</supplier>\n            \n      <ssmlSupported>false</ssmlSupported>\n            \n      <isDefault>false</isDefault>\n            \n      <isNeural>false</isNeural>\n          \n    </voices>\n        \n    <voices>\n            \n      <name>Ivy</name>\n            \n      <gender>female</gender>\n            \n      <supplier>Amazon</supplier>\n            \n      <ssmlSupported>true</ssmlSupported>\n            \n      <isDefault>false</isDefault>\n            \n      <isNeural>false</isNeural>\n          \n    </voices>\n        \n    <voices>\n            \n      <name>Joanna</name>\n            \n      <gender>female</gender>\n            \n      <supplier>Amazon</supplier>\n            \n      <ssmlSupported>true</ssmlSupported>\n            \n      <isDefault>true</isDefault>\n            \n      <isNeural>false</isNeural>\n          \n    </voices>\n        \n    <voices>\n            \n      <name>Joey</name>\n            \n      <gender>male</gender>\n            \n      <supplier>Amazon</supplier>\n            \n      <ssmlSupported>true</ssmlSupported>\n            \n      <isDefault>false</isDefault>\n            \n      <isNeural>false</isNeural>\n          \n    </voices>\n      \n  </voices>\n  \n</GetVoicesResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice-message:manage
      - voice-message:message:send
      - message:send
  /tts/3/bulks:
    get:
      tags:
      - channels
      summary: Get sent bulks
      description: This method will return information about the scheduled time for a unique bulk message. Canceling and rescheduling are supported only when the voice message request contains at least one message and the message bulkId is unique.
      operationId: get-sent-bulks
      parameters:
      - name: bulkId
        in: query
        description: Unique ID of the bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse'
              examples:
                Bulk response:
                  summary: Bulk response
                  value:
                    bulkId: 5028e2d42f19-42f1-4656-351e-a42c191e5fd2
                    sendAt: 2023-09-26T14:07:35.000+0000
            application/xml:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse'
              examples:
                Bulk response:
                  summary: Bulk response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkResponse>\n  <bulkId>5028e2d42f19-42f1-4656-351e-a42c191e5fd2</bulkId>\n  <sendAt>2023-09-26T14:07:35.000+0000</sendAt>\n</BulkResponse>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
    put:
      tags:
      - channels
      summary: Reschedule sent bulk
      description: This method allows you to reschedule scheduled TTS bulk. Messages scheduled with the sendAt or Sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Rescheduling is only possible if the bulk status is PAUSED.
      operationId: reschedule-sent-bulk
      parameters:
      - name: bulkId
        in: query
        description: Unique ID of the bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest'
            examples:
              Reschedule bulk status request:
                summary: Reschedule bulk status request
                value:
                  sendAt: 2023-09-26T14:07:35.000+0000
          application/xml:
            schema:
              $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest'
            examples:
              Reschedule bulk status request:
                summary: Reschedule bulk status request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkRequest>\n  <sendAt>2023-09-26T14:07:35.000+0000</sendAt>\n</BulkRequest>\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse'
              examples:
                Bulk response:
                  summary: Bulk response
                  value:
                    bulkId: 5028e2d42f19-42f1-4656-351e-a42c191e5fd2
                    sendAt: 2023-09-26T14:07:35.000+0000
            application/xml:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse'
              examples:
                Bulk response:
                  summary: Bulk response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkResponse>\n  <bulkId>5028e2d42f19-42f1-4656-351e-a42c191e5fd2</bulkId>\n  <sendAt>2023-09-26T14:07:35.000+0000</sendAt>\n</BulkResponse>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
  /tts/3/bulks/status:
    get:
      tags:
      - channels
      summary: Get sent bulk's status
      description: This method allows you to get status of scheduled TTS bulk.
      operationId: get-sent-bulks-status
      parameters:
      - name: bulkId
        in: query
        description: Unique ID of the bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse'
              examples:
                Bulk status response:
                  summary: Bulk status response
                  value:
                    bulkId: 5028e2d42f19-42f1-4656-351e-a42c191e5fd2
                    status: PENDING
            application/xml:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse'
              examples:
                Bulk status response:
                  summary: Bulk status response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkStatusResponse>\n  <bulkId>5028e2d42f19-42f1-4656-351e-a42c191e5fd2</bulkId>\n  <status>PENDING</status>\n</BulkStatusResponse>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
    put:
      tags:
      - channels
      summary: Manage sent bulk's status
      description: This method allows you to manage statuses of scheduled TTS bulk. Messages scheduled with the sendAt or sending speed parameter can be paused, resumed or canceled by changing the message status, or rescheduled using the bulkId parameter as an identifier. Only voice messages that were not already sent can be canceled.
      operationId: manage-sent-bulks-status
      parameters:
      - name: bulkId
        in: query
        description: Unique ID of the bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest'
            examples:
              Bulk status request:
                summary: Bulk status request
                value:
                  status: PENDING
          application/xml:
            schema:
              $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest'
            examples:
              Bulk status request:
                summary: Bulk status request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkStatusRequest>\n  <status>PENDING</status>\n</BulkStatusRequest>\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse'
              examples:
                Bulk status response:
                  summary: Bulk status response
                  value:
                    bulkId: 5028e2d42f19-42f1-4656-351e-a42c191e5fd2
                    status: PENDING
            application/xml:
              schema:
                $ref: '#/components/schemas/a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse'
              examples:
                Bulk status response:
                  summary: Bulk status response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><BulkStatusResponse>\n  <bulkId>5028e2d42f19-42f1-4656-351e-a42c191e5fd2</bulkId>\n  <status>PENDING</status>\n</BulkStatusResponse>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
            application/xml:
              schema:
                $ref: '#/components/schemas/1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException'
              examples:
                Too many requests response:
                  summary: Too many requests response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - voice-message:message:send
      - voice-message:manage
  /voice/ivr/1/scenarios:
    get:
      tags:
      - channels
      summary: Search Voice IVR Scenarios
      description: This method allows you to search Voice IVR Scenarios by name. To get a list of all IVR Scenarios, make a request without any parameters.
      operationId: search-voice-ivr-scenarios
      parameters:
      - name: page
        in: query
        description: Page number you want to see. Default is 1.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          minimum: 1
      - name: pageSize
        in: query
        description: Size of the page you want to see. Default is 50.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          maximum: 50
          minimum: 1
      - name: name
        in: query
        description: The name to search by.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: label
        in: query
        description: The label of scenario to search by.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: lastUsageDateSince
        in: query
        description: 'Lower limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
      - name: lastUsageDateUntil
        in: query
        description: 'Upper limit of last usage date in `yyyy-MM-dd` format. Note: For scenarios where `lastUsageDate` is `null`, filtering matches `createTime`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SearchResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: E83E787CF2613450157ADA3476171E3F
                    name: My Scenario
                    description: Scenario to send a message
                    createTime: 2023-09-14T15:13:36.735+0000
                    updateTime: 2023-09-14T16:20:32.432+0000
                    lastUsageDate: '2023-09-14'
                    script:
                    - sendSms:
                        text: Hello
                        to: ${to}
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
    post:
      tags:
      - channels
      summary: Create Voice IVR Scenarios
      description: This method allows you to create a Voice IVR Scenario. The IVR scenario will be removed if not used for more than 1 year.
      operationId: create-a-voice-ivr-scenario
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest'
            examples:
              Call API:
                summary: Call API
                description: Call API
                value:
                  name: Call API
                  description: Perform a POST request to provided URL with headers and payload.
                  script:
                  - request: https://example.com/api/12345
                    options:
                      method: POST
                      headers:
                        content-type: application/json
                      body:
                        payload: ${to} finished the IVR.
              Call Api to send collected DTMFs:
                summary: Call Api to send collected DTMFs
                description: Call Api to send collected DTMFs
                value:
                  name: Call Api
                  description: Collect users input and submits it with a POST request to a url.
                  script:
                  - say: Hello, please press 1 if you wish to subscribe to our newsletter.
                  - collectInto: myCollectedVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                  - request: https://example.com/subscription
                    options:
                      method: POST
                      headers:
                        custom-header: header-value
                      body:
                        shouldSubscribe: ${myCollectedVariable}
                  - if: ${myCollectedVariable == 1}
                    then:
                    - say: You subscribed successfully.
              Call Api with response:
                summary: Call Api with response
                description: Call Api with response
                value:
                  name: Call Api with collected response
                  description: Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.
                  script:
                  - say: Hello, please press 1 if you wish to subscribe to our newsletter.
                  - collectInto: myCollectedVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                  - request: https://example.com/subscription
                    options:
                      method: POST
                      headers:
                        custom-header: header-value
                      body:
                        shouldSubscribe: ${myCollectedVariable}
                      collectResponse: true
                  - say: ${responseText}
              Capture:
                summary: Capture
                description: Capture
                value:
                  name: Capture speech
                  description: Capture users speech and branch the call based on the spoken words.
                  script:
                  - say: Say yes or no
                  - capture: myVar
                    timeout: 3
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - 'yes'
                      - 'no'
                  - if: ${myVar == 'yes'}
                    then:
                    - say: Ok. I will send you more details
                    else: []
                  - if: ${myVar == 'no'}
                    then:
                    - say: Thank you for listening.
                    else: []
                  - if: ${myVar == ''}
                    then:
                    - say: I did not understand
                    else: []
                  - hangup
              Capture speech or digit:
                summary: Capture speech or digit
                description: Capture speech or digit
                value:
                  name: Capture speech or digit
                  description: Capture speech or digit
                  script:
                  - say: Say discount or press 1 to get discount. Say exit or press 0 to exit.
                  - capture: myVar
                    timeout: 5
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - discount
                      - exit
                    dtmfOptions:
                      maxInputLength: 1
                  - if: ${myVar == 'discount' || myVar == '1'}
                    then:
                    - say: You will get discount
                    else:
                    - if: ${myVar == 'exit' || myVar == '0'}
                      then:
                      - say: Goodbye
                      else:
                      - say: I did not understand
                  - hangup
              Collect dtmf and branch call execution based on input:
                summary: Collect dtmf and branch call execution based on input
                description: Collect dtmf and branch call execution based on input
                value:
                  name: Capture speech or digit
                  description: Capture speech or digit
                  script:
                  - say: Say discount or press 1 to get discount. Say exit or press 0 to exit.
                  - capture: myVar
                    timeout: 5
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - discount
                      - exit
                    dtmfOptions:
                      maxInputLength: 1
                  - if: ${myVar == 'discount' || myVar == '1'}
                    then:
                    - say: You will get discount
                    else:
                    - if: ${myVar == 'exit' || myVar == '0'}
                      then:
                      - say: Goodbye
                      else:
                      - say: I did not understand
                  - hangup
              Collect dtmf with default branch:
                summary: Collect dtmf with default branch
                description: Collect dtmf with default branch
                value:
                  name: Collect dtmf with default branch
                  description: Based on the collected input, the execution is branched into 2 branches. If wrong digit is pressed or nothing is pressed, execute default branch.
                  script:
                  - say: Hello. Press 1 or 2. Or press any other digit or do not press anything for default message to be played.
                  - collectInto: myVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                      sendToReports: ALWAYS
                      mappedValues:
                        '1': pressed one
                        '2': pressed two
                  - case:
                      '1':
                      - say: You have pressed 1.
                      '2':
                      - say: You have pressed 2.
                      __default:
                      - say: You pressed some other key or didn't press anything
                    switch: myVariable
              Dial:
                summary: Dial
                description: Dial
                value:
                  name: Dial to a destination
                  description: Dial to a provided destination to bridge original call with the dialed call.
                  script:
                  - dial: '41793026731'
                    options:
                      senderId: '123456789'
                      maxCallDuration: 10
              Dial from a variable:
                summary: Dial from a variable
                description: Dial from a variable
                value:
                  name: Dial to a number resolved from a variable
                  description: Dial to a number resolved from a variable
                  script:
                  - dial: ${numberToDial}
                    options:
                      senderId: '123456789'
                      maxCallDuration: 10
              Dial to Many - parallel:
                summary: Dial to Many - parallel
                description: Dial to Many - parallel
                value:
                  name: Dial to Many - parallel
                  description: Dial multiple destinations in parallel. This means that all destinations will receive the call at the same time, but only the first who answers is connected.
                  script:
                  - dialToMany:
                    - number: '41793026741'
                    - number: '41793026801'
                    - number: '41793026653'
                    - number: '41793026142'
                    options:
                      parallel: true
                      senderId: '4179302614112'
                      maxCallDuration: 60
              Dial to Many - sequential:
                summary: Dial to Many - sequential
                description: Dial to Many - sequential
                value:
                  name: Dial to Many - example
                  description: Dial multiple destinations in sequential. This means that the provided destinations will be called one by one as defined in the action below. First who answers will be connected, and the next ones will not be called.
                  script:
                  - dialToMany:
                    - number: '41793026741'
                    - number: '41793026801'
                    - number: '41793026653'
                    - number: '41793026142'
                    options:
                      parallel: false
                      senderId: '4179302614112'
                      maxCallDuration: 60
              Dial to Conversations:
                summary: Dial to Conversations
                description: Dial to Conversations
                value:
                  name: Dial to Conversations
                  description: Dial to Conversations.
                  script:
                  - dialToConversations:
                      options:
                        tags:
                        - tag name 1
                        - tag name 2
              Dial to Conversations with tagIdentifierType:
                summary: Dial to Conversations with tagIdentifierType
                description: Dial to Conversations with tagIdentifierType
                value:
                  name: Dial to Conversations with tagIdentifierType
                  description: Dial to Conversations with tagIdentifierType.
                  script:
                  - dialToConversations:
                      options:
                        tagIdentifierType: ID
                        tags:
                        - aaaaaaaa-bbbb-cccc-1111-222222222222
                        - bbbbbbbb-cccc-eeee-2222-333333333333
              For-Each:
                summary: For-Each
                description: For-Each
                value:
                  name: For-Each
                  description: Use For-each to perform any action for each of provided values.
                  script:
                  - for-each: city
                    in: New York,Los Angeles,Boston
                    do:
                    - say: Hello from ${city}
              Goto to repeat a message:
                summary: Goto to repeat a message
                description: Goto to repeat a message
                value:
                  name: Goto to repeat say action n times
                  description: Repeat a message n times and then hang up
                  script:
                  - actionId: 1
                    say: Your password is 1, 2, 3, 4
                  - if: ${countVar == 3}
                    then:
                    - say: I will hangup now
                  - goTo: 1
                    options:
                      gotoLimit: 3
                      countVariable: countVar
                  - hangup
              Goto limit reached:
                summary: Goto limit reached
                description: Goto limit reached
                value:
                  name: Goto limit reached
                  description: Goto limit reached
                  script:
                  - say: Hello world
                    actionId: 1
                  - if: ${count_var == 3}
                    then:
                    - say: I will hangup now
                  - goTo: 1
                    options:
                      gotoLimit: 3
                      countVariable: count_var
                  - hangup
              If-Then-Else:
                summary: If-Then-Else
                description: If-Then-Else
                value:
                  name: If-Then-Else
                  description: If-Then-Else
                  script:
                  - if: ${number > 0}
                    then:
                    - say: Number ${number} is a positive number.
                    else:
                    - say: Number ${number} is a non-positive number.
              Machine detection with advanced options:
                summary: Machine detection with advanced options
                description: Machine detection with advanced options
                value:
                  description: Advanced machine detection
                  name: Advanced machine detection
                  script:
                  - answeringMachineDetection: true
                    options:
                      waitEndOfMessageDetection: ALWAYS
                      endOfMessageDetectionTimeout: 30
                    onDetecting:
                    - say: Thank you for using our services. We’re excited to reward your loyalty with free concert tickets.
                    onMachineDetected:
                    - say: It seems we've reached your voicemail. Please visit our website to learn more about the free tickets.
                    - hangup
                    onTimeout:
                    - hangup
                  - say: Please enter your preferred concert date. For example, to enter March 1st, press 0 1 0 3. Thank you!
                  - collectInto: concertDate
                    options:
                      maxInputLength: 8
                  - hangup
              Machine detection with if-then-else:
                summary: Machine detection with if-then-else
                description: Machine detection with if-then-else
                value:
                  name: Machine detection if-then-else
                  description: This example uses machine detection with if-else to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.
                  script:
                  - machineDetection
                  - if: ${machineAnswered == true}
                    then:
                    - hangup
                    else:
                    - say: Hello human.
              Machine detection with switch-case:
                summary: Machine detection with switch-case
                description: Machine detection with switch-case
                value:
                  name: Machine detection with switch-case
                  description: This example uses machine detection with switch-case to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.
                  script:
                  - machineDetection
                  - case:
                      'true':
                      - hangup
                      __default:
                      - say: Hello. Human has answered the call.
                    switch: machineAnswered
              Pause:
                summary: Pause
                description: Pause
                value:
                  name: Pause
                  description: Create a pause of 2 seconds, for example between 2 say actions.
                  script:
                  - say: Hello, saying something before I make a pause of 2 seconds.
                  - pause: 2
                  - say: Phew, that felt like forever.
              Play from url:
                summary: Play from url
                description: Play from url
                value:
                  name: Play from url
                  description: Play from url
                  script:
                  - playFromUrl: https://www.example.com/voice/sound.mp3
              Play from Recording where recording was in a previous call:
                summary: Play from Recording where recording was in a previous call
                description: Play from Recording where recording was in a previous call
                value:
                  name: Play From Recording where recording was in a previous call
                  description: Play the recording of a previous call. All you have to do is to provide the recording id.
                  script:
                  - playFromRecording: recordingId
              Play from uploaded file:
                summary: Play from uploaded file
                description: Play from uploaded file
                value:
                  name: Play from uploaded file
                  description: Play the file uploaded through IVR upload API.
                  script:
                  - playFromUpload: f75ff9ca-20ce-47b7-ab0c-8adcb9725bb0
                    options:
                      loopCount: 3
              Play TTY:
                summary: Play TTY
                description: Play TTY
                value:
                  name: Play TTY test
                  description: TTY text output using Baudot tones
                  script:
                  - playTty: Welcome to TTY system
                  - hangup
              Play TTY with collect:
                summary: Play TTY with collect
                description: Play TTY with collect
                value:
                  name: Play TTY with collect
                  description: Play TTY action combined with Collect to gather user input
                  script:
                  - playTty: Enter your PIN
                  - collectInto: pin
                    options:
                      maxInputLength: 4
                  - hangup
              Record:
                summary: Record
                description: Record
                value:
                  name: Record
                  description: Record users call
                  script:
                  - record: 10
                    options:
                      escapeDigits: 123*
                      beep: true
                      maxSilence: 3
                      identifier: ${varName}
              Record & play from recording:
                summary: Record & play from recording
                description: Record & play from recording
                value:
                  name: Record & play from recording
                  description: Record a voice mail and play the recording back to the user.
                  script:
                  - say: After this message, we will record you for 10 seconds and play back the recording to you. Please speak after the beep sound.
                  - record: 10
                    options:
                      beep: true
                      identifier: recordVariable
                      escapeDigits: '1'
                      maxSilence: 3
                  - playFromRecording: recordVariable
              Repeat-While:
                summary: Repeat-While
                description: Repeat-While
                value:
                  name: Repeat-While
                  description: Repeat-While
                  script:
                  - setVariable: i
                    value: '1'
                  - repeat:
                    - setVariable: i
                      value: ${i + 1}
                    - playFromUrl: http://www.example.com/file.wav
                    while: ${i < 4}
                  - hangup
              Say:
                summary: Say
                description: Say
                value:
                  name: Say
                  description: Say
                  script:
                  - say: Hello. You have successfully used a Say Action in IVR.
              Say with custom voice options:
                summary: Say with custom voice options
                description: Say with custom voice options
                value:
                  name: Say with custom voice options
                  description: Say with custom voice options
                  script:
                  - say: Hello. You have successfully used a Say Action in IVR with custom voice options.
                    options:
                      speechRate: 2
                      language: en
                      voice:
                        name: Joanna
                        gender: FEMALE
              Say with variables:
                summary: Say with variables
                description: Say with variables
                value:
                  name: Say with variables
                  description: Say example with variables
                  script:
                  - say: Hello ${userNameVariable}. You have successfully used a Say Action in IVR with a variable.
              Say with a pause in between words:
                summary: Say with a pause in between words
                description: Say with a pause in between words
                value:
                  name: Say with a pause in between words
                  description: Say with a pause in between words
                  script:
                  - say: Hello ,, You have successfully used a Say Action in IVR with a pause.
              Set Variable:
                summary: Set Variable
                description: Set Variable
                value:
                  name: Set Variable
                  description: Set Variable
                  script:
                  - say: DTMFs will be collected now
                  - collectInto: dtmf
                  - switch: dtmf
                    case:
                      '1':
                      - say: You pressed 1
                      '2':
                      - say: You pressed 2
                      __default:
                      - setVariable: dtmf
                        value: '1'
                      - say: You did not press 1 nor 2. Setting DTMF variable to 1.
                  - hangup
              Send SMS:
                summary: Send SMS
                description: Send SMS
                value:
                  name: Send SMS
                  description: Send SMS
                  script:
                  - sendSms:
                      text: Hello
                      from: InfoSMS
                      to: ${to}
              Switch-Case:
                summary: Switch-Case
                description: Switch-Case
                value:
                  name: Switch-Case
                  description: Switch-Case
                  script:
                  - switch: myVariable
                    case:
                      '1':
                      - dial: '41793026731'
                      '2':
                      - playFromUrl: https://www.example.com/voice/advanced
                      '3':
                      - request: https://example.com/api/12345
                        options:
                          method: POST
                          headers:
                            content-type: application/json
                          body:
                            payload: ${to} finished the IVR.
                      '4':
                      - request: https://example.com/api/12345
                        options:
                          method: GET
                          collectResponse: true
                      '5':
                      - request: https://example.com/api/12345
                        options:
                          method: PUT
                          headers:
                            content-type: application/xml
                            accept: application/xml
                          body: <request><payload>${to} finished the IVR.</payload></request>
                          collectResponse: true
                      __default:
                      - say: Dear Customer, you pressed wrong number. Please, try again.
                      - collectInto: myVariable
                        options:
                          maxInputLength: 1
              'Use case: Checking order':
                summary: 'Use case: Checking order'
                description: 'Use case: Checking order'
                value:
                  name: 'Use case: Checking order'
                  description: Checking order
                  script:
                  - say: Welcome to Acme Co Delivery. To track your package, please enter your 5 digit your tracking number.
                  - collectInto: code
                    options:
                      maxInputLength: 5
                  - request: https://example.com/api/12345
                    options:
                      method: POST
                      headers:
                        content-type: application/json
                      body:
                        code: ${code}
                      collectResponse: true
                  - say: responseMessage
                  - say: If you have any questions or need to reschedule the delivery, press 1 to speak with an agent.
                  - collectInto: satisfiedAnswer
                  - switch: satisfiedAnswer
                    case:
                      '1':
                      - dial: '41793026731'
                  - hangup
              'Use case: Scheduling appointment':
                summary: 'Use case: Scheduling appointment'
                description: 'Use case: Scheduling appointment'
                value:
                  name: 'Use case: Scheduling appointment'
                  description: Scheduling appointment
                  script:
                  - say: Dear client, we would like to schedule an appointment on 14.10. Available time is 10:00 am, 11 am and 2:00 pm. Please press 1 for 10 am, 2 for 11 or 3 for a 2 pm meeting. If non of the above suits you, we will send new message suggesting different time frame.
                  - collectInto: scheduleTime
                  - switch: scheduleTime
                    case:
                      '1':
                      - say: Thank you. Your appointment is scheduled for 10 am.
                      '2':
                      - say: Thank you. Your appointment is scheduled for 11 am.
                      '3':
                      - say: Thank you. Your appointment is scheduled for 2 pm.
                      __default:
                      - say: Thank you  We will suggest another time slot once it’s available.
                      - hangup
                  - say: Thank you. Your appointment is scheduled.
                  - hangup
              While-Do:
                summary: While-Do
                description: While-Do
                value:
                  name: While-Do
                  description: While-Do
                  script:
                  - setVariable: i
                    value: '1'
                  - while: ${i < 4}
                    do:
                    - playFromUrl: http://www.example.com/file${i}.wav
                    - setVariable: i
                      value: ${i + 1}
                  - hangup
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: E83E787CF2613450157ADA3476171E3F
                    name: My Scenario
                    description: Scenario to send a message
                    createTime: 2023-09-14T15:13:36.735+0000
                    script:
                    - sendSms:
                        text: Hello
                        to: ${to}
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
  /voice/ivr/1/scenarios/{id}:
    get:
      tags:
      - channels
      summary: Get a Voice IVR Scenario
      description: This method allows you to get a Voice IVR Scenario.
      operationId: get-a-voice-ivr-scenario
      parameters:
      - name: id
        in: path
        description: Scenario identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: E83E787CF2613450157ADA3476171E3F
                    name: My Scenario
                    description: Scenario to send a message
                    createTime: 2023-09-14T15:13:36.735+0000
                    updateTime: 2023-09-14T16:20:32.432+0000
                    lastUsageDate: '2023-09-14'
                    script:
                    - sendSms:
                        text: Hello
                        to: ${to}
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
    put:
      tags:
      - channels
      summary: Update Voice IVR Scenarios
      description: This method allows you to update a Voice IVR Scenario. Changes may take up to 10 minutes to apply.
      operationId: update-voice-ivr-scenario
      parameters:
      - name: id
        in: path
        description: Scenario identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest'
            examples:
              Call API:
                summary: Call API
                description: Call API
                value:
                  name: Call API
                  description: Perform a POST request to provided URL with headers and payload.
                  script:
                  - request: https://example.com/api/12345
                    options:
                      method: POST
                      headers:
                        content-type: application/json
                      body:
                        payload: ${to} finished the IVR.
              Call Api to send collected DTMFs:
                summary: Call Api to send collected DTMFs
                description: Call Api to send collected DTMFs
                value:
                  name: Call Api
                  description: Collect users input and submits it with a POST request to a url.
                  script:
                  - say: Hello, please press 1 if you wish to subscribe to our newsletter.
                  - collectInto: myCollectedVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                  - request: https://example.com/subscription
                    options:
                      method: POST
                      headers:
                        custom-header: header-value
                      body:
                        shouldSubscribe: ${myCollectedVariable}
                  - if: ${myCollectedVariable == 1}
                    then:
                    - say: You subscribed successfully.
              Call Api with response:
                summary: Call Api with response
                description: Call Api with response
                value:
                  name: Call Api with collected response
                  description: Collect users input and submit it with a POST request to a url, and play the response back to the user. Let's assume the response is a simple JSON object that has only one field with a key called 'responseText' and value defined by the clients API.
                  script:
                  - say: Hello, please press 1 if you wish to subscribe to our newsletter.
                  - collectInto: myCollectedVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                  - request: https://example.com/subscription
                    options:
                      method: POST
                      headers:
                        custom-header: header-value
                      body:
                        shouldSubscribe: ${myCollectedVariable}
                      collectResponse: true
                  - say: ${responseText}
              Capture:
                summary: Capture
                description: Capture
                value:
                  name: Capture speech
                  description: Capture users speech and branch the call based on the spoken words.
                  script:
                  - say: Say yes or no
                  - capture: myVar
                    timeout: 3
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - 'yes'
                      - 'no'
                  - if: ${myVar == 'yes'}
                    then:
                    - say: Ok. I will send you more details
                    else: []
                  - if: ${myVar == 'no'}
                    then:
                    - say: Thank you for listening.
                    else: []
                  - if: ${myVar == ''}
                    then:
                    - say: I did not understand
                    else: []
                  - hangup
              Capture speech or digit:
                summary: Capture speech or digit
                description: Capture speech or digit
                value:
                  name: Capture speech or digit
                  description: Capture speech or digit
                  script:
                  - say: Say discount or press 1 to get discount. Say exit or press 0 to exit.
                  - capture: myVar
                    timeout: 5
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - discount
                      - exit
                    dtmfOptions:
                      maxInputLength: 1
                  - if: ${myVar == 'discount' || myVar == '1'}
                    then:
                    - say: You will get discount
                    else:
                    - if: ${myVar == 'exit' || myVar == '0'}
                      then:
                      - say: Goodbye
                      else:
                      - say: I did not understand
                  - hangup
              Collect dtmf and branch call execution based on input:
                summary: Collect dtmf and branch call execution based on input
                description: Collect dtmf and branch call execution based on input
                value:
                  name: Capture speech or digit
                  description: Capture speech or digit
                  script:
                  - say: Say discount or press 1 to get discount. Say exit or press 0 to exit.
                  - capture: myVar
                    timeout: 5
                    speechOptions:
                      language: en-US
                      maxSilence: 2
                      keyPhrases:
                      - discount
                      - exit
                    dtmfOptions:
                      maxInputLength: 1
                  - if: ${myVar == 'discount' || myVar == '1'}
                    then:
                    - say: You will get discount
                    else:
                    - if: ${myVar == 'exit' || myVar == '0'}
                      then:
                      - say: Goodbye
                      else:
                      - say: I did not understand
                  - hangup
              Collect dtmf with default branch:
                summary: Collect dtmf with default branch
                description: Collect dtmf with default branch
                value:
                  name: Collect dtmf with default branch
                  description: Based on the collected input, the execution is branched into 2 branches. If wrong digit is pressed or nothing is pressed, execute default branch.
                  script:
                  - say: Hello. Press 1 or 2. Or press any other digit or do not press anything for default message to be played.
                  - collectInto: myVariable
                    options:
                      maxInputLength: 1
                      timeout: 5
                      sendToReports: ALWAYS
                      mappedValues:
                        '1': pressed one
                        '2': pressed two
                  - case:
                      '1':
                      - say: You have pressed 1.
                      '2':
                      - say: You have pressed 2.
                      __default:
                      - say: You pressed some other key or didn't press anything
                    switch: myVariable
              Dial:
                summary: Dial
                description: Dial
                value:
                  name: Dial to a destination
                  description: Dial to a provided destination to bridge original call with the dialed call.
                  script:
                  - dial: '41793026731'
                    options:
                      senderId: '123456789'
                      maxCallDuration: 10
              Dial from a variable:
                summary: Dial from a variable
                description: Dial from a variable
                value:
                  name: Dial to a number resolved from a variable
                  description: Dial to a number resolved from a variable
                  script:
                  - dial: ${numberToDial}
                    options:
                      senderId: '123456789'
                      maxCallDuration: 10
              Dial to Many - parallel:
                summary: Dial to Many - parallel
                description: Dial to Many - parallel
                value:
                  name: Dial to Many - parallel
                  description: Dial multiple destinations in parallel. This means that all destinations will receive the call at the same time, but only the first who answers is connected.
                  script:
                  - dialToMany:
                    - number: '41793026741'
                    - number: '41793026801'
                    - number: '41793026653'
                    - number: '41793026142'
                    options:
                      parallel: true
                      senderId: '4179302614112'
                      maxCallDuration: 60
              Dial to Many - sequential:
                summary: Dial to Many - sequential
                description: Dial to Many - sequential
                value:
                  name: Dial to Many - example
                  description: Dial multiple destinations in sequential. This means that the provided destinations will be called one by one as defined in the action below. First who answers will be connected, and the next ones will not be called.
                  script:
                  - dialToMany:
                    - number: '41793026741'
                    - number: '41793026801'
                    - number: '41793026653'
                    - number: '41793026142'
                    options:
                      parallel: false
                      senderId: '4179302614112'
                      maxCallDuration: 60
              Dial to Conversations:
                summary: Dial to Conversations
                description: Dial to Conversations
                value:
                  name: Dial to Conversations
                  description: Dial to Conversations.
                  script:
                  - dialToConversations:
                      options:
                        tags:
                        - tag name 1
                        - tag name 2
              Dial to Conversations with tagIdentifierType:
                summary: Dial to Conversations with tagIdentifierType
                description: Dial to Conversations with tagIdentifierType
                value:
                  name: Dial to Conversations with tagIdentifierType
                  description: Dial to Conversations with tagIdentifierType.
                  script:
                  - dialToConversations:
                      options:
                        tagIdentifierType: ID
                        tags:
                        - aaaaaaaa-bbbb-cccc-1111-222222222222
                        - bbbbbbbb-cccc-eeee-2222-333333333333
              For-Each:
                summary: For-Each
                description: For-Each
                value:
                  name: For-Each
                  description: Use For-each to perform any action for each of provided values.
                  script:
                  - for-each: city
                    in: New York,Los Angeles,Boston
                    do:
                    - say: Hello from ${city}
              Goto to repeat a message:
                summary: Goto to repeat a message
                description: Goto to repeat a message
                value:
                  name: Goto to repeat say action n times
                  description: Repeat a message n times and then hang up
                  script:
                  - actionId: 1
                    say: Your password is 1, 2, 3, 4
                  - if: ${countVar == 3}
                    then:
                    - say: I will hangup now
                  - goTo: 1
                    options:
                      gotoLimit: 3
                      countVariable: countVar
                  - hangup
              Goto limit reached:
                summary: Goto limit reached
                description: Goto limit reached
                value:
                  name: Goto limit reached
                  description: Goto limit reached
                  script:
                  - say: Hello world
                    actionId: 1
                  - if: ${count_var == 3}
                    then:
                    - say: I will hangup now
                  - goTo: 1
                    options:
                      gotoLimit: 3
                      countVariable: count_var
                  - hangup
              If-Then-Else:
                summary: If-Then-Else
                description: If-Then-Else
                value:
                  name: If-Then-Else
                  description: If-Then-Else
                  script:
                  - if: ${number > 0}
                    then:
                    - say: Number ${number} is a positive number.
                    else:
                    - say: Number ${number} is a non-positive number.
              Machine detection with advanced options:
                summary: Machine detection with advanced options
                description: Machine detection with advanced options
                value:
                  description: Advanced machine detection
                  name: Advanced machine detection
                  script:
                  - answeringMachineDetection: true
                    options:
                      waitEndOfMessageDetection: ALWAYS
                      endOfMessageDetectionTimeout: 30
                    onDetecting:
                    - say: Thank you for using our services. We’re excited to reward your loyalty with free concert tickets.
                    onMachineDetected:
                    - say: It seems we've reached your voicemail. Please visit our website to learn more about the free tickets.
                    - hangup
                    onTimeout:
                    - hangup
                  - say: Please enter your preferred concert date. For example, to enter March 1st, press 0 1 0 3. Thank you!
                  - collectInto: concertDate
                    options:
                      maxInputLength: 8
                  - hangup
              Machine detection with if-then-else:
                summary: Machine detection with if-then-else
                description: Machine detection with if-then-else
                value:
                  name: Machine detection if-then-else
                  description: This example uses machine detection with if-else to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.
                  script:
                  - machineDetection
                  - if: ${machineAnswered == true}
                    then:
                    - hangup
                    else:
                    - say: Hello human.
              Machine detection with switch-case:
                summary: Machine detection with switch-case
                description: Machine detection with switch-case
                value:
                  name: Machine detection with switch-case
                  description: This example uses machine detection with switch-case to detect if answering machine has answered the call, and based on that information branches the execution of the IVR scenario.
                  script:
                  - machineDetection
                  - case:
                      'true':
                      - hangup
                      __default:
                      - say: Hello. Human has answered the call.
                    switch: machineAnswered
              Pause:
                summary: Pause
                description: Pause
                value:
                  name: Pause
                  description: Create a pause of 2 seconds, for example between 2 say actions.
                  script:
                  - say: Hello, saying something before I make a pause of 2 seconds.
                  - pause: 2
                  - say: Phew, that felt like forever.
              Play from url:
                summary: Play from url
                description: Play from url
                value:
                  name: Play from url
                  description: Play from url
                  script:
                  - playFromUrl: https://www.example.com/voice/sound.mp3
              Play from Recording where recording was in a previous call:
                summary: Play from Recording where recording was in a previous call
                description: Play from Recording where recording was in a previous call
                value:
                  name: Play From Recording where recording was in a previous call
                  description: Play the recording of a previous call. All you have to do is to provide the recording id.
                  script:
                  - playFromRecording: recordingId
              Play from uploaded file:
                summary: Play from uploaded file
                description: Play from uploaded file
                value:
                  name: Play from uploaded file
                  description: Play the file uploaded through IVR upload API.
                  script:
                  - playFromUpload: f75ff9ca-20ce-47b7-ab0c-8adcb9725bb0
                    options:
                      loopCount: 3
              Play TTY:
                summary: Play TTY
                description: Play TTY
                value:
                  name: Play TTY test
                  description: TTY text output using Baudot tones
                  script:
                  - playTty: Welcome to TTY system
                  - hangup
              Play TTY with collect:
                summary: Play TTY with collect
                description: Play TTY with collect
                value:
                  name: Play TTY with collect
                  description: Play TTY action combined with Collect to gather user input
                  script:
                  - playTty: Enter your PIN
                  - collectInto: pin
                    options:
                      maxInputLength: 4
                  - hangup
              Record:
                summary: Record
                description: Record
                value:
                  name: Record
                  description: Record users call
                  script:
                  - record: 10
                    options:
                      escapeDigits: 123*
                      beep: true
                      maxSilence: 3
                      identifier: ${varName}
              Record & play from recording:
                summary: Record & play from recording
                description: Record & play from recording
                value:
                  name: Record & play from recording
                  description: Record a voice mail and play the recording back to the user.
                  script:
                  - say: After this message, we will record you for 10 seconds and play back the recording to you. Please speak after the beep sound.
                  - record: 10
                    options:
                      beep: true
                      identifier: recordVariable
                      escapeDigits: '1'
                      maxSilence: 3
                  - playFromRecording: recordVariable
              Repeat-While:
                summary: Repeat-While
                description: Repeat-While
                value:
                  name: Repeat-While
                  description: Repeat-While
                  script:
                  - setVariable: i
                    value: '1'
                  - repeat:
                    - setVariable: i
                      value: ${i + 1}
                    - playFromUrl: http://www.example.com/file.wav
                    while: ${i < 4}
                  - hangup
              Say:
                summary: Say
                description: Say
                value:
                  name: Say
                  description: Say
                  script:
                  - say: Hello. You have successfully used a Say Action in IVR.
              Say with custom voice options:
                summary: Say with custom voice options
                description: Say with custom voice options
                value:
                  name: Say with custom voice options
                  description: Say with custom voice options
                  script:
                  - say: Hello. You have successfully used a Say Action in IVR with custom voice options.
                    options:
                      speechRate: 2
                      language: en
                      voice:
                        name: Joanna
                        gender: FEMALE
              Say with variables:
                summary: Say with variables
                description: Say with variables
                value:
                  name: Say with variables
                  description: Say example with variables
                  script:
                  - say: Hello ${userNameVariable}. You have successfully used a Say Action in IVR with a variable.
              Say with a pause in between words:
                summary: Say with a pause in between words
                description: Say with a pause in between words
                value:
                  name: Say with a pause in between words
                  description: Say with a pause in between words
                  script:
                  - say: Hello ,, You have successfully used a Say Action in IVR with a pause.
              Set Variable:
                summary: Set Variable
                description: Set Variable
                value:
                  name: Set Variable
                  description: Set Variable
                  script:
                  - say: DTMFs will be collected now
                  - collectInto: dtmf
                  - switch: dtmf
                    case:
                      '1':
                      - say: You pressed 1
                      '2':
                      - say: You pressed 2
                      __default:
                      - setVariable: dtmf
                        value: '1'
                      - say: You did not press 1 nor 2. Setting DTMF variable to 1.
                  - hangup
              Send SMS:
                summary: Send SMS
                description: Send SMS
                value:
                  name: Send SMS
                  description: Send SMS
                  script:
                  - sendSms:
                      text: Hello
                      from: InfoSMS
                      to: ${to}
              Switch-Case:
                summary: Switch-Case
                description: Switch-Case
                value:
                  name: Switch-Case
                  description: Switch-Case
                  script:
                  - switch: myVariable
                    case:
                      '1':
                      - dial: '41793026731'
                      '2':
                      - playFromUrl: https://www.example.com/voice/advanced
                      '3':
                      - request: https://example.com/api/12345
                        options:
                          method: POST
                          headers:
                            content-type: application/json
                          body:
                            payload: ${to} finished the IVR.
                      '4':
                      - request: https://example.com/api/12345
                        options:
                          method: GET
                          collectResponse: true
                      '5':
                      - request: https://example.com/api/12345
                        options:
                          method: PUT
                          headers:
                            content-type: application/xml
                            accept: application/xml
                          body: <request><payload>${to} finished the IVR.</payload></request>
                          collectResponse: true
                      __default:
                      - say: Dear Customer, you pressed wrong number. Please, try again.
                      - collectInto: myVariable
                        options:
                          maxInputLength: 1
              'Use case: Checking order':
                summary: 'Use case: Checking order'
                description: 'Use case: Checking order'
                value:
                  name: 'Use case: Checking order'
                  description: Checking order
                  script:
                  - say: Welcome to Acme Co Delivery. To track your package, please enter your 5 digit your tracking number.
                  - collectInto: code
                    options:
                      maxInputLength: 5
                  - request: https://example.com/api/12345
                    options:
                      method: POST
                      headers:
                        content-type: application/json
                      body:
                        code: ${code}
                      collectResponse: true
                  - say: responseMessage
                  - say: If you have any questions or need to reschedule the delivery, press 1 to speak with an agent.
                  - collectInto: satisfiedAnswer
                  - switch: satisfiedAnswer
                    case:
                      '1':
                      - dial: '41793026731'
                  - hangup
              'Use case: Scheduling appointment':
                summary: 'Use case: Scheduling appointment'
                description: 'Use case: Scheduling appointment'
                value:
                  name: 'Use case: Scheduling appointment'
                  description: Scheduling appointment
                  script:
                  - say: Dear client, we would like to schedule an appointment on 14.10. Available time is 10:00 am, 11 am and 2:00 pm. Please press 1 for 10 am, 2 for 11 or 3 for a 2 pm meeting. If non of the above suits you, we will send new message suggesting different time frame.
                  - collectInto: scheduleTime
                  - switch: scheduleTime
                    case:
                      '1':
                      - say: Thank you. Your appointment is scheduled for 10 am.
                      '2':
                      - say: Thank you. Your appointment is scheduled for 11 am.
                      '3':
                      - say: Thank you. Your appointment is scheduled for 2 pm.
                      __default:
                      - say: Thank you  We will suggest another time slot once it’s available.
                      - hangup
                  - say: Thank you. Your appointment is scheduled.
                  - hangup
              While-Do:
                summary: While-Do
                description: While-Do
                value:
                  name: While-Do
                  description: While-Do
                  script:
                  - setVariable: i
                    value: '1'
                  - while: ${i < 4}
                    do:
                    - playFromUrl: http://www.example.com/file${i}.wav
                    - setVariable: i
                      value: ${i + 1}
                  - hangup
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: E83E787CF2613450157ADA3476171E3F
                    name: My Scenario
                    description: Scenario to send a message
                    createTime: 2023-09-14T15:13:36.735+0000
                    updateTime: 2023-09-14T16:20:32.432+0000
                    lastUsageDate: '2023-09-14'
                    script:
                    - sendSms:
                        text: Hello
                        to: ${to}
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
    delete:
      tags:
      - channels
      summary: Delete Voice IVR Scenarios
      description: This method allows you to delete a Voice IVR Scenario.
      operationId: delete-a-voice-ivr-scenario
      parameters:
      - name: id
        in: path
        description: Scenario identifier (for example E83E787CF2613450157ADA3476171E3F).
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful response
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
  /voice/ivr/1/messages:
    post:
      tags:
      - channels
      summary: Launch IVR Scenario
      description: This method allows you to start an outbound IVR toward a multiple destinations.
      operationId: send-voice-messages-with-an-ivr-scenario
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - scenarioId: 6298AA7707903A4ED680B436929681AD
                    from: '41793026700'
                    destinations:
                    - to: '41793026727'
                    - to: '41793026731'
                    notifyUrl: https://www.example.com/voice/advanced
                    notifyContentType: application/json
                    callbackData: DLR callback data
                    validityPeriod: 720
                    sendAt: 2023-10-03T12:21:00.632+0000
                    retry:
                      minPeriod: 1
                      maxPeriod: 5
                      maxCount: 5
                    record: false
                    deliveryTimeWindow:
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
          application/xml:
            schema:
              $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest'
            examples:
              Request example:
                summary: Request example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n    \n  <bulkId>BULK-ID-123-xyz</bulkId>\n    \n  <messages>\n        \n    <messages>\n            \n      <scenarioId>6298AA7707903A4ED680B436929681AD</scenarioId>\n            \n      <from>41793026700</from>\n            \n      <destinations>\n                \n        <destinations>\n                    \n          <to>41793026727</to>\n                  \n        </destinations>\n                \n        <destinations>\n                    \n          <to>41793026731</to>\n                  \n        </destinations>\n              \n      </destinations>\n            \n      <notifyUrl>https://www.example.com/voice/advanced</notifyUrl>\n            \n      <notifyContentType>application/json</notifyContentType>\n            \n      <callbackData>DLR callback data</callbackData>\n            \n      <validityPeriod>720</validityPeriod>\n            \n      <sendAt>2023-10-03T12:21:00.632+0000</sendAt>\n            \n      <retry>\n                \n        <minPeriod>1</minPeriod>\n                \n        <maxPeriod>5</maxPeriod>\n                \n        <maxCount>5</maxCount>\n              \n      </retry>\n            \n      <record>false</record>\n            \n      <deliveryTimeWindow>\n                \n        <from>\n                    \n          <hour>6</hour>\n                    \n          <minute>0</minute>\n                  \n        </from>\n                \n        <to>\n                    \n          <hour>15</hour>\n                    \n          <minute>30</minute>\n                  \n        </to>\n                \n        <days>\n                    \n          <days>MONDAY</days>\n                    \n          <days>TUESDAY</days>\n                    \n          <days>WEDNESDAY</days>\n                    \n          <days>THURSDAY</days>\n                    \n          <days>FRIDAY</days>\n                    \n          <days>SATURDAY</days>\n                    \n          <days>SUNDAY</days>\n                  \n        </days>\n              \n      </deliveryTimeWindow>\n          \n    </messages>\n      \n  </messages>\n  \n</request>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    bulkId: 5028e2d42f19-42f1-4656-351e-a42c191e5fd2
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 4242f196ba50-a356-2f91-831c4aa55f351ed2
                    - to: '41793026731'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 5f35f896ba50-a356-43a4-91cd81b85f8c689
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceResponse>\n    \n  <bulkId>5028e2d42f19-42f1-4656-351e-a42c191e5fd2</bulkId>\n    \n  <messages>\n        \n    <message>\n            \n      <to>41793026727</to>\n            \n      <status>\n                \n        <groupId>1</groupId>\n                \n        <groupName>PENDING</groupName>\n                \n        <id>26</id>\n                \n        <name>PENDING_ACCEPTED</name>\n                \n        <description>Message accepted, pending for delivery.</description>\n              \n      </status>\n            \n      <messageId>4242f196ba50-a356-2f91-831c4aa55f351ed2</messageId>\n          \n    </message>\n        \n    <message>\n            \n      <to>41793026731</to>\n            \n      <status>\n                \n        <groupId>1</groupId>\n                \n        <groupName>PENDING</groupName>\n                \n        <id>26</id>\n                \n        <name>PENDING_ACCEPTED</name>\n                \n        <description>Message accepted, pending for delivery.</description>\n              \n      </status>\n            \n      <messageId>5f35f896ba50-a356-43a4-91cd81b85f8c689</messageId>\n          \n    </message>\n      \n  </messages>\n  \n</voiceResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:message:send
      - message:send
  /voice/ivr/1/files:
    get:
      tags:
      - channels
      summary: Search Voice IVR Recorded Files
      description: This method allows you to search Voice IVR Recorded Audio Files.
      operationId: search-voice-ivr-recorded-files
      parameters:
      - name: page
        in: query
        description: Page number you want to see.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: pageSize
        in: query
        description: Size of the page you want to see.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: messageId
        in: query
        description: The message ID to search by.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: number
        in: query
        description: The called phone number to search by.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    files:
                    - messageId: 453e161a-fe4f-4f3c-80c0-ab520de9a969
                      from: '442032864231'
                      to: '38712345678'
                      scenarioId: C9CE33CF130511D8E333C1260BABA309
                      groupId: '#/script/1'
                      url: /voice/ivr/1/files/3C67336FA555A606C85FA9637906A6AB98436B7AFC65D857A416F6521D39F8F0E1D3D2469FF580D8968D3DD89A2DB561
                      recordedAt: 2023-10-25T12:36:37.234+0000
                    - messageId: 05b2859d-85c6-4068-9347-2e563b5c9cf4
                      from: '442032864231'
                      to: '38712345678'
                      scenarioId: 4A6177C9B92039306F1F091708851A2E
                      groupId: '#/script/1'
                      url: /voice/ivr/1/files/305DE72BA11D81D1BAED75BFC46706761580BDEC2218C22628447FD3814E7913D3058E4ECBFD6F55C80E976235EEB111
                      recordedAt: 2023-10-25T12:36:37.240+0000
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><recordedAudioFilesResponse>\n    \n  <files>\n        \n    <file>\n            \n      <messageId>453e161a-fe4f-4f3c-80c0-ab520de9a969</messageId>\n            \n      <from>442032864231</from>\n            \n      <to>38712345678</to>\n            \n      <scenarioId>C9CE33CF130511D8E333C1260BABA309</scenarioId>\n            \n      <groupId>#/script/1</groupId>\n            \n      <url>/voice/ivr/1/files/3C67336FA555A606C85FA9637906A6AB98436B7AFC65D857A416F6521D39F8F0E1D3D2469FF580D8968D3DD89A2DB561</url>\n            \n      <recordedAt>2023-10-25T12:36:37.234+0000</recordedAt>\n          \n    </file>\n        \n    <file>\n            \n      <messageId>05b2859d-85c6-4068-9347-2e563b5c9cf4</messageId>\n            \n      <from>442032864231</from>\n            \n      <to>38712345678</to>\n            \n      <scenarioId>4A6177C9B92039306F1F091708851A2E</scenarioId>\n            \n      <groupId>#/script/1</groupId>\n            \n      <url>/voice/ivr/1/files/305DE72BA11D81D1BAED75BFC46706761580BDEC2218C22628447FD3814E7913D3058E4ECBFD6F55C80E976235EEB111</url>\n            \n      <recordedAt>2023-10-25T12:36:37.240+0000</recordedAt>\n          \n    </file>\n      \n  </files>\n  \n</recordedAudioFilesResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
  /voice/ivr/1/files/{id}:
    get:
      tags:
      - channels
      summary: Download Voice IVR Recorded File.
      description: This method allows you to download Voice IVR Recorded Audio File. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months.
      operationId: search-voice-ivr-recorded-file
      parameters:
      - name: id
        in: path
        description: File ID to download.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            audio/vnd.wave:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      - ivr:configuration:manage
      - message:send
  /voice/ivr/1/uploads:
    get:
      tags:
      - channels
      summary: Get files
      description: Get files with pagination. Maximum number of pages is 100.
      operationId: ivr-upload-get-files
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage'
              examples:
                Route response page example:
                  summary: Route response page example
                  description: Example of a page of route responses that includes route with Phone destination and Route with SIP destination.
                  value:
                    results:
                    - id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                      name: SIP endpoint route
                      destinations:
                      - value:
                          username: '41793026834'
                          sipTrunkId: string
                          customHeaders:
                            string: string
                          type: SIP
                        connectTimeout: 30
                        recording:
                          recordingType: AUDIO
                          recordingComposition:
                            enabled: true
                          customData:
                            string: string
                          filePrefix: string
                        type: ENDPOINT
                      transferOnly: false
                    - id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                      name: Phone endpoint route
                      destinations:
                      - value:
                          phoneNumber: '41793026834'
                          type: PHONE
                        connectTimeout: 30
                        recording:
                          recordingType: AUDIO
                          recordingComposition:
                            enabled: true
                          customData:
                            string: string
                          filePrefix: string
                        type: ENDPOINT
                      transferOnly: false
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Upload file
      description: 'Upload an audio file to be played in IVR calls. The file will be removed if it is not used for 90 days. Supported formats: `.wav` and `.mp3`.'
      operationId: ivr-upload-audio-file
      requestBody:
        description: Audio file to be uploaded.
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
              required:
              - file
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.File'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - ivr:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /voice/ctc/1/send:
    post:
      tags:
      - channels
      summary: Send click-to-call message
      description: This method allows you to send click-to-call voice messages.
      externalDocs:
        description: Learn more about click-to-call
        url: https://www.infobip.com/docs/voice-and-video/click-to-call
      operationId: send-click-to-call-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest'
            examples:
              Click-to-call request example:
                summary: Click-to-call request example
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    fromB: '41793026701'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    messageId: MESSAGE-ID-123-xyz
                    text: Test Voice message.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    anonymization: false
                    notifyUrl: https://www.example.com/voice/notify
                    notifyContentType: application/json
                    maxDuration: 60
                    warningTime: 5
                    retry:
                      minPeriod: 1
                      maxPeriod: 5
                      maxCount: 5
                    machineDetection: hangup
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      - SATURDAY
                      - SUNDAY
                      from:
                        hour: 6
                        minute: 0
                      to:
                        hour: 15
                        minute: 30
              Message with default language and voice:
                summary: Message with default language and voice
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Hello! You are being connected to our support team. Please hold.
              Message with voice selection:
                summary: Message with voice selection
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Hello! You are being connected to our support team. Please hold.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
              German language with male voice:
                summary: German language with male voice
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.
                    language: de
                    voice:
                      gender: male
                      name: Hans
              Spanish language without voice selection:
                summary: Spanish language without voice selection
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Hola! Está siendo conectado con nuestro equipo de soporte. Por favor, espere.
                    language: es
              Audio file played before transfer:
                summary: Audio file played before transfer
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    audioFileUrl: https://www.example.com/audio/greeting.mp3
              Anonymized call:
                summary: Anonymized call
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    anonymization: true
              Separate caller IDs for each party:
                summary: Separate caller IDs for each party
                value:
                  messages:
                  - from: '41793026700'
                    fromB: '41793026701'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
              Machine detection with hangup:
                summary: Machine detection with hangup
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Connecting you now.
                    language: en
                    machineDetection: hangup
              Call duration limit with warning beep:
                summary: Call duration limit with warning beep
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    maxDuration: 120
                    warningTime: 10
              Retry on failed delivery:
                summary: Retry on failed delivery
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    retry:
                      minPeriod: 1
                      maxPeriod: 10
                      maxCount: 3
              Delivery time window restricted to business hours:
                summary: Delivery time window restricted to business hours
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      from:
                        hour: 9
                        minute: 0
                      to:
                        hour: 17
                        minute: 0
              Delivery report with notify URL:
                summary: Delivery report with notify URL
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
              Bulk request with multiple messages:
                summary: Bulk request with multiple messages
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    messageId: MSG-001
                    text: Connecting your first call.
                    language: en
                  - from: '41793026700'
                    destinationA: '41793026728'
                    destinationB: '41793026732'
                    messageId: MSG-002
                    text: Connecting your second call.
                    language: en
              Retry with schedule and delivery report:
                summary: Retry with schedule and delivery report
                value:
                  bulkId: BULK-ID-123-xyz
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    retry:
                      minPeriod: 5
                      maxPeriod: 30
                      maxCount: 4
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      from:
                        hour: 8
                        minute: 0
                      to:
                        hour: 20
                        minute: 0
              'Outbound campaign: Announcement with machine detection and retry':
                summary: 'Outbound campaign: Announcement with machine detection and retry'
                value:
                  bulkId: BULK-ID-CAMPAIGN-001
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    messageId: MSG-CAMPAIGN-001
                    text: Hello! You have an incoming call from our support team. Please hold while we connect you.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    retry:
                      minPeriod: 2
                      maxPeriod: 20
                      maxCount: 3
                    machineDetection: hangup
              'Timed support connection: audio greeting with duration limit and delivery report':
                summary: 'Timed support connection: audio greeting with duration limit and delivery report'
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    audioFileUrl: https://www.example.com/audio/greeting.mp3
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    maxDuration: 180
                    warningTime: 15
              'Privacy-first scheduled call: anonymized with business hours and retry':
                summary: 'Privacy-first scheduled call: anonymized with business hours and retry'
                value:
                  messages:
                  - from: '41793026700'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Test Voice message.
                    anonymization: true
                    retry:
                      minPeriod: 10
                      maxPeriod: 60
                      maxCount: 2
                    deliveryTimeWindow:
                      days:
                      - MONDAY
                      - TUESDAY
                      - WEDNESDAY
                      - THURSDAY
                      - FRIDAY
                      from:
                        hour: 9
                        minute: 0
                      to:
                        hour: 18
                        minute: 0
              'Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit':
                summary: 'Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit'
                value:
                  messages:
                  - from: '41793026700'
                    fromB: '41793026701'
                    destinationA: '41793026727'
                    destinationB: '41793026731'
                    text: Please hold, an agent will be with you shortly.
                    language: en
                    voice:
                      gender: female
                      name: Joanna
                    notifyUrl: https://www.example.com/delivery-report
                    notifyContentType: application/json
                    maxDuration: 300
                    warningTime: 20
                    machineDetection: hangup
          application/xml:
            schema:
              $ref: '#/components/schemas/977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest'
            examples:
              Click-to-call request example:
                summary: Click-to-call request example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <fromB>41793026701</fromB>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <text>Test Voice message.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <anonymization>false</anonymization>\n      <notifyUrl>https://www.example.com/voice/notify</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <maxDuration>60</maxDuration>\n      <warningTime>5</warningTime>\n      <retry>\n        <minPeriod>1</minPeriod>\n        <maxPeriod>5</maxPeriod>\n        <maxCount>5</maxCount>\n      </retry>\n      <machineDetection>hangup</machineDetection>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n          <days>SATURDAY</days>\n          <days>SUNDAY</days>\n        </days>\n        <from>\n          <hour>6</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>15</hour>\n          <minute>30</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              Message with default language and voice:
                summary: Message with default language and voice
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Hello! You are being connected to our support team. Please hold.</text>\n    </messages>\n  </messages>\n</request>\n"
              Message with voice selection:
                summary: Message with voice selection
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Hello! You are being connected to our support team. Please hold.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n    </messages>\n  </messages>\n</request>\n"
              German language with male voice:
                summary: German language with male voice
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Hallo! Sie werden jetzt mit unserem Support-Team verbunden. Bitte warten Sie.</text>\n      <language>de</language>\n      <voice>\n        <gender>male</gender>\n        <name>Hans</name>\n      </voice>\n    </messages>\n  </messages>\n</request>\n"
              Spanish language without voice selection:
                summary: Spanish language without voice selection
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Hola! Está siendo conectado con nuestro equipo de soporte. Por favor, espere.</text>\n      <language>es</language>\n    </messages>\n  </messages>\n</request>\n"
              Audio file played before transfer:
                summary: Audio file played before transfer
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <audioFileUrl>https://www.example.com/audio/greeting.mp3</audioFileUrl>\n    </messages>\n  </messages>\n</request>\n"
              Anonymized call:
                summary: Anonymized call
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <anonymization>true</anonymization>\n    </messages>\n  </messages>\n</request>\n"
              Separate caller IDs for each party:
                summary: Separate caller IDs for each party
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <fromB>41793026701</fromB>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n    </messages>\n  </messages>\n</request>\n"
              Machine detection with hangup:
                summary: Machine detection with hangup
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Connecting you now.</text>\n      <language>en</language>\n      <machineDetection>hangup</machineDetection>\n    </messages>\n  </messages>\n</request>\n"
              Call duration limit with warning beep:
                summary: Call duration limit with warning beep
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <maxDuration>120</maxDuration>\n      <warningTime>10</warningTime>\n    </messages>\n  </messages>\n</request>\n"
              Retry on failed delivery:
                summary: Retry on failed delivery
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <retry>\n        <minPeriod>1</minPeriod>\n        <maxPeriod>10</maxPeriod>\n        <maxCount>3</maxCount>\n      </retry>\n    </messages>\n  </messages>\n</request>\n"
              Delivery time window restricted to business hours:
                summary: Delivery time window restricted to business hours
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n        </days>\n        <from>\n          <hour>9</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>17</hour>\n          <minute>0</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              Delivery report with notify URL:
                summary: Delivery report with notify URL
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n    </messages>\n  </messages>\n</request>\n"
              Bulk request with multiple messages:
                summary: Bulk request with multiple messages
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <messageId>MSG-001</messageId>\n      <text>Connecting your first call.</text>\n      <language>en</language>\n    </messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026728</destinationA>\n      <destinationB>41793026732</destinationB>\n      <messageId>MSG-002</messageId>\n      <text>Connecting your second call.</text>\n      <language>en</language>\n    </messages>\n  </messages>\n</request>\n"
              Retry with schedule and delivery report:
                summary: Retry with schedule and delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <retry>\n        <minPeriod>5</minPeriod>\n        <maxPeriod>30</maxPeriod>\n        <maxCount>4</maxCount>\n      </retry>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n        </days>\n        <from>\n          <hour>8</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>20</hour>\n          <minute>0</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              'Outbound campaign: Announcement with machine detection and retry':
                summary: 'Outbound campaign: Announcement with machine detection and retry'
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <bulkId>BULK-ID-CAMPAIGN-001</bulkId>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <messageId>MSG-CAMPAIGN-001</messageId>\n      <text>Hello! You have an incoming call from our support team. Please hold while we connect you.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <retry>\n        <minPeriod>2</minPeriod>\n        <maxPeriod>20</maxPeriod>\n        <maxCount>3</maxCount>\n      </retry>\n      <machineDetection>hangup</machineDetection>\n    </messages>\n  </messages>\n</request>\n"
              'Timed support connection: audio greeting with duration limit and delivery report':
                summary: 'Timed support connection: audio greeting with duration limit and delivery report'
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <audioFileUrl>https://www.example.com/audio/greeting.mp3</audioFileUrl>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <maxDuration>180</maxDuration>\n      <warningTime>15</warningTime>\n    </messages>\n  </messages>\n</request>\n"
              'Privacy-first scheduled call: anonymized with business hours and retry':
                summary: 'Privacy-first scheduled call: anonymized with business hours and retry'
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Test Voice message.</text>\n      <anonymization>true</anonymization>\n      <retry>\n        <minPeriod>10</minPeriod>\n        <maxPeriod>60</maxPeriod>\n        <maxCount>2</maxCount>\n      </retry>\n      <deliveryTimeWindow>\n        <days>\n          <days>MONDAY</days>\n          <days>TUESDAY</days>\n          <days>WEDNESDAY</days>\n          <days>THURSDAY</days>\n          <days>FRIDAY</days>\n        </days>\n        <from>\n          <hour>9</hour>\n          <minute>0</minute>\n        </from>\n        <to>\n          <hour>18</hour>\n          <minute>0</minute>\n        </to>\n      </deliveryTimeWindow>\n    </messages>\n  </messages>\n</request>\n"
              'Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit':
                summary: 'Full outbound agent connect: separate caller IDs, voice message, machine detection, and duration limit'
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><request>\n  <messages>\n    <messages>\n      <from>41793026700</from>\n      <fromB>41793026701</fromB>\n      <destinationA>41793026727</destinationA>\n      <destinationB>41793026731</destinationB>\n      <text>Please hold, an agent will be with you shortly.</text>\n      <language>en</language>\n      <voice>\n        <gender>female</gender>\n        <name>Joanna</name>\n      </voice>\n      <notifyUrl>https://www.example.com/delivery-report</notifyUrl>\n      <notifyContentType>application/json</notifyContentType>\n      <maxDuration>300</maxDuration>\n      <warningTime>20</warningTime>\n      <machineDetection>hangup</machineDetection>\n    </messages>\n  </messages>\n</request>\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value:
                    bulkId: 4fda521a-c680-470d-b134-83d468f7ac80
                    messages:
                    - to: '41793026727'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
            application/xml:
              schema:
                $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse'
              examples:
                Successful response example:
                  summary: Successful response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceResponse>\n  <bulkId>4fda521a-c680-470d-b134-83d468f7ac80</bulkId>\n  <messages>\n    <message>\n      <to>41793026727</to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>26</id>\n        <name>PENDING_ACCEPTED</name>\n        <description>Message accepted, pending for delivery.</description>\n      </status>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n    </message>\n  </messages>\n</voiceResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - clicktocall:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2000
        numberOfTimeUnits: 0
        timeUnit: s
  /voice/1/reports:
    get:
      tags:
      - channels
      summary: Get Voice Delivery Reports
      description: This method allows you to get delivery reports for sent Voice messages, outbound IVR or Click-to-call (without notifyUrl request parameter). Delivery reports are returned only once. Additional delivery report request will return an empty collection.
      operationId: get-voice-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses.
        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: The maximum number of returned delivery reports. Default value is 50.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - bulkId: 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb
                      messageId: ff4804ef-6ab6-4abd-984d-ab3b1387e852
                      from: '385333444'
                      to: '385981178'
                      sentAt: 2018-06-25T13:38:14.730+0000
                      mccMnc: '21901'
                      callbackData: DLR callback data
                      voiceCall:
                        feature: Voice-message
                        startTime: 2018-06-25T13:38:15.000+0000
                        answerTime: 2018-06-25T13:38:25.000+0000
                        endTime: 2018-06-25T13:38:28.316+0000
                        duration: 10
                        chargedDuration: 30
                        fileDuration: 19.3
                        dtmfCodes: 3, 9
                        ivr:
                          scenarioId: '333'
                          scenarioName: Scenario name
                          collectedDtmfs: '{"myFirstVar":"3","mySecondVar":"9"}'
                          collectedMappedDtmfs: null
                          spokenInput: null
                          matchedSpokenInput: null
                      price:
                        pricePerSecond: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 5000
                        name: VOICE_ANSWERED
                        description: Call answered by human
                        permanent: true
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n    \n  <results>\n        \n    <results>\n            \n      <bulkId>8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb</bulkId>\n            \n      <messageId>ff4804ef-6ab6-4abd-984d-ab3b1387e852</messageId>\n            \n      <from>385333444</from>\n            \n      <to>385981178</to>\n            \n      <sentAt>2018-06-25T13:38:14.730+0000</sentAt>\n            \n      <mccMnc>21901</mccMnc>\n            \n      <callbackData>DLR callback data</callbackData>\n            \n      <voiceCall>\n                \n        <feature>Voice-message</feature>\n                \n        <startTime>2018-06-25T13:38:15.000+0000</startTime>\n                \n        <answerTime>2018-06-25T13:38:25.000+0000</answerTime>\n                \n        <endTime>2018-06-25T13:38:28.316+0000</endTime>\n                \n        <duration>10</duration>\n                \n        <chargedDuration>30</chargedDuration>\n                \n        <fileDuration>19.3</fileDuration>\n                \n        <dtmfCodes>3, 9</dtmfCodes>\n                \n        <ivr>\n                    \n          <scenarioId>333</scenarioId>\n                    \n          <scenarioName>Scenario name</scenarioName>\n                    \n          <collectedDtmfs>{\"myFirstVar\":\"3\",\"mySecondVar\":\"9\"}</collectedDtmfs>\n                    \n          <collectedMappedDtmfs/>\n                    \n          <spokenInput/>\n                    \n          <matchedSpokenInput/>\n                  \n        </ivr>\n              \n      </voiceCall>\n            \n      <price>\n                \n        <pricePerSecond>0.01</pricePerSecond>\n                \n        <currency>EUR</currency>\n              \n      </price>\n            \n      <status>\n                \n        <groupId>3</groupId>\n                \n        <groupName>DELIVERED</groupName>\n                \n        <id>5</id>\n                \n        <name>DELIVERED_TO_HANDSET</name>\n                \n        <description>Message delivered to handset</description>\n              \n      </status>\n            \n      <error>\n                \n        <groupId>0</groupId>\n                \n        <groupName>OK</groupName>\n                \n        <id>5000</id>\n                \n        <name>VOICE_ANSWERED</name>\n                \n        <description>Call answered by human</description>\n                \n        <permanent>true</permanent>\n              \n      </error>\n          \n    </results>\n      \n  </results>\n  \n</reportResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice-reports:read
      - voice:logs:read
      - message:send
  /tts/3/reports:
    get:
      tags:
      - channels
      summary: Get Voice Delivery Reports
      description: 'This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.



        "We strongly advise you to update to new [delivery report method](https://www.infobip.com/docs/api/channels/voice/voice-reports-and-logs/get-voice-delivery-reports).

        '
      operationId: get-voice-delivery-reports-deprecated
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination addresses.
        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: The maximum number of returned delivery reports. Default value is 50.
        required: false
        style: form
        explode: true
        schema:
          type: integer
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - bulkId: 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb
                      messageId: ff4804ef-6ab6-4abd-984d-ab3b1387e852
                      to: '385981178'
                      sentAt: 2018-06-25T13:38:14.730+0000
                      doneAt: 2018-06-25T13:38:28.318+0000
                      startTime: 2018-06-25T13:38:15.000+0000
                      endTime: 2018-06-25T13:38:28.316+0000
                      answerTime: 2018-06-25T13:38:25.000+0000
                      duration: 10
                      fileDuration: 19.3
                      mccMnc: '21901'
                      callbackData: DLR callback data
                      dtmfCodes: '1'
                      recordedAudioFileUrl: /tts/3/files/ff4804ef-6ab6-4abd-984d-ab3b1387e852/385981178
                      price:
                        pricePerSecond: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 5000
                        name: VOICE_ANSWERED
                        description: Call answered by human
                        permanent: true
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n    \n  <results>\n        \n    <results>\n            \n      <bulkId>8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb</bulkId>\n            \n      <messageId>ff4804ef-6ab6-4abd-984d-ab3b1387e852</messageId>\n            \n      <to>385981178</to>\n            \n      <sentAt>2018-06-25T13:38:14.730+0000</sentAt>\n            \n      <doneAt>2018-06-25T13:38:28.318+0000</doneAt>\n            \n      <startTime>2018-06-25T13:38:15.000+0000</startTime>\n            \n      <endTime>2018-06-25T13:38:28.316+0000</endTime>\n            \n      <answerTime>2018-06-25T13:38:25.000+0000</answerTime>\n            \n      <duration>10</duration>\n            \n      <fileDuration>19.3</fileDuration>\n            \n      <mccMnc>21901</mccMnc>\n            \n      <callbackData>DLR callback data</callbackData>\n            \n      <dtmfCodes>1</dtmfCodes>\n            \n      <recordedAudioFileUrl>/tts/3/files/ff4804ef-6ab6-4abd-984d-ab3b1387e852/385981178</recordedAudioFileUrl>\n            \n      <price>\n                \n        <pricePerSecond>0.01</pricePerSecond>\n                \n        <currency>EUR</currency>\n              \n      </price>\n            \n      <status>\n                \n        <groupId>3</groupId>\n                \n        <groupName>DELIVERED</groupName>\n                \n        <id>5</id>\n                \n        <name>DELIVERED_TO_HANDSET</name>\n                \n        <description>Message delivered to handset</description>\n              \n      </status>\n            \n      <error>\n                \n        <groupId>0</groupId>\n                \n        <groupName>OK</groupName>\n                \n        <id>5000</id>\n                \n        <name>VOICE_ANSWERED</name>\n                \n        <description>Call answered by human</description>\n                \n        <permanent>true</permanent>\n              \n      </error>\n          \n    </results>\n      \n  </results>\n  \n</reportResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice-message:manage
      - voice-message:logs:read
      - message:send
      x-deprecationInformation:
        deprecation: '2020-07-01T00:00:00Z'
        successorOperationId: get-voice-delivery-reports
  /tts/3/logs:
    get:
      tags:
      - channels
      summary: Get sent Voice logs
      description: This method allows you to get logs of sent Voice messages. Voice logs are available for the last 48 hours!
      operationId: get-sent-voice-logs
      parameters:
      - name: from
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: Destination address of the voice message.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: The ID which uniquely identifies the request.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: generalStatus
        in: query
        description: Sent voice message status group. Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IpCoreGeneralStatus'
      - name: sentSince
        in: query
        description: 'Lower limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSXXX.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: sentUntil
        in: query
        description: 'Upper limit on date and time of sending a Voice message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSXXX.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
      - name: limit
        in: query
        description: Maximal number of messages in the returned logs. Default value is 50.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: mcc
        in: query
        description: Mobile country code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: mnc
        in: query
        description: Mobile network code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - bulkId: 06479ba3-5977-47f6-9346-fee0369bc76b
                      messageId: 1f21d8d7-f306-4f53-9f6e-eddfce9849ea
                      to: '41793026727'
                      from: '41793026700'
                      text: Test voice message.
                      sentAt: 2023-08-10T07:36:42.187+0000
                      doneAt: 2023-08-10T07:36:43.194+0000
                      duration: 10
                      mccMnc: '22801'
                      price:
                        pricePerSecond: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 5003
                        name: EC_VOICE_NO_ANSWER
                        description: User was notified, but did not answer call
                        permanent: true
            application/xml:
              schema:
                $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><voiceLogsResponse>\n    \n  <results>\n        \n    <results>\n            \n      <bulkId>06479ba3-5977-47f6-9346-fee0369bc76b</bulkId>\n            \n      <messageId>1f21d8d7-f306-4f53-9f6e-eddfce9849ea</messageId>\n            \n      <to>41793026727</to>\n            \n      <from>41793026700</from>\n            \n      <text>Test voice message.</text>\n            \n      <sentAt>2023-08-10T07:36:42.187+0000</sentAt>\n            \n      <doneAt>2023-08-10T07:36:43.194+0000</doneAt>\n            \n      <duration>10</duration>\n            \n      <mccMnc>22801</mccMnc>\n            \n      <price>\n                \n        <pricePerSecond>0.01</pricePerSecond>\n                \n        <currency>EUR</currency>\n              \n      </price>\n            \n      <status>\n                \n        <groupId>3</groupId>\n                \n        <groupName>DELIVERED</groupName>\n                \n        <id>5</id>\n                \n        <name>DELIVERED_TO_HANDSET</name>\n                \n        <description>Message delivered to handset</description>\n              \n      </status>\n            \n      <error>\n                \n        <groupId>0</groupId>\n                \n        <groupName>OK</groupName>\n                \n        <id>5003</id>\n                \n        <name>EC_VOICE_NO_ANSWER</name>\n                \n        <description>User was notified, but did not answer call</description>\n                \n        <permanent>true</permanent>\n              \n      </error>\n          \n    </results>\n      \n  </results>\n  \n</voiceLogsResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: string
                        text: string
            application/xml:
              schema:
                $ref: '#/components/schemas/31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n    \n  <requestError>\n        \n    <serviceException>\n            \n      <messageId>String</messageId>\n            \n      <text>String</text>\n          \n    </serviceException>\n      \n  </requestError>\n  \n</ApiException>\n"
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice-message:manage
      - voice-message:logs:read
      - message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /voice/masking/2/config:
    get:
      tags:
      - channels
      summary: Get number masking configurations
      description: This method allows you to get all voice number masking configurations.
      operationId: get-number-masking-configurations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Configurations not found:
                  summary: Configurations not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Masking configurations not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    post:
      tags:
      - channels
      summary: Create number masking configuration
      description: This method allows you to create masking configuration.
      operationId: create-number-masking-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody'
            examples:
              Request example:
                summary: Request example
                value:
                  name: UniqueConfigurationName
                  callbackUrl: https://example.com/1/callback
                  statusUrl: https://example.com/1/status
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    key: 3FC0C9CB4AFAEAC67E8FC6BA3B1E044A
                    name: UniqueConfigurationName
                    callbackUrl: https://example.com/1/callback
                    statusUrl: https://example.com/1/status
                    insertDateTime: '2019-08-16T09:11:36.573'
                    updateDateTime: '2019-08-16T09:11:36.573'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Invalid setup body:
                  summary: Invalid setup body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          name:
                          - Setup name is required.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
  /voice/masking/2/config/{key}:
    get:
      tags:
      - channels
      summary: Get number masking configuration
      description: This method allows you to get a Voice number masking configuration.
      operationId: get-number-masking-configuration
      parameters:
      - name: key
        in: path
        description: Masking configuration identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    key: 3FC0C9CB4AFAEAC67E8FC6BA3B1E044A
                    name: UniqueConfigurationName
                    callbackUrl: https://example.com/1/callback
                    statusUrl: https://example.com/1/status
                    insertDateTime: '2019-08-16T09:11:36.573'
                    updateDateTime: '2019-08-16T09:11:36.573'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Invalid key:
                  summary: Invalid key
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Make sure you provided a valid key parameter.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Configuration not found:
                  summary: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Masking configuration not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    put:
      tags:
      - channels
      summary: Update number masking configuration
      description: This method allows you to update a Voice number masking configuration.
      operationId: update-number-masking-configuration
      parameters:
      - name: key
        in: path
        description: Masking configuration identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody'
            examples:
              Request example:
                summary: Request example
                value:
                  name: UniqueConfigurationName
                  callbackUrl: https://example.com/1/callback
                  statusUrl: https://example.com/1/status
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    key: 3FC0C9CB4AFAEAC67E8FC6BA3B1E044A
                    name: UniqueConfigurationName
                    callbackUrl: https://example.com/1/callback
                    statusUrl: https://example.com/1/status
                    insertDateTime: '2019-08-16T09:11:36.573'
                    updateDateTime: '2019-08-16T09:11:36.573'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Invalid setup body:
                  summary: Invalid setup body
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          name:
                          - Setup name is required.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Configuration not found:
                  summary: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Masking configuration not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    delete:
      tags:
      - channels
      summary: Delete number masking configuration
      description: This method allows you to delete a Voice number masking configuration.
      operationId: delete-number-masking-configuration
      parameters:
      - name: key
        in: path
        description: Masking configuration identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Invalid key:
                  summary: Invalid key
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Make sure you provided a valid key parameter.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Configuration not found:
                  summary: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Masking configuration not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
  /voice/masking/1/upload:
    post:
      tags:
      - channels
      summary: Upload audio files
      description: This method allows uploading audio files that can be used on Infobip Voice platform. The method accepts either a URL or an uploaded audio file in the request body. Using both or neither will cause the request to be rejected.
      operationId: upload-audio-files
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadBody'
            examples:
              Using URL to audio file:
                summary: Using URL to audio file
                value:
                  url: https://example.com/audio.mp3
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadResponse'
              examples:
                Upload file response:
                  summary: Upload file response
                  value:
                    fileId: cb702ae4-f356-4efd-b2dd-7a667b570af5
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
  /voice/masking/2/credentials:
    get:
      tags:
      - channels
      summary: Get number masking credentials
      description: This method allows you to get Voice number masking credentials.
      operationId: get-number-masking-credentials
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    apiId: 55ddccad2df62a4b615b7e3c472b2ab6
                    key: 5da086b6a8e4424993646b8699c333ca
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Credentials not found:
                  summary: Credentials not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Credentials not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    put:
      tags:
      - channels
      summary: Update number masking credentials
      description: This method allows you to update Voice number masking credentials.
      operationId: update-number-masking-credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody'
            examples:
              Request example:
                summary: Request example
                value:
                  apiId: 55ddccad2df62a4b615b7e3c472b2ab6
                  key: 5da086b6a8e4424993646b8699c333ca
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    apiId: 55ddccad2df62a4b615b7e3c472b2ab6
                    key: 5da086b6a8e4424993646b8699c333ca
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    post:
      tags:
      - channels
      summary: Create number masking credentials
      description: This method allows you to create Voice number masking credentials.
      operationId: create-number-masking-credentials
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody'
            examples:
              Request example:
                summary: Request example
                value:
                  apiId: 55ddccad2df62a4b615b7e3c472b2ab6
                  key: 5da086b6a8e4424993646b8699c333ca
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    apiId: 55ddccad2df62a4b615b7e3c472b2ab6
                    key: 5da086b6a8e4424993646b8699c333ca
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Credentials already exist:
                  summary: Credentials already exist
                  value:
                    requestError:
                      serviceException:
                        messageId: FORBIDDEN
                        text: Credentials already exist.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
    delete:
      tags:
      - channels
      summary: Delete number masking credentials
      description: This method allows you to delete Voice number masking credentials.
      operationId: delete-number-masking-credentials
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException'
              examples:
                Credentials not found:
                  summary: Credentials not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Credentials not found.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbermasking:manage
  /callrouting/1/routes:
    get:
      tags:
      - channels
      summary: Get call routes
      description: Get existing call routes with pagination.
      operationId: get-call-routes
      parameters:
      - name: nameContains
        in: query
        description: String contained in the name of the route, case-insensitive.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage'
              examples:
                Route response page example:
                  summary: Route response page example
                  description: Example of a page of route responses that includes route with Phone destination and Route with SIP destination.
                  value:
                    results:
                    - id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                      name: SIP endpoint route
                      destinations:
                      - value:
                          username: '41793026834'
                          sipTrunkId: string
                          customHeaders:
                            string: string
                          type: SIP
                        connectTimeout: 30
                        recording:
                          recordingType: AUDIO
                          recordingComposition:
                            enabled: true
                          customData:
                            string: string
                          filePrefix: string
                        type: ENDPOINT
                      transferOnly: false
                    - id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                      name: Phone endpoint route
                      destinations:
                      - value:
                          phoneNumber: '41793026834'
                          type: PHONE
                        connectTimeout: 30
                        recording:
                          recordingType: AUDIO
                          recordingComposition:
                            enabled: true
                          customData:
                            string: string
                          filePrefix: string
                        type: ENDPOINT
                      transferOnly: false
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    post:
      tags:
      - channels
      summary: Create a call route
      description: Create a new call route.
      operationId: create-call-route
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest'
            examples:
              Route with a SIP endpoint destination:
                summary: Route with a SIP endpoint destination
                value:
                  name: Route with a SIP endpoint destination
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a phone endpoint destination:
                summary: Route with a phone endpoint destination
                value:
                  name: Route with a phone endpoint destination
                  destinations:
                  - value:
                      phoneNumber: '41793026834'
                      type: PHONE
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a SIP endpoint destination with failover to a phone endpoint destination:
                summary: Route with a SIP endpoint destination with failover to a phone endpoint destination
                value:
                  name: Route with a SIP endpoint destination with failover to a phone endpoint destination
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  - value:
                      phoneNumber: '41793026834'
                      type: PHONE
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with an URL endpoint destination:
                summary: Route with an URL endpoint destination
                value:
                  name: Route with an URL endpoint destination
                  destinations:
                  - url: https://www.example.com
                    securityConfig:
                      username: user
                      type: BASIC
                    type: URL
                  transferOnly: false
              Route with two SIP endpoints destinations in round-robin configuration:
                summary: Route with two SIP endpoints destinations in round-robin configuration
                value:
                  name: Route with two SIP endpoints destinations in round-robin configuration
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    priority: 1
                    weight: 50
                    type: ENDPOINT
                  - value:
                      username: '41793026834'
                      sipTrunkId: 92d871fj8i802ip
                      customHeaders:
                        key1: value1
                      type: SIP
                    priority: 1
                    weight: 50
                    type: ENDPOINT
                  transferOnly: false
              Route with a PHONE search criteria:
                summary: Route with a PHONE search criteria
                value:
                  name: Route with a PHONE search criteria
                  criteria:
                  - to: 41793(.+)
                    value:
                      from: 41793(.+)
                      type: PHONE
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a SIP search criteria:
                summary: Route with a SIP search criteria
                value:
                  name: Route with a SIP search criteria
                  criteria:
                  - to: 41793(.+)
                    value:
                      sipTrunkId: 60d345fd3a799ec
                      username: 41793(.+)
                      headers:
                      - headerName: X-Header-Name
                        headerValue: 41793(.+)
                      type: SIP
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        X-Identity: john.doe
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a WebRTC search criteria:
                summary: Route with a WebRTC search criteria
                value:
                  name: Route with a WebRTC search criteria
                  criteria:
                  - value:
                      type: WEBRTC
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
        required: true
      responses:
        '201':
          description: Route Successfully Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: create.route.destinations[0].value.sipTrunkId must not be blank
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /callrouting/1/routes/{routeId}:
    get:
      tags:
      - channels
      summary: Get a call route
      description: Get an existing call route.
      operationId: get-call-route
      parameters:
      - name: routeId
        in: path
        description: Route identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 56b3e3ea-e91f-44ed-9d57-c7f05cd358ba
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    put:
      tags:
      - channels
      summary: Update a call route
      description: Update an already existing call route. Fields that are not sent in the request body will take default values and overwrite existing ones.
      operationId: update-call-route
      parameters:
      - name: routeId
        in: path
        description: Route identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 56b3e3ea-e91f-44ed-9d57-c7f05cd358ba
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest'
            examples:
              Route with a SIP endpoint destination:
                summary: Route with a SIP endpoint destination
                value:
                  name: Route with a SIP endpoint destination
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a phone endpoint destination:
                summary: Route with a phone endpoint destination
                value:
                  name: Route with a phone endpoint destination
                  destinations:
                  - value:
                      phoneNumber: '41793026834'
                      type: PHONE
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a SIP endpoint destination with failover to a phone endpoint destination:
                summary: Route with a SIP endpoint destination with failover to a phone endpoint destination
                value:
                  name: Route with a SIP endpoint destination with failover to a phone endpoint destination
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  - value:
                      phoneNumber: '41793026834'
                      type: PHONE
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with an URL endpoint destination:
                summary: Route with an URL endpoint destination
                value:
                  name: Route with an URL endpoint destination
                  destinations:
                  - url: https://www.example.com
                    securityConfig:
                      username: user
                      type: BASIC
                    type: URL
                  transferOnly: false
              Route with two SIP endpoints destinations in round-robin configuration:
                summary: Route with two SIP endpoints destinations in round-robin configuration
                value:
                  name: Route with two SIP endpoints destinations in round-robin configuration
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    priority: 1
                    weight: 50
                    type: ENDPOINT
                  - value:
                      username: '41793026834'
                      sipTrunkId: 92d871fj8i802ip
                      customHeaders:
                        key1: value1
                      type: SIP
                    priority: 1
                    weight: 50
                    type: ENDPOINT
                  transferOnly: false
              Route with a PHONE search criteria:
                summary: Route with a PHONE search criteria
                value:
                  name: Route with a PHONE search criteria
                  criteria:
                  - to: 41793(.+)
                    value:
                      from: 41793(.+)
                      type: PHONE
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a SIP search criteria:
                summary: Route with a SIP search criteria
                value:
                  name: Route with a SIP search criteria
                  criteria:
                  - to: 41793(.+)
                    value:
                      sipTrunkId: 60d345fd3a799ec
                      username: 41793(.+)
                      headers:
                      - headerName: X-Header-Name
                        headerValue: 41793(.+)
                      type: SIP
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        X-Identity: john.doe
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
              Route with a WebRTC search criteria:
                summary: Route with a WebRTC search criteria
                value:
                  name: Route with a WebRTC search criteria
                  criteria:
                  - value:
                      type: WEBRTC
                  destinations:
                  - value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      customHeaders:
                        Header-Name: header value
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                      recordingComposition:
                        enabled: true
                      customData:
                        key1: value1
                      filePrefix: rec
                    type: ENDPOINT
                  transferOnly: false
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete a call route
      description: Delete an existing call route.
      operationId: delete-call-route
      parameters:
      - name: routeId
        in: path
        description: Route identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 56b3e3ea-e91f-44ed-9d57-c7f05cd358ba
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
    patch:
      tags:
      - channels
      summary: Set order on call route
      description: Set order on existing call route.
      operationId: set-order-call-route
      parameters:
      - name: routeId
        in: path
        description: Route identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 56b3e3ea-e91f-44ed-9d57-c7f05cd358ba
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteOrderRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /callrouting/1/recordings:
    get:
      tags:
      - channels
      summary: Get recordings
      description: This method allows searching and filtering based on various recording data properties.
      operationId: search-call-routing-recording
      parameters:
      - name: sortBy
        in: query
        description: Field that will be used for sorting.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingSortColumn'
        example: START_TIME
      - name: sortDirection
        in: query
        description: Order in which files will be sorted based on sortBy field.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SortDirection'
        example: DESC
      - name: endpointType
        in: query
        description: Endpoint type of at least one participant in the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: PHONE
      - name: phoneNumber
        in: query
        description: Phone number that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 41792036727
      - name: sipTrunkId
        in: query
        description: SIP Trunk ID that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 60d345fd3a799ec
      - name: sipUsername
        in: query
        description: Username on the SIP trunk that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 41793026834
      - name: webrtcIdentity
        in: query
        description: WebRTC Identity that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: WebRTC_user
      - name: routeId
        in: query
        description: Route ID that was used to establish the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
      - name: routeName
        in: query
        description: Route name to be used to match recordings. Name will be matched comparing it to all route names.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Sample Route Name
      - name: correlationId
        in: query
        description: Correlation ID to match.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: d8d84155-3831-43fb-91c9-bb897149a79d
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-05-01T14:25:45.125+0000
      - name: startTimeBefore
        in: query
        description: Date and time when the (last) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-05-01T14:26:45.125+0000
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aa157138bc28697f89db8325cc3d3ce20c0f3c72c30b6831a5435f3f2d211cfe.CallRoutingRecordingPage'
              examples:
                Successfully fetching results:
                  summary: Successfully fetching results
                  description: Fetching recorded calls.
                  value:
                    results:
                    - application:
                        routeId: edef623d-0e1a-4a83-91e5-73c75ed31473
                        routeName: Route with disabled recording composition
                        correlationId: 8fdbf7d9-9889-4c2e-8f16-246d5fe066de
                        startTime: 2025-04-04T09:25:50.060+0000
                        endTime: 2025-04-04T09:25:57.780+0000
                        type: CALL_ROUTING
                      recording:
                        composedFiles: []
                        callRecordings:
                        - callId: q9lo60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs667ofk00
                          endpoint:
                            phoneNumber: '38761111222'
                            type: PHONE
                          direction: INBOUND
                          status: SUCCESSFUL
                          files:
                          - id: b83f049e-6b2a-4111-bbeb-32426fe0a737
                            name: b83f049e-6b2a-4111-bbeb-32426fe0a737.wav
                            fileFormat: WAV
                            size: 123392
                            startTime: 2025-04-04T09:25:50.059+0000
                            endTime: 2025-04-04T09:25:57.739+0000
                            creationTime: 2025-04-04T09:25:57.829+0000
                            duration: 7
                            location: HOSTED
                            customData:
                              routeId: edef623d-0e1a-4a83-91e5-73c75ed31473
                        - callId: cb64100e-371c-4928-8cbd-1256752e4de4
                          endpoint:
                            phoneNumber: '38762222333'
                            type: PHONE
                          direction: OUTBOUND
                          status: SUCCESSFUL
                          files:
                          - id: d411529b-cc99-4144-8e4d-53214a1f1660
                            name: d411529b-cc99-4144-8e4d-53214a1f1660.wav
                            fileFormat: WAV
                            size: 123682
                            startTime: 2025-04-04T09:25:50.079+0000
                            endTime: 2025-04-04T09:25:57.779+0000
                            creationTime: 2025-04-04T09:25:57.825+0000
                            duration: 7
                            location: HOSTED
                            customData:
                              routeId: edef623d-0e1a-4a83-91e5-73c75ed31473
                    - application:
                        routeId: 3a1fcde8-df41-4209-b9a5-895db5d42e3d
                        routeName: Route with enabled recording composition
                        correlationId: fc840e38-29dc-47d5-9947-17371c939a17
                        startTime: 2025-04-04T11:38:01.723+0000
                        endTime: 2025-04-04T11:38:12.763+0000
                        type: CALL_ROUTING
                      recording:
                        composedFiles:
                        - id: 294cdf1b-70ae-4249-b384-6f267b5cf345
                          name: 294cdf1b-70ae-4249-b384-6f267b5cf345.wav
                          fileFormat: WAV
                          size: 177152
                          startTime: 2025-04-04T11:38:01.724+0000
                          endTime: 2025-04-04T11:38:12.764+0000
                          creationTime: 2025-04-04T11:38:12.829+0000
                          duration: 11
                          location: HOSTED
                          customData:
                            routeId: 3a1fcde8-df41-4209-b9a5-895db5d42e3d
                        callRecordings:
                        - callId: m1to60o6ihb23q06epc23n46ihd0nilcibb8nihd5jpu6n5d3boqip1e1bqs6lfdgk00
                          endpoint:
                            phoneNumber: '38761111222'
                            type: PHONE
                          direction: INBOUND
                          files: []
                        - callId: 81a815ee-4fc2-45e3-a3eb-50277359a089
                          endpoint:
                            phoneNumber: '38761111333'
                            type: PHONE
                          direction: OUTBOUND
                          files: []
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid sort column.
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete by correlation ID
      description: This method allows deleting call recordings based on correlation ID.
      operationId: delete-by-correlation-id
      parameters:
      - name: correlationId
        in: query
        description: Correlation ID to match.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: d8d84155-3831-43fb-91c9-bb897149a79d
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Invalid sort column.
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /callrouting/1/recordings/files/{fileId}:
    get:
      tags:
      - channels
      summary: Download recording file
      description: Download a recording file.
      operationId: recording-file-download
      parameters:
      - name: fileId
        in: path
        description: File ID to match.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation'
        example: FRANKFURT
      - name: Range
        in: header
        description: Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: bytes=0-1023
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: File binary stream response
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingServiceException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /callrouting/1/routes/{routeId}/status:
    post:
      tags:
      - channels
      summary: Update route status
      description: 'Update status of existing call route. '
      operationId: update-call-route-status
      parameters:
      - name: routeId
        in: path
        description: Route identifier
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 56b3e3ea-e91f-44ed-9d57-c7f05cd358ba
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteStatusRequest'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null
                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/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: m
  /callrouting/1/routes/simulate:
    post:
      tags:
      - channels
      summary: Simulate route selection
      description: Simulates which route will be selected upon predefined request.
      operationId: simulate-route-selection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c5d63eb36983d8ea1e54e74166c0e08ea636cff38a55aa9570bd7ba615a520a0.RouteSimulatorRequest'
            examples:
              Phone simulator request example:
                summary: Example of a phone simulator request
                value:
                  to: '41793012345'
                  useDisabledRoutes: false
                  endpoint:
                    from: '41793026234'
                    type: PHONE
              SIP simulator request example:
                summary: Example of a SIP simulator request
                value:
                  to: '41793012345'
                  useDisabledRoutes: false
                  endpoint:
                    from: '41793026234'
                    sipTrunkId: test-sip-trunk-id
                    headers:
                      X-Header-Name: Value
                    type: SIP
              WebRTC simulator request example:
                summary: Example of a WebRTC simulator request
                value:
                  to: '41793012345'
                  useDisabledRoutes: false
                  endpoint:
                    from: dUser
                    type: WEBRTC
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
              examples:
                Route with a SIP endpoint destination:
                  summary: Route with a SIP endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        username: '41793026834'
                        sipTrunkId: string
                        customHeaders:
                          X-Header-Name: header value
                        type: SIP
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
                Route with a phone endpoint destination:
                  summary: Route with a phone endpoint destination
                  value:
                    id: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
                    name: Sample Route Name
                    destinations:
                    - value:
                        phoneNumber: '41793026834'
                        type: PHONE
                      connectTimeout: 30
                      recording:
                        recordingType: AUDIO
                        recordingComposition:
                          enabled: true
                        customData:
                          key1: value1
                        filePrefix: recording
                      type: ENDPOINT
                    status: ENABLED
                    order: 1
                    transferOnly: false
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - callrouting:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: m
  /webrtc/1/token:
    post:
      tags:
      - channels
      summary: Generate WebRTC Token
      description: This endpoint allows you to generate token for WebRTC channel.
      operationId: generate-webrtc-token
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenRequestModel'
            examples:
              Request example:
                summary: Request example
                value:
                  identity: Alice
                  displayName: Alice in Wonderland
                  timeToLive: 43200
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenResponseModel'
              examples:
                Response example:
                  summary: Response example
                  value:
                    token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eSI6IkFsaWNlIiwibmFtZSI6IkFsaWNlIGluIFdvbmRlcmxhbmQiLCJleHAiOjE1NzkyOTA2MzgsImNhcHMiOlsyXX0.QyCMqjH8DsftChibW2Rw4EByH-eEviUp3-kHVKuJpKg
                    expirationTime: '2020-01-17T19:50:38.488589Z'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:identity:manage
  /webrtc/1/webrtc-push-config:
    get:
      tags:
      - channels
      summary: Get WebRTC push configurations
      description: Get a page of WebRTC push configurations matching the query criteria.
      operationId: get-push-configurations
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          example: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: true
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          example: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationPageResponse'
              examples:
                Response example with push configurations for different applications.:
                  summary: Response example with push configurations for different applications.
                  value:
                    results:
                    - id: 454d142b-a1ad-239a-d231-227fa335aadc3
                      name: Android Push Config Production
                      androidConfigured: true
                      iosConfigured: false
                    - id: 894c822b-d7ba-439c-a761-141f591cace7
                      name: Test Push Config
                      androidConfigured: true
                      iosConfigured: true
                    pageInfo:
                      page: 0
                      size: 2
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create WebRTC push configuration
      description: Create and configure a new WebRTC push configuration.
      operationId: save-push-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationRequest'
            examples:
              Request example with Android WebRTC push configuration:
                summary: Request example with Android WebRTC push configuration
                value:
                  name: Android Push Config Production
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
              Request example with Android and iOS WebRTC push configuration:
                summary: Request example with Android and iOS WebRTC push configuration
                value:
                  name: Test Push Config
                  ios:
                    apnsCertificateFileName: IOS_APNS_certificate.p12
                    apnsCertificateFileContent: aGVsbG8gd29ybGQ=
                    apnsCertificatePassword: strong_password
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse'
              examples:
                Response example with Android WebRTC push configuration:
                  summary: Response example with Android WebRTC push configuration
                  value:
                    id: 454d142b-a1ad-239a-d231-227fa335aadc3
                    name: Android Push Config Production
                    androidConfigured: true
                    iosConfigured: false
                Response example with Android and iOS WebRTC push configuration:
                  summary: Response example with Android and iOS WebRTC push configuration
                  value:
                    id: 894c822b-d7ba-439c-a761-141f591cace7
                    name: Test Push Config
                    androidConfigured: true
                    iosConfigured: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /webrtc/1/webrtc-push-config/{id}:
    get:
      tags:
      - channels
      summary: Get WebRTC push configuration
      description: Get a single WebRTC push configuration and its details.
      operationId: get-push-configuration
      parameters:
      - name: id
        in: path
        description: Id of the WebRTC push configuration to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 454d142b-a1ad-239a-d231-227fa335aadc3
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse'
              examples:
                Response example with Android WebRTC push configuration:
                  summary: Response example with Android WebRTC push configuration
                  value:
                    id: 454d142b-a1ad-239a-d231-227fa335aadc3
                    name: Android Push Config Production
                    androidConfigured: true
                    iosConfigured: false
                Response example with Android and iOS WebRTC push configuration:
                  summary: Response example with Android and iOS WebRTC push configuration
                  value:
                    id: 894c822b-d7ba-439c-a761-141f591cace7
                    name: Test Push Config
                    androidConfigured: true
                    iosConfigured: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update WebRTC push configuration
      description: Change details of an existing WebRTC push configuration.
      operationId: update-push-configuration
      parameters:
      - name: id
        in: path
        description: Id of the WebRTC push configuration to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 454d142b-a1ad-239a-d231-227fa335aadc3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationRequest'
            examples:
              Request example with Android WebRTC push configuration:
                summary: Request example with Android WebRTC push configuration
                value:
                  name: Android Push Config Production
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
              Request example with Android and iOS WebRTC push configuration:
                summary: Request example with Android and iOS WebRTC push configuration
                value:
                  name: Test Push Config
                  ios:
                    apnsCertificateFileName: IOS_APNS_certificate.p12
                    apnsCertificateFileContent: aGVsbG8gd29ybGQ=
                    apnsCertificatePassword: strong_password
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse'
              examples:
                Response example with Android WebRTC push configuration:
                  summary: Response example with Android WebRTC push configuration
                  value:
                    id: 454d142b-a1ad-239a-d231-227fa335aadc3
                    name: Android Push Config Production
                    androidConfigured: true
                    iosConfigured: false
                Response example with Android and iOS WebRTC push configuration:
                  summary: Response example with Android and iOS WebRTC push configuration
                  value:
                    id: 894c822b-d7ba-439c-a761-141f591cace7
                    name: Test Push Config
                    androidConfigured: true
                    iosConfigured: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete WebRTC push configuration
      description: Delete WebRTC push configuration for the given id.
      operationId: delete-push-configuration
      parameters:
      - name: id
        in: path
        description: Id of the WebRTC push configuration to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 454d142b-a1ad-239a-d231-227fa335aadc3
      responses:
        '200':
          description: Success
        '204':
          description: No content
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Patch WebRTC push configuration
      description: Change only specific fields of the WebRTC push configuration. Fields left out of the request will remain unchanged.
      operationId: patch-push-configuration
      parameters:
      - name: id
        in: path
        description: Id of the WebRTC push configuration to patch.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 454d142b-a1ad-239a-d231-227fa335aadc3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationRequest'
            examples:
              Request example with Android WebRTC push configuration:
                summary: Request example with Android WebRTC push configuration
                value:
                  name: Android Push Config Production
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
              Request example with Android and iOS WebRTC push configuration:
                summary: Request example with Android and iOS WebRTC push configuration
                value:
                  name: Test Push Config
                  ios:
                    apnsCertificateFileName: IOS_APNS_certificate.p12
                    apnsCertificateFileContent: aGVsbG8gd29ybGQ=
                    apnsCertificatePassword: strong_password
                  android:
                    privateKeyJson: "{\n  \"type\": \"service_account\",\n  \"project_id\": \"PROJECT_ID\",\n  \"private_key_id\": \"PRIVATE_KEY_ID\",\n  \"private_key\": \"PRIVATE_KEY\",\n  \"client_email\": \"FIREBASE_ADMIN_SDK_EMAIL\",\n  \"client_id\": \"CLIENT_ID\",\n  \"auth_uri\": \"https://accounts.google.com/o/oauth2/auth\",\n  \"token_uri\": \"https://oauth2.googleapis.com/token\",\n  \"auth_provider_x509_cert_url\": \"https://www.googleapis.com/oauth2/v1/certs\",\n  \"client_x509_cert_url\": \"CLIENT_X509_CERT_URL\"\n}\n"
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse'
              examples:
                Response example with Android WebRTC push configuration:
                  summary: Response example with Android WebRTC push configuration
                  value:
                    id: 454d142b-a1ad-239a-d231-227fa335aadc3
                    name: Android Push Config Production
                    androidConfigured: true
                    iosConfigured: false
                Response example with Android and iOS WebRTC push configuration:
                  summary: Response example with Android and iOS WebRTC push configuration
                  value:
                    id: 894c822b-d7ba-439c-a761-141f591cace7
                    name: Test Push Config
                    androidConfigured: true
                    iosConfigured: true
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:configuration:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /webrtc/1/files:
    get:
      tags:
      - channels
      summary: Get files
      description: Use this method to get files with pagination.
      operationId: get-files
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          example: 0
          minimum: 0
      - name: size
        in: query
        description: Number of files per page. Maximum page size is 100.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          example: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FilePageResponse'
              examples:
                Response example of the page of files.:
                  summary: Response example of the page of files.
                  value:
                    results:
                    - id: 5f4e8861-8ed7-4521-b8c8-f26346726716
                      name: 5f4e8861-8ed7-4521-b8c8-f26346726716_alice_1680266280000.png
                      fileFormat: PNG
                      size: 10780
                      creationTime: 2023-03-31T12:38:00.000+0000
                    pageInfo:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request.
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /webrtc/1/files/{id}:
    get:
      tags:
      - channels
      summary: Get file
      description: Use this method to get a single file.
      operationId: get-file
      parameters:
      - name: id
        in: path
        description: Id of the file.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 5f4e8861-8ed7-4521-b8c8-f26346726716
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FileResponse'
              examples:
                Response example of the file.:
                  summary: Response example of the file.
                  value:
                    id: 5f4e8861-8ed7-4521-b8c8-f26346726716
                    name: 5f4e8861-8ed7-4521-b8c8-f26346726716_alice_1680266280000.png
                    fileFormat: PNG
                    size: 10780
                    creationTime: 2023-03-31T12:38:00.000+0000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete file
      description: Use this method to delete a file.
      operationId: delete-file
      parameters:
      - name: id
        in: path
        description: Id of the file to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 5f4e8861-8ed7-4521-b8c8-f26346726716
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FileResponse'
              examples:
                Response example of the file.:
                  summary: Response example of the file.
                  value:
                    id: 5f4e8861-8ed7-4521-b8c8-f26346726716
                    name: 5f4e8861-8ed7-4521-b8c8-f26346726716_alice_1680266280000.png
                    fileFormat: PNG
                    size: 10780
                    creationTime: 2023-03-31T12:38:00.000+0000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /webrtc/1/files/{id}/download:
    get:
      tags:
      - channels
      summary: Download file
      description: Use this method to download a file.
      operationId: download-file
      parameters:
      - name: id
        in: path
        description: Id of the file to be downloaded.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 5f4e8861-8ed7-4521-b8c8-f26346726716
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: File binary stream response
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      - webrtc:media:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /webrtc/1/user-activity:
    get:
      tags:
      - channels
      summary: Get WebRTC user activity
      description: Get a page of a WebRTC user activity matching query criteria.
      operationId: get-user-activity
      parameters:
      - name: identity
        in: query
        description: The identity of the user on Infobip WebRTC platform.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: Alice
      - name: startTime
        in: query
        description: 'Start date and time for filtering of the user activity. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-09-10T15:30:45.125+0000
      - name: endTime
        in: query
        description: 'End date and time for filtering of the user activity. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-09-13T15:30:45.125+0000
      - name: sessionId
        in: query
        description: An identifier that links different occurrences of `activityType` within the same activity session for a user identity on the Infobip WebRTC platform. When two activity events, distinguished by their `activityType`, happen during the same user activity session, they will share the same `sessionId`.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 3f6957f0-79b3-11ef-a56e-ed504659cd80
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityPageResponse'
              examples:
                Response example of the page of user activities.:
                  summary: Response example of the page of user activities.
                  value:
                    identity: Alice
                    results:
                    - sessionId: 19442d20-79b3-11ef-a56e-ed504659cd80
                      activityType: CONNECTED
                      timestamp: 2024-09-12T08:35:00.000+0000
                    - sessionId: 19442d20-79b3-11ef-a56e-ed504659cd80
                      activityType: DISCONNECTED
                      timestamp: 2024-09-12T08:40:00.000+0000
                    - sessionId: 3f6957f0-79b3-11ef-a56e-ed504659cd80
                      activityType: CONNECTED
                      timestamp: 2024-09-12T12:35:00.000+0000
                    - sessionId: 3f6957f0-79b3-11ef-a56e-ed504659cd80
                      activityType: DISCONNECTED
                      timestamp: 2024-09-12T12:40:00.000+0000
                    pageInfo:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 4
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Missing identity in query parameter:
                  summary: Missing identity in query parameter
                  description: Missing identity in query parameter
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: identity
                      violation: must not be null
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/webrtc-calls/webrtc
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /webrtc/1/recordings:
    get:
      tags:
      - channels
      summary: Get WebRTC recordings
      description: This method allows searching and filtering based on various recording data properties.
      operationId: get-webrtc-recordings
      parameters:
      - name: sortBy
        in: query
        description: Field that will be used for sorting.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingSortColumn'
        example: START_TIME
      - name: sortDirection
        in: query
        description: Order in which files will be sorted based on sortBy field.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.SortDirection'
        example: DESC
      - name: callType
        in: query
        description: Call type of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.CallType'
        example: WEBRTC_CALL
      - name: phoneNumber
        in: query
        description: Phone number that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 41792036727
      - name: identity
        in: query
        description: WebRTC Identity that was participant of the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Alice
      - name: roomName
        in: query
        description: Name of the recorded room for ROOM_CALL call type.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: conference_room
      - name: roomId
        in: query
        description: Id of the recorded room for ROOM_CALL call type. Equivalent to conferenceId.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-05-01T14:25:45.125+0000
      - name: startTimeBefore
        in: query
        description: Date and time when the (last) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2024-05-01T14:26:45.125+0000
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 0
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.WebrtcRecordingPageResponse'
              examples:
                Response example with both composition and no composition recording responses for ROOM call type:
                  summary: Response example with both composition and no composition recording responses for ROOM call type
                  value:
                    results:
                    - application:
                        id: b4r1fcde8-df41-4209-b9a5-895db5d42e3d
                        callType: ROOM_CALL
                        roomName: Team_Meeting
                        roomId: fa6be316-39e7-4dda-8140-546fa643875f
                        startTime: 2025-10-29T16:30:31.865+0000
                        endTime: 2025-10-29T16:30:46.765+0000
                        type: WEBRTC
                      recording:
                        composedFiles:
                        - id: 7d8c1fa5-bacd-4ce9-9c8c-46f6a073fe86
                          name: 7d8c1fa5-bacd-4ce9-9c8c-46f6a073fe86.wav
                          fileFormat: WAV
                          size: 177152
                          startTime: 2025-10-29T16:30:31.865+0000
                          endTime: 2025-10-29T16:30:46.765+0000
                          creationTime: 2025-10-29T16:30:46.833+0000
                          duration: 14
                          location: HOSTED
                        callRecordings:
                        - callId: 2c96ff1d-8adb-4e95-9da4-5eb5a9bf6ff8
                          endpoint:
                            identity: Alice
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                        - callId: afe40a7d-5832-4e63-9cd4-d9d3358a9b2a
                          endpoint:
                            identity: Dolores
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                        - callId: 7d92e266-dbaf-4a7b-acda-1648e9bd8a9c
                          endpoint:
                            identity: Kevin
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                    - application:
                        id: 78q1fcde8-df41-4209-b9a5-895db5d42e3d
                        callType: ROOM_CALL
                        roomName: Team_Meeting
                        roomId: fa6be316-39e7-4dda-8140-546fa643875f
                        startTime: 2025-10-29T12:16:58.045+0000
                        endTime: 2025-10-29T12:18:01.585+0000
                        type: WEBRTC
                      recording:
                        composedFiles: []
                        callRecordings:
                        - callId: 2c96ff1d-8adb-4e95-9da4-5eb5a9bf6ff8
                          endpoint:
                            identity: Alice
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                          files:
                          - id: 5224c94a-f823-47d0-b662-10d22dca8aec
                            name: 5224c94a-f823-47d0-b662-10d22dca8aec.mp4
                            fileFormat: MP4
                            size: 2772666
                            startTime: 2025-10-29T12:16:58.045+0000
                            endTime: 2025-10-29T12:18:01.585+0000
                            creationTime: 2025-10-29T12:18:01.805+0000
                            duration: 72
                            location: HOSTED
                        - callId: afe40a7d-5832-4e63-9cd4-d9d3358a9b2a
                          endpoint:
                            identity: Dolores
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                          files:
                          - id: bb92aa66-4d0f-4846-9f5a-0f388fa892d1
                            name: bb92aa66-4d0f-4846-9f5a-0f388fa892d1.mp4
                            fileFormat: MP4
                            size: 295842
                            startTime: 2025-10-29T12:16:58.045+0000
                            endTime: 2025-10-29T12:18:01.585+0000
                            creationTime: 2025-10-29T12:18:01.796+0000
                            duration: 63
                            location: HOSTED
                        - callId: 7d92e266-dbaf-4a7b-acda-1648e9bd8a9c
                          endpoint:
                            identity: Kevin
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                          files:
                          - id: 7e125a10-6538-4187-9653-1b067a03e7e6
                            name: 7e125a10-6538-4187-9653-1b067a03e7e6.mp4
                            fileFormat: MP4
                            size: 295812
                            startTime: 2025-10-29T12:17:35.305+0000
                            endTime: 2025-10-29T12:17:58.685+0000
                            creationTime: 2025-10-29T12:18:01.765+0000
                            duration: 63
                            location: HOSTED
                    pageInfo:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
                Response example with composition recording response for WEBRTC call type:
                  summary: Response example with composition recording response for WEBRTC call type
                  value:
                    results:
                    - application:
                        id: 3a1fcde8-df41-4209-b9a5-895db5d42e3d
                        callType: WEBRTC_CALL
                        startTime: 2025-10-29T14:25:45.125+0000
                        endTime: 2025-10-29T14:26:45.125+0000
                        type: WEBRTC
                      recording:
                        composedFiles:
                        - id: 294cdf1b-70ae-4249-b384-6f267b5cf345
                          name: 294cdf1b-70ae-4249-b384-6f267b5cf345.wav
                          fileFormat: WAV
                          size: 177152
                          startTime: 2025-10-29T14:25:45.125+0000
                          endTime: 2025-10-29T14:25:55.125+0000
                          creationTime: 2025-10-29T14:25:46.125+0000
                          duration: 10
                          location: HOSTED
                          customData:
                            key: value
                        callRecordings:
                        - callId: 81a815ee-4fc2-45e3-a3eb-50277359a089
                          endpoint:
                            identity: Alice
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                        - callId: 91b925ff-5gd3-56f4-b4fc-60388460b190
                          endpoint:
                            identity: Dolores
                            type: WEBRTC
                          direction: OUTBOUND
                          status: SUCCESSFUL
                    pageInfo:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
                Response example with no composition recording response for PHONE call type:
                  summary: Response example with no composition recording response for PHONE call type
                  value:
                    results:
                    - application:
                        id: 78q1fcde8-df41-4209-b9a5-895db5d42e3d
                        callType: PHONE_CALL
                        startTime: 2025-10-29T14:35:45.125+0000
                        endTime: 2025-10-29T14:36:45.125+0000
                        type: WEBRTC
                      recording:
                        composedFiles: []
                        callRecordings:
                        - callId: 81a815ee-4fc2-45e3-a3eb-50277359a089
                          endpoint:
                            identity: Alice
                            type: WEBRTC
                          direction: INBOUND
                          status: SUCCESSFUL
                          files:
                          - id: 564202f9-4788-4766-866c-6a58f4058dac
                            name: 564202f9-4788-4766-866c-6a58f4058dac.wav
                            fileFormat: WAV
                            size: 1772666
                            startTime: 2025-10-29T14:35:45.125+0000
                            endTime: 2025-10-29T14:35:55.125+0000
                            creationTime: 2025-10-29T14:35:46.125+0000
                            duration: 10
                            location: HOSTED
                        - callId: 811b925ff-5gd3-56f4-b4fc-60388460b190
                          endpoint:
                            phoneNumber: '32475388773'
                            type: PHONE
                          direction: OUTBOUND
                          status: SUCCESSFUL
                          files:
                          - id: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b
                            name: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b.wav
                            fileFormat: WAV
                            size: 295842
                            startTime: 2025-10-29T14:35:45.125+0000
                            endTime: 2025-10-29T14:35:55.125+0000
                            creationTime: 2025-10-29T14:35:46.125+0000
                            duration: 10
                            location: HOSTED
                    pageInfo:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /webrtc/1/recordings/{id}:
    delete:
      tags:
      - channels
      summary: Delete WebRTC recording by ID
      description: This method allows deleting call recordings based on their ID.
      operationId: delete-webrtc-recording-by-id
      parameters:
      - name: id
        in: path
        description: ID of the recording to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: d8d84155-3831-43fb-91c9-bb897149a79d
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingResponse'
              examples:
                Response example of deleted recording for WEBRTC call type:
                  summary: Response example of deleted recording for WEBRTC call type
                  value:
                    application:
                      id: 3a1fcde8-df41-4209-b9a5-895db5d42e3d
                      callType: WEBRTC_CALL
                      startTime: 2025-10-29T14:25:45.125+0000
                      endTime: 2025-10-29T14:26:45.125+0000
                      type: WEBRTC
                    recording:
                      composedFiles:
                      - id: 294cdf1b-70ae-4249-b384-6f267b5cf345
                        name: 294cdf1b-70ae-4249-b384-6f267b5cf345.wav
                        fileFormat: WAV
                        size: 177152
                        startTime: 2025-10-29T14:25:45.125+0000
                        endTime: 2025-10-29T14:25:55.125+0000
                        creationTime: 2025-10-29T14:25:46.125+0000
                        duration: 10
                        location: HOSTED
                        customData:
                          key: value
                      callRecordings:
                      - callId: 81a815ee-4fc2-45e3-a3eb-50277359a089
                        endpoint:
                          identity: Alice
                          type: WEBRTC
                        direction: INBOUND
                        status: SUCCESSFUL
                      - callId: 91b925ff-5gd3-56f4-b4fc-60388460b190
                        endpoint:
                          identity: Dolores
                          type: WEBRTC
                        direction: OUTBOUND
                        status: SUCCESSFUL
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /webrtc/1/recordings/{id}/download:
    get:
      tags:
      - channels
      summary: Download WebRTC recording file
      description: This method allows downloading a WebRTC recording file based on its ID.
      operationId: download-webrtc-recording-by-id
      parameters:
      - name: id
        in: path
        description: ID of the recording to download.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: d8d84155-3831-43fb-91c9-bb897149a79d
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingLocation'
        example: FRANKFURT
      - name: Range
        in: header
        description: Range header specifies range of bytes to be returned in the response. If range header is not specified, response will return a complete file.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: bytes=0-1023
      responses:
        '200':
          description: Success
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: File binary stream response.
        '206':
          description: Partial content
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: Partial file binary stream response.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - webrtc:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /call-link/1/links:
    get:
      tags:
      - channels
      summary: Get call links
      description: Use this method to retrieve all call links.
      operationId: get-call-links
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkPage'
              examples:
                Call Link Page Response:
                  summary: Call Link Page Response
                  value:
                    results:
                    - id: r9wpIY
                      identity: john
                      displayName: John Doe
                      destination:
                        identity: bob
                        type: WEBRTC
                      customData:
                        city: New York
                        language: en
                      validityWindow:
                        oneTime: true
                        startTime: 2026-07-17T13:37:13.088+0000
                        endTime: 2026-07-18T13:37:13.088+0000
                      callLinkConfigId: 638dbdc6ecede164c3799d04
                    - id: '1234'
                      identity: jane
                      displayName: Jane Doe
                      destination:
                        identity: bob
                        type: WEBRTC
                    paging:
                      page: 0
                      size: 10
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:link:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create call link
      description: Create a link to send to someone who will then initiate a call.
      operationId: create-call-link
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkRequest'
            examples:
              Call Link:
                summary: Call Link
                value:
                  destination:
                    identity: bob
                    type: WEBRTC
                  validityWindow:
                    oneTime: true
                    startTime: 2026-07-17T13:37:13.088+0000
                    endTime: 2026-07-18T13:37:13.088+0000
                  callLinkConfigId: 638dbdc6ecede164c3799d04
              Call Link with identity:
                summary: Call Link with identity
                value:
                  identity: alice
                  destination:
                    identity: bob
                    type: WEBRTC
                  validityWindow:
                    oneTime: true
                    startTime: 2026-07-17T13:37:13.088+0000
                    endTime: 2026-07-18T13:37:13.088+0000
                  callLinkConfigId: 638dbdc6ecede164c3799d04
              Call Link with validity window:
                summary: Call Link with validity window
                value:
                  destination:
                    identity: bob
                    type: WEBRTC
                  validityWindow:
                    oneTime: true
                    startTime: 2026-07-17T13:37:13.088+0000
                    endTime: 2026-07-18T13:37:13.088+0000
                    acceptableHours:
                      start:
                        hour: 8
                        minute: 0
                      end:
                        hour: 17
                        minute: 0
                    acceptableDays:
                    - MONDAY
                    - TUESDAY
                    - WEDNESDAY
                    - THURSDAY
                    - FRIDAY
                    - SATURDAY
                    - SUNDAY
              Call Link with custom data:
                summary: Call Link with custom data
                value:
                  destination:
                    identity: bob
                    type: WEBRTC
                  customData:
                    city: New York
                    language: en
                  validityWindow:
                    oneTime: true
                    startTime: 2026-07-17T13:37:13.088+0000
                    endTime: 2026-07-18T13:37:13.088+0000
              Call Link with all options:
                summary: Call Link with all options
                value:
                  identity: alice
                  displayName: Alice
                  destination:
                    identity: bob
                    type: WEBRTC
                  customData:
                    city: New York
                    language: en
                  validityWindow:
                    oneTime: true
                    startTime: 2026-07-17T13:37:13.088+0000
                    endTime: 2026-07-18T13:37:13.088+0000
                  callLinkConfigId: 638dbdc6ecede164c3799d04
              Call link for phone destination:
                summary: Call link for phone destination
                value:
                  destination:
                    phoneNumber: '38761111222'
                    type: PHONE
              Call link for phone destination with from phone number:
                summary: Call link for phone destination with from phone number
                value:
                  destination:
                    phoneNumber: '38761111222'
                    from: '38762222333'
                    type: PHONE
              Call link for phone with machine detection:
                summary: Call link for phone with machine detection
                value:
                  destination:
                    phoneNumber: '38761111222'
                    machineDetection:
                      enabled: true
                      detectionTime: 3.7
                    type: PHONE
              Call link for viber destination:
                summary: Call link for viber destination
                value:
                  destination:
                    phoneNumber: '38762000000'
                    from: '38762111111'
                    type: VIBER
              Call link for room destination:
                summary: Call link for room destination
                value:
                  destination:
                    roomName: Conference room
                    type: ROOM
              Call link for application destination:
                summary: Call link for application destination
                value:
                  destination:
                    callsConfigurationId: 01b06592152e08646b08c056
                    type: APPLICATION
              Call link for conversations destination:
                summary: Call link for conversations destination
                value:
                  destination:
                    type: CONVERSATIONS
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkResponse'
              examples:
                Call Link Response:
                  summary: Call Link Response
                  value:
                    id: r9wpIY
                    url: https://call-link.com/r9wpIY
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:link:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 200
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/links/{id}:
    get:
      tags:
      - channels
      summary: Get call link
      description: Use this method to get a call link by its ID.
      operationId: get-call-link
      parameters:
      - name: id
        in: path
        description: ID of a call link.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLink'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:link:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete call link
      description: Use this method to delete a call link by its ID.
      operationId: delete-call-link
      parameters:
      - name: id
        in: path
        description: ID of a call link to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLink'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:link:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/configs:
    get:
      tags:
      - channels
      summary: Get configurations
      description: Use this method to retrieve all call link configurations.
      operationId: get-configs
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkConfigPage'
              examples:
                Call Link Config Page Response:
                  summary: Call Link Config Page Response
                  value:
                    results:
                    - name: Company name
                      initialOptions:
                        audio: true
                        video: false
                        muted: false
                        cameraFacingMode: FRONT
                      callOptions:
                        mute: true
                        screenShare: true
                        switchCameraFacingMode: true
                        dialPad: true
                      theme:
                        images:
                          logoImageId: 638dbe28ecede164c3799d06
                          backgroundImageId: 638dbe0cecede164c3799d05
                        messages:
                          welcomeText: Call link page
                          inactiveText: This link is no longer active.
                          expirationText: This link has expired
                        colors:
                          primary: D8D8D8
                          primaryText: '242424'
                          background: FFFFFF
                    - name: Company name
                      theme:
                        images:
                          logoImageId: 638dbe28ecede164c3799d06
                          backgroundImageId: 638dbe0cecede164c3799d05
                        messages:
                          welcomeText: Call link page
                          inactiveText: This link is no longer active.
                          expirationText: This link has expired
                        colors:
                          primary: D8D8D8
                          primaryText: '242424'
                          background: FFFFFF
                    paging:
                      page: 0
                      size: 10
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create configuration
      description: Use this method to add a new call link configuration.
      operationId: create-config
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfigRequest'
            examples:
              Call Link Config with initial options:
                summary: Call Link Config with initial options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
              Call Link Config with theme:
                summary: Call Link Config with theme
                value:
                  name: Company name
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
              Call Link Config with all options:
                summary: Call Link Config with all options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
                  callOptions:
                    mute: true
                    screenShare: true
                    switchCameraFacingMode: true
                    dialPad: true
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
              examples:
                Call Link Config Response:
                  summary: Call Link Config Response
                  value:
                    id: 638dbdc6ecede164c3799d04
                    name: Company name
                    isDefault: true
                    initialOptions:
                      audio: true
                      video: false
                      muted: false
                      cameraFacingMode: FRONT
                    callOptions:
                      mute: true
                      screenShare: true
                      switchCameraFacingMode: true
                      dialPad: true
                    theme:
                      images:
                        logoImageId: 638dbe28ecede164c3799d06
                        backgroundImageId: 638dbe0cecede164c3799d05
                      messages:
                        welcomeText: Call link page
                        inactiveText: This link is no longer active.
                        expirationText: This link has expired
                      colors:
                        primary: D8D8D8
                        primaryText: '242424'
                        background: FFFFFF
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/configs/{id}:
    get:
      tags:
      - channels
      summary: Get configuration
      description: Use this method to retrieve a call link configuration by its ID.
      operationId: get-config
      parameters:
      - name: id
        in: path
        description: ID of a call link configuration to load.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
              examples:
                Call Link Config Response:
                  summary: Call Link Config Response
                  value:
                    id: 638dbdc6ecede164c3799d04
                    name: Company name
                    isDefault: true
                    initialOptions:
                      audio: true
                      video: false
                      muted: false
                      cameraFacingMode: FRONT
                    callOptions:
                      mute: true
                      screenShare: true
                      switchCameraFacingMode: true
                      dialPad: true
                    theme:
                      images:
                        logoImageId: 638dbe28ecede164c3799d06
                        backgroundImageId: 638dbe0cecede164c3799d05
                      messages:
                        welcomeText: Call link page
                        inactiveText: This link is no longer active.
                        expirationText: This link has expired
                      colors:
                        primary: D8D8D8
                        primaryText: '242424'
                        background: FFFFFF
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update a configuration
      description: 'Use this method to overwrite a call link configuration.

        New values for configuration attributes replace the existing ones. If no value is passed,

        the attribute is set to empty or to default, if available.'
      operationId: update-config
      parameters:
      - name: id
        in: path
        description: ID of a call link configuration to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfigRequest'
            examples:
              Call Link Config with initial options:
                summary: Call Link Config with initial options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
              Call Link Config with theme:
                summary: Call Link Config with theme
                value:
                  name: Company name
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
              Call Link Config with all options:
                summary: Call Link Config with all options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
                  callOptions:
                    mute: true
                    screenShare: true
                    switchCameraFacingMode: true
                    dialPad: true
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
              examples:
                Call Link Config Response:
                  summary: Call Link Config Response
                  value:
                    id: 638dbdc6ecede164c3799d04
                    name: Company name
                    isDefault: true
                    initialOptions:
                      audio: true
                      video: false
                      muted: false
                      cameraFacingMode: FRONT
                    callOptions:
                      mute: true
                      screenShare: true
                      switchCameraFacingMode: true
                      dialPad: true
                    theme:
                      images:
                        logoImageId: 638dbe28ecede164c3799d06
                        backgroundImageId: 638dbe0cecede164c3799d05
                      messages:
                        welcomeText: Call link page
                        inactiveText: This link is no longer active.
                        expirationText: This link has expired
                      colors:
                        primary: D8D8D8
                        primaryText: '242424'
                        background: FFFFFF
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete configuration
      description: Use this method to delete a call link configuration by its ID.
      operationId: delete-config
      parameters:
      - name: id
        in: path
        description: ID of a call link configuration to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
              examples:
                Call Link Config Response:
                  summary: Call Link Config Response
                  value:
                    id: 638dbdc6ecede164c3799d04
                    name: Company name
                    isDefault: true
                    initialOptions:
                      audio: true
                      video: false
                      muted: false
                      cameraFacingMode: FRONT
                    callOptions:
                      mute: true
                      screenShare: true
                      switchCameraFacingMode: true
                      dialPad: true
                    theme:
                      images:
                        logoImageId: 638dbe28ecede164c3799d06
                        backgroundImageId: 638dbe0cecede164c3799d05
                      messages:
                        welcomeText: Call link page
                        inactiveText: This link is no longer active.
                        expirationText: This link has expired
                      colors:
                        primary: D8D8D8
                        primaryText: '242424'
                        background: FFFFFF
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Partial configuration update
      description: 'Use this method to update a call link configuration.

        New values for configuration attributes replace the existing ones. If no value is passed in the request, the attribute keeps its value.'
      operationId: patch-config
      parameters:
      - name: id
        in: path
        description: ID of a call link configuration to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfigRequest'
            examples:
              Call Link Config with initial options:
                summary: Call Link Config with initial options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
              Call Link Config with theme:
                summary: Call Link Config with theme
                value:
                  name: Company name
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
              Call Link Config with all options:
                summary: Call Link Config with all options
                value:
                  name: Company name
                  initialOptions:
                    audio: true
                    video: false
                    muted: false
                    cameraFacingMode: FRONT
                  callOptions:
                    mute: true
                    screenShare: true
                    switchCameraFacingMode: true
                    dialPad: true
                  theme:
                    images:
                      logoImageId: 638dbe28ecede164c3799d06
                      backgroundImageId: 638dbe0cecede164c3799d05
                    messages:
                      welcomeText: Call link page
                      inactiveText: This link is no longer active.
                      expirationText: This link has expired
                    colors:
                      primary: D8D8D8
                      primaryText: '242424'
                      background: FFFFFF
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
              examples:
                Call Link Config Response:
                  summary: Call Link Config Response
                  value:
                    id: 638dbdc6ecede164c3799d04
                    name: Company name
                    isDefault: true
                    initialOptions:
                      audio: true
                      video: false
                      muted: false
                      cameraFacingMode: FRONT
                    callOptions:
                      mute: true
                      screenShare: true
                      switchCameraFacingMode: true
                      dialPad: true
                    theme:
                      images:
                        logoImageId: 638dbe28ecede164c3799d06
                        backgroundImageId: 638dbe0cecede164c3799d05
                      messages:
                        welcomeText: Call link page
                        inactiveText: This link is no longer active.
                        expirationText: This link has expired
                      colors:
                        primary: D8D8D8
                        primaryText: '242424'
                        background: FFFFFF
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/images:
    get:
      tags:
      - channels
      summary: Get images
      description: Use this method to retrieve all images.
      operationId: get-images
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.ImagePage'
              examples:
                Image Page Response:
                  summary: Image Page Response
                  value:
                    results:
                    - id: 638f29f0ee8f0c1da369a722
                      name: logo.png
                      type: LOGO
                      size: 512
                    - id: 968f29f0ee8f0c1da369a545
                      name: background.jpg
                      type: BACKGROUND
                      size: 1512
                    paging:
                      page: 0
                      size: 10
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/images/upload/{type}:
    post:
      tags:
      - channels
      summary: Upload image
      description: Use this method to upload an image.
      operationId: upload-image
      parameters:
      - name: type
        in: path
        description: Image type, LOGO or BACKGROUND.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ImageType'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: 'Multipart file data of an image. Max file size of LOGO type is 1MB with max resolution of 100x100. Max file size of BACKGROUND type is 10MB with max resolution of 2000x2000. Acceptable file formats are: .jpeg, .jpg and .png.'
              required:
              - file
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse'
              examples:
                Image Response:
                  summary: Image Response
                  value:
                    id: 638f29f0ee8f0c1da369a722
                    name: logo.png
                    type: LOGO
                    size: 512
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/images/{id}:
    get:
      tags:
      - channels
      summary: Get image
      description: Use this method to get an image.
      operationId: get-image
      parameters:
      - name: id
        in: path
        description: ID of an image.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse'
              examples:
                Image Response:
                  summary: Image Response
                  value:
                    id: 638f29f0ee8f0c1da369a722
                    name: logo.png
                    type: LOGO
                    size: 512
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete image
      description: Use this method to delete a call link configuration image.
      operationId: delete-image
      parameters:
      - name: id
        in: path
        description: ID of an image to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse'
              examples:
                Image Response:
                  summary: Image Response
                  value:
                    id: 638f29f0ee8f0c1da369a722
                    name: logo.png
                    type: LOGO
                    size: 512
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/subdomains:
    get:
      tags:
      - channels
      summary: Get subdomains
      description: Use this method to get all subdomains.
      operationId: get-subdomains
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.SubdomainPage'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create subdomain
      description: Use this method to add a new call link subdomain. Maximum number of domains is 3. Cannot contain ".".
      operationId: create-subdomain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.SubdomainRequest'
            examples:
              Call Link Subdomain:
                summary: Call Link Subdomain
                value:
                  name: infobip
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.Subdomain'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/subdomains/{id}:
    delete:
      tags:
      - channels
      summary: Delete subdomain
      description: Use this method to delete a subdomain by its ID.
      operationId: delete-subdomain
      parameters:
      - name: id
        in: path
        description: ID of a call link subdomain to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.Subdomain'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - calllink:configuration:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/recordings:
    get:
      tags:
      - channels
      summary: Get call link recordings
      description: Use this method to filter and retrieve call link recordings.
      operationId: get-call-link-recordings
      parameters:
      - name: sortBy
        in: query
        description: Field that will be used for sorting.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingSortColumn'
        example: START_TIME
      - name: sortDirection
        in: query
        description: Order in which files will be sorted based on sortBy field.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SortDirection'
        example: DESC
      - name: destinationData
        in: query
        description: Destination the call was made towards. For WEBRTC calls, this is the WebRTC identity. For PHONE calls, this is the phone number. For ROOM calls, this is the room name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: '+1234567890'
      - name: destinationType
        in: query
        description: Type of call link destination.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkDestination'
        example: PHONE
      - name: callLinkConfigId
        in: query
        description: ID of the call link configuration used to establish the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 685bede487a709487c584f91
      - name: callLinkId
        in: query
        description: ID of a call link used to establish the recorded call.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 55a523d1-b769-4466-a4a9-f610899569e5
      - name: startTimeAfter
        in: query
        description: Date and time when the (first) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2025-01-01T00:00:00.000+0000
      - name: startTimeBefore
        in: query
        description: Date and time when the (last) call recording started.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2025-01-01T00:00:00.000+0000
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingLocation'
        example: FRANKFURT
      - name: page
        in: query
        description: Page number for pagination, starting from 0.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of items per page, maximum is 100.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.RecordingPage'
              examples:
                Recording Page:
                  summary: Recording Page
                  value:
                  - application:
                      id: 2e75743a-7626-425c-879c-19e7f6111359
                      callLinkId: 34QubX
                      callLinkConfigId: 63f742074d09a250fdc74025
                      destinationType: PHONE
                      destinationData: '+1234567890'
                      type: CALL_LINK
                    recording:
                      composedFiles:
                      - id: d8d84155-3831-43fb-91c9-bb897149a79d
                        name: d8d84155-3831-43fb-91c9-bb897149a79d_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        startTime: 2024-05-01T14:25:45.125+0000
                        endTime: 2024-05-01T14:26:45.125+0000
                        creationTime: 2024-05-01T14:26:48.125+0000
                        duration: 60
                        location: HOSTED
                        customData:
                          key1: value1
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-bb897149a79d
                        endpoint:
                          identity: phoneCaller
                          displayName: null
                          type: WEBRTC
                        direction: INBOUND
                        status: SUCCESSFUL
                        files:
                        - id: 564202f9-4788-4766-866c-6a58f4058dac
                          name: 564202f9-4788-4766-866c-6a58f4058dac.wav
                          fileFormat: WAV
                          size: 123456
                          startTime: 2024-05-01T14:25:45.125+0000
                          endTime: 2024-05-01T14:26:45.125+0000
                          creationTime: 2024-05-01T14:26:48.125+0000
                          duration: 60
                          location: HOSTED
                          customData:
                            key1: value1
                      - callId: 9b793eeb-31e7-4a39-bf24-a267777b0313
                        endpoint:
                          phoneNumber: '32475388773'
                          type: PHONE
                        direction: OUTBOUND
                        status: SUCCESSFUL
                        files:
                        - id: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b
                          name: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b.wav
                          fileFormat: WAV
                          size: 123456
                          startTime: 2024-05-01T14:25:45.125+0000
                          endTime: 2024-05-01T14:26:45.125+0000
                          creationTime: 2024-05-01T14:26:48.125+0000
                          duration: 60
                          location: HOSTED
                          customData:
                            key1: value1
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice:recording:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/recordings/{id}:
    delete:
      tags:
      - channels
      summary: Delete call link recording
      description: Use this method to delete a call link recording by its ID.
      operationId: delete-call-link-recording
      parameters:
      - name: id
        in: path
        description: ID of the recording to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 55a523d1-b769-4466-a4a9-f610899569e5
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingLocation'
        example: FRANKFURT
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73e6f414ccb2e1e41274c061b50cf5765f69b642a3e0cca54b0248eb3baf086d.RecordingResponse'
              examples:
                Recording Response:
                  summary: Recording Response
                  value:
                    application:
                      id: 2e75743a-7626-425c-879c-19e7f6111359
                      callLinkId: 34QubX
                      callLinkConfigId: 63f742074d09a250fdc74025
                      destinationType: PHONE
                      destinationData: '+1234567890'
                      type: CALL_LINK
                    recording:
                      composedFiles:
                      - id: d8d84155-3831-43fb-91c9-bb897149a79d
                        name: d8d84155-3831-43fb-91c9-bb897149a79d_1652725357412.wav
                        fileFormat: WAV
                        size: 67564
                        startTime: 2024-05-01T14:25:45.125+0000
                        endTime: 2024-05-01T14:26:45.125+0000
                        creationTime: 2024-05-01T14:26:48.125+0000
                        duration: 60
                        location: HOSTED
                        customData:
                          key1: value1
                      callRecordings:
                      - callId: d8d84155-3831-43fb-91c9-bb897149a79d
                        endpoint:
                          identity: phoneCaller
                          displayName: null
                          type: WEBRTC
                        direction: INBOUND
                        status: SUCCESSFUL
                        files:
                        - id: 564202f9-4788-4766-866c-6a58f4058dac
                          name: 564202f9-4788-4766-866c-6a58f4058dac.wav
                          fileFormat: WAV
                          size: 123456
                          startTime: 2024-05-01T14:25:45.125+0000
                          endTime: 2024-05-01T14:26:45.125+0000
                          creationTime: 2024-05-01T14:26:48.125+0000
                          duration: 60
                          location: HOSTED
                          customData:
                            key1: value1
                      - callId: 9b793eeb-31e7-4a39-bf24-a267777b0313
                        endpoint:
                          phoneNumber: '32475388773'
                          type: PHONE
                        direction: OUTBOUND
                        status: SUCCESSFUL
                        files:
                        - id: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b
                          name: c8f2817c-e2cd-47f1-ac40-2558d74c5c7b.wav
                          fileFormat: WAV
                          size: 123456
                          startTime: 2024-05-01T14:25:45.125+0000
                          endTime: 2024-05-01T14:26:45.125+0000
                          creationTime: 2024-05-01T14:26:48.125+0000
                          duration: 60
                          location: HOSTED
                          customData:
                            key1: value1
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice:recording:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /call-link/1/recordings/files/{fileId}:
    get:
      tags:
      - channels
      summary: Download a recording file
      description: Use this method to download a recording file by its ID.
      operationId: download-call-link-recording
      parameters:
      - name: fileId
        in: path
        description: File ID to match.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: d8d84155-3831-43fb-91c9-bb897149a79d
      - name: location
        in: query
        description: Recording location.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingLocation'
        example: FRANKFURT
      - name: Range
        in: header
        description: Range header specifies range of bytes to be returned by the response. If range header is not specified, response will return a complete file.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: bytes=0-1023
      responses:
        '200':
          description: Recording file downloaded successfully.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
                description: File binary stream response
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          field:
                          - field must not be null.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found.
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - voice:recording:manage
      - calllink:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 0
        timeUnit: s
  /email/4/messages:
    post:
      tags:
      - channels
      summary: Send email messages
      description: 99% of all use cases can be achieved by using this API method. Everything from sending a simple single message to a single destination, up to batch sending of personalized messages to the thousands of recipients with a single API request. Scheduling and every advanced feature you can think of is supported.
      externalDocs:
        description: Learn more about Email channel and use cases
        url: https://www.infobip.com/docs/email
      operationId: send-email-messages-api
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequest'
            examples:
              Email with text with single destination:
                summary: Email with text with single destination
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                    content:
                      subject: Test message
                      text: Test body
              Email with template with multiple destination:
                summary: Email with template with multiple destination
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                        placeholders: '{"customer_name":"John Smith"}'
                      - destination: mike.smith@company.com
                        placeholders: '{"customer_name":"Mike Smith"}'
                    content:
                      templateId: '322307'
                      defaultPlaceholders: '{"date":"20/03/2018","customer_name":"John Smith"}'
              Email with HTML and placeholders with single destination:
                summary: Email with HTML and placeholders with single destination
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                        placeholders: '{"destination_ph":"Destination placeholder"}'
                    content:
                      subject: Test message
                      html: '<h1>Html body</h1>

                        <p>Rich HTML message body.</p>

                        <div>Example with default placeholders: {{default_ph}}</div>

                        <div>Example with personalized placeholders: {{to_ph}}</div>'
                      defaultPlaceholders: '{"default_ph":"Default placeholder"}'
              Email with tracking options with multiple destinations:
                summary: Email with tracking options with multiple destinations
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                      cc:
                      - destination: bob.smith@somecompany.com
                      bcc:
                      - destination: alice.doe@somecompany.com
                    content:
                      subject: Test message
                      html: '<h1>Html body</h1>

                        <p>Rich HTML message body.</p>

                        <div>This is link that will be shortened and tracked <a href="https://www.infobip.com">link</a></div>'
                  options:
                    schedule: {}
                    tracking: {}
                    clientPriority: STANDARD
              Email with attachments:
                summary: Email with attachments
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                    content:
                      subject: Test message
                      text: Text
                      attachments:
                      - type: binary
                        content: Q29udGVudA==
                        contentType: image/png
                        fileName: image.png
                      - type: uploadedReference
                        contentId: B44419205B27012D82F3BAD7B7EB37BA157EB26DCA268BD7C62F235165E04EB55EA620E2BB59715F3442C43852922601D294
              Email with template ID:
                summary: Email with template ID
                value:
                  messages:
                  - destinations:
                    - to:
                      - destination: john.smith@company.com
                    content:
                      templateId: '100000000123456'
              Email with IP pool ID:
                summary: Email with IP pool ID
                value:
                  messages:
                  - destinations:
                    - to:
                      - destination: john.smith@company.com
                    content:
                      subject: Test message
                      text: Test body
                    ips:
                      ipPoolId: 08A3A7608750CC6E6080325A6ADF45B6
              Email with masked placeholders:
                summary: Email with masked placeholders
                value:
                  messages:
                  - sender: jenny.smith@company.com
                    destinations:
                    - to:
                      - destination: john.smith@company.com
                        placeholders: '{"name": "JohnDoe", "email": "test@example.com", "phone": "41793026727"}'
                    content:
                      subject: Masking sensitive placeholders , Hi {{name}}, {{email}} , {{phone}}
                      html: Test body {{ph1}} {{ph2}}
                      defaultPlaceholders: '{"ph1": "Default", "ph2": "HideWholePlaceholder"}'
                    placeholdersMasking:
                    - name: ph1
                      side: L
                      maskChar: '='
                      visibleChars: 3
                    - name: ph2
                      maskChar: '#'
                      skipChars:
                      - W
                    - name: name
                      side: R
                      maskChar: +
                      visibleChars: 2
                    - name: email
                      side: L
                      maskChar: '='
                      delimiter: '@'
                      skipChars:
                      - _
                    - name: phone
                      side: L
                      maskChar: +
                      skipChars:
                      - '-'
                      - (
                      - )
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailResponse'
              examples:
                Success response:
                  summary: Success response
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: john.smith@company.com
                Success response with multiple destinations:
                  summary: Success response with multiple destinations
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: john.smith@company.com
                    - messageId: 2211d97c-53432-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: john.doe@company.com
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - email:message:send
      - email:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: send-email-messages-api
      - versionNumber: 3
        latest: false
        operationId: send-fully-featured-email
  /email/1/content:
    post:
      tags:
      - channels
      summary: Upload binary content
      description: This method allows you to upload binary content that you can reference when sending Email messages.
      operationId: upload-binary-content
      parameters:
      - name: X-Content-Id
        in: header
        description: Content ID that uniquely identifies the binary content.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: image_1_jpg
      - name: X-Media-Type
        in: header
        description: Content mime type. Should be populated by standard MIME types (IANA media types).
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: image/jpeg
      - name: X-Validity-Period-Minutes
        in: header
        description: Validity period in minutes after which the content will be deleted.
        required: false
        style: simple
        explode: false
        schema:
          type: string
          maximum: 10080
          minimum: 1440
        example: 3000
      requestBody:
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
            examples:
              cURL:
                summary: cURL
                description: cURL
                value: 'curl -L -X POST ''https://{baseUrl}/email/1/content'' \

                  -H ''Authorization: {authorization}'' \

                  -H ''Content-Type: application/octet-stream'' \

                  -H ''Accept: application/json'' \

                  -H ''X-Media-Type: image/jpeg'' \

                  -H ''X-Content-Id: image_1_jpg'' \

                  --data-binary "@/path/to/image1.jpg"

                  '
              HTTP:
                summary: HTTP
                description: HTTP
                value: 'POST /email/1/content HTTP/1.1

                  Host: {baseUrl}

                  Authorization: {authorization}

                  Content-Type: application/octet-stream

                  Accept: application/json

                  X-Content-Id: image_1_jpg

                  X-Media-Type: image/jpeg


                  (data)'
      responses:
        '200':
          description: Successful Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.UploadBinaryResult'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiErrorResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    bulkId: ''
                    messages: []
                    errorMessage: Required request header 'X-Content-Id' for method parameter type String is not present
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 500
        numberOfTimeUnits: 0
        timeUnit: s
  /email/3/send:
    post:
      tags:
      - channels
      summary: Send fully featured email
      description: Send an email or multiple emails to a recipient or multiple recipients with CC/BCC enabled.
      operationId: send-fully-featured-email
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendRequestSchema'
            examples:
              Send fully featured email using curl:
                summary: Send fully featured email using curl
                description: Send fully featured email using curl
                value: '

                  curl --request POST ''https://{base_url}/email/3/send'' \

                  --header ''Authorization: Basic {username:password}'' \

                  --form ''from="Jane Smith <jane.smith@somecompany.com>"'' \

                  --form ''to="john.smith@somedomain.com"'' \

                  --form ''to="alice.smith@somedomain.com"'' \

                  --form-string ''to={"to": "alice.grey@somecompany.com", "placeholders": {"name":"Alice"}}'' \

                  --form ''replyTo="all.replies@somedomain.com"'' \

                  --form ''subject="Mail subject text and placeholder ph1"'' \

                  --form ''text="Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}"'' \

                  --form ''html="<h1>Html body</h1><p>Rich HTML message body.</p>"'' \

                  --form ''attachment=@"/home/user/image.png"'' \

                  --form ''bulkId="customBulkId"'' \

                  --form ''intermediateReport="true"'' \

                  --form-string ''defaultPlaceholders={"ph1": "Success", "ph2": "Example"}'' \

                  --form-string ''headers={"List-Unsubscribe": "your unsubscribe link", "X-Custom-Header": "Header value"}'' \

                  --form ''notifyUrl="https://www.example.com/email/advanced"'' \

                  --form ''notifyContentType="application/json"'' \

                  --form ''trackClicks="true"'' \

                  --form ''trackOpens="false"'' \

                  --form ''trackingPixelPosition="TOP"'' \

                  --form ''callbackData="DLR callback data"''

                  --form ''ipPoolId="08A3A7608750CC6E6080325A6ADF45B6"''

                  '
              Send fully featured with preserved recipients email using curl:
                summary: Send fully featured with preserved recipients email using curl
                description: Send fully featured with preserved recipients email using curl
                value: '

                  curl --request POST ''https://{base_url}/email/3/send'' \

                  --header ''Authorization: Basic {username:password}'' \

                  --form ''from="Jane Smith <jane.smith@somecompany.com>"'' \

                  --form ''to="john.smith@somedomain.com"'' \

                  --form ''to="alice.smith@somedomain.com"'' \

                  --form-string ''to={"to": "alice.grey@somecompany.com", "placeholders": {"name":"Alice"}}'' \

                  --form-string ''cc={"to": "jane.grey@somecompany.com", "placeholders": {"name":"Jane"}}'' \

                  --form ''bcc=""eve.grey@somecompany.com"'' \

                  --form ''replyTo="all.replies@somedomain.com"'' \

                  --form ''subject="Mail subject text and placeholder ph1"'' \

                  --form ''text="Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}"'' \

                  --form ''html="<h1>Html body</h1><p>Rich HTML message body.</p>"'' \

                  --form ''attachment=@"/home/user/image.png"'' \

                  --form ''bulkId="customBulkId"'' \

                  --form ''intermediateReport="true"'' \

                  --form-string ''defaultPlaceholders={"ph1": "Success", "ph2": "Example"}'' \

                  --form-string ''headers={"List-Unsubscribe": "your unsubscribe link", "X-Custom-Header": "Header value"}'' \

                  --form ''notifyUrl="https://www.example.com/email/advanced"'' \

                  --form ''notifyContentType="application/json"'' \

                  --form ''trackClicks="true"'' \

                  --form ''trackOpens="false"'' \

                  --form ''trackingPixelPosition="TOP"'' \

                  --form ''callbackData="DLR callback data"''

                  --form ''ipPoolId="08A3A7608750CC6E6080325A6ADF45B6"''

                  '
              Send fully featured email using Java:
                summary: Send fully featured email using Java
                description: Send fully featured email using Java
                value: "\nimport org.springframework.core.io.FileSystemResource;\nimport org.springframework.http.*;\nimport org.springframework.util.LinkedMultiValueMap;\nimport org.springframework.web.client.RestTemplate;\nimport java.io.File;        \n        \nvar body = new LinkedMultiValueMap<String, Object>();\nbody.add(\"from\", \"Jane Smith <jane.smith@somecompany.com>\");\nbody.add(\"to\", \"john.smith@somedomain.com\");\nbody.add(\"to\", \"alice.smith@somedomain.com\");\nbody.add(\"to\", \"{\\\"to\\\": \\\"alice.grey@somecompany.com\\\", \\\"placeholders\\\": {\\\"name\\\": \\\"Alice\\\"}}\");\nbody.add(\"cc\", \"{\\\"to\\\": \\\"jane.grey@somecompany.com\\\", \\\"placeholders\\\": {\\\"name\\\": \\\"Jane\\\"}}\");\nbody.add(\"replyTo\", \"all.replies@somedomain.com\");\nbody.add(\"subject\", \"Mail subject text and placeholder ph1\");\nbody.add(\"text\", \"Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}\");\nbody.add(\"html\", \"<h1>Html body</h1><p>Rich HTML message body.</p>\");\nbody.add(\"attachment\", new FileSystemResource(new File(\"/home/user/file.zip\")));\nbody.add(\"bulkId\", \"customBulkId\");\nbody.add(\"intermediateReport\", \"true\");\nbody.add(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\");\nbody.add(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\");\nbody.add(\"notifyUrl\", \"https://www.example.com/email/advanced\");\nbody.add(\"notifyContentType\", \"application/json\");\nbody.add(\"trackClicks\", \"true\");\nbody.add(\"trackOpens\", \"false\");\nbody.add(\"trackingPixelPosition\", \"TOP\");\nbody.add(\"callbackData\", \"DLR callback data\");\nbody.add(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\nvar headers = new HttpHeaders();\nheaders.setContentType(MediaType.MULTIPART_FORM_DATA);\nheaders.add(\"Authorization\", \"Basic {username:password}\");\nvar entity = new HttpEntity<>(body, headers);\nvar restTemplate = new RestTemplate();\nrestTemplate.postForEntity(\"https://{base_url}/email/3/send\", entity, String.class);\n"
              Send fully featured email - HTTP:
                summary: Send fully featured email - HTTP
                description: Send fully featured email - HTTP
                value: "\nPOST /email/3/send HTTP/1.1\nHost: {base_url}\nAuthorization: Basic {username:password}\nContent-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW\n            \n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"from\"\n            \nJane Smith <jane.smith@somecompany.com>\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"to\"\n            \njohn.smith@somedomain.com\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"to\"\n            \nalice.smith@somedomain.com\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"to\"\n            \n{\"to\": \"alice.grey@somecompany.com\",\"placeholders\": {\"name\": \"Alice\"}}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"cc\"\n\n{\"to\": \"jane.grey@somecompany.com\",\"placeholders\": {\"name\": \"Jane\"}}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"replyTo\"\n            \njack.smith@somedomain.com\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"subject\"\n            \nMail subject text and placeholder ph1\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"text\"\n            \nDear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"html\"\n            \n<h1>Html body</h1><p>Rich HTML message body.</p>\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"attachment\"; filename=\"file.zip\"\n            \n(data)\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"bulkId\"\n            \ncustomBulkId\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"intermediateReport\"\n            \ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"defaultPlaceholders\"\n            \n{\"ph1\": \"Success\", \"ph2\": \"Example\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"headers\"\n            \n{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header\"}\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyUrl\"\n            \nhttps://www.example.com/email/advanced\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"notifyContentType\"\n            \napplication/json\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackClicks\"\n\ntrue\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackOpens\"\n\nfalse\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"trackingPixelPosition\"\n\nTOP\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"callbackData\"\n            \nDLR callback data\n------WebKitFormBoundary7MA4YWxkTrZu0gW\nContent-Disposition: form-data; name=\"ipPoolId\"\n\n08A3A7608750CC6E6080325A6ADF45B6\n------WebKitFormBoundary7MA4YWxkTrZu0gW--\n"
              Send fully featured email using PHP:
                summary: Send fully featured email using PHP
                description: Send fully featured email using PHP
                value: "\n<?php\n   require_once 'HTTP/Request2.php';\n   $request = new HTTP_Request2();\n   $request->setUrl('https://{base_url}/email/3/send');\n   $request->setMethod(HTTP_Request2::METHOD_POST);\n   $request->setConfig(array(\n     'follow_redirects' => TRUE\n   ));\n   $request->setHeader(array(\n     'Authorization' => 'Basic {username:password}',\n     'Content-Type' => 'multipart/form-data'\n   ));\n            \n   $request->addPostParameter(array(\n     'from' => 'Jane Smith <jane.smith@somecompany.com>',\n     'to' => ['john.smith@somedomain.com', 'alice.smith@somedomain.com', '{\"to\": \"alice.grey@somecompany.com\", \"placeholders\": {\"Name\":\"John Doe\"}}'],\n     'cc' => '{\"to\": \"jane.grey@somecompany.com\", \"placeholders\": {\"Name\":\"Jane\"}}'\n     'replyTo' => 'all.replies@somedomain.com',\n     'subject' => 'Mail subject text and placeholder ph1',\n     'text' => 'Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}',\n     'html' => '<h1>Html body</h1><p>Rich HTML message body.</p>',\n     'bulkId' => 'customBulkId',\n     'intermediateReport' => 'true',\n     'defaultPlaceholders' => '{\"ph1\": \"Success\", \"ph2\": \"Example\"}'\n     'headers' => '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-Custom-Header\": \"HeaderValue\"}'\n     'notifyUrl' => 'https://www.example.com/email/advanced',\n     'notifyContentType' => 'application/json',\n     'trackClicks' => 'true',\n     'trackOpens' => 'false',\n     'trackingPixelPosition' => 'TOP',\n     'callbackData' => 'DLR callback data',\n     'ipPoolId' => '08A3A7608750CC6E6080325A6ADF45B6'\n   ));\n            \n   $request->addUpload('attachment', '/home/files/image.jpg', 'image.jpg', '<Content-Type Header>');         \n     try {\n       $response = $request->send();\n       if ($response->getStatus() == 200) {\n         echo $response->getBody();\n       } else {\n           echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .\n           $response->getBody();\n         } \n       } catch(HTTP_Request2_Exception $e) {\n          echo 'Error: ' . $e->getMessage();\n       }\n?>\n"
              Send fully featured email using C#:
                summary: Send fully featured email using C#
                description: Send fully featured email using C#
                value: '

                  var client = new RestClient("https://{base_url}/email/3/send");

                  var request = new RestRequest(Method.POST);

                  request.AddHeader("Authorization", "Basic {username:password}");

                  request.AlwaysMultipartFormData = true;

                  request.AddParameter("from", "Jane Smith <jane.smith@somecompany.com>");

                  request.AddParameter("to", "john.smith@somedomain.com");

                  request.AddParameter("to", "alice.smith@somedomain.com");

                  request.AddParameter("to", "{"to": "alice.grey@somecompany.com", "placeholders": {"name": "Alice"}}")

                  request.AddParameter("cc", "{"to": "jane.grey@somecompany.com", "placeholders": {"name": "Jane"}}")

                  request.AddParameter("replyTo", "all.replies@somedomain.com");

                  request.AddParameter("subject", "Mail subject text and placeholder ph1");

                  request.AddParameter("text", "Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}");

                  request.AddParameter("html", "<h1>Html body</h1><p>Rich HTML message body.</p>");

                  request.AddParameter("attachment", "@files/image1.jpg");

                  request.AddParameter("bulkId", "customBulkId");

                  request.AddParameter("intermediateReport", "true");

                  request.AddParameter("defaultPlaceholders", "{"ph1": "Success", "ph2": "Example"}")

                  request.AddParameter("headers", "{"List-Unsubscribe": "your unsubscribe link", "X-Custom-Header": "Header value"}")

                  request.AddParameter("notifyUrl", "https://www.example.com/email/advanced");

                  request.AddParameter("notifyContentType", "application/json");

                  request.AddParameter("trackClicks", "true");

                  request.AddParameter("trackOpens", "false");

                  request.AddParameter("trackingPixelPosition", "TOP");

                  request.AddParameter("callbackData", "DLR callback data");

                  request.AddParameter("ipPoolId", "08A3A7608750CC6E6080325A6ADF45B6");

                  IRestResponse response = client.Execute(request);

                  Console.WriteLine(response.Content);

                  '
              Send fully featured email using JavaScript:
                summary: Send fully featured email using JavaScript
                description: Send fully featured email using JavaScript
                value: "\nconst data = new FormData();\ndata.append(\"from\", \"Jane Smith <jane.smith@somecompany.com>\");\ndata.append(\"to\", \"john.smith@somedomain.com\");\ndata.append(\"to\", \"alice.smith@somedomain.com\");\ndata.append(\"to\", \"{\\\"to\\\": \\\"alice.grey@somecompany.com\\\", \\\"placeholders\\\": {\\\"name\\\": \\\"Alice\\\"}}\")\ndata.append(\"cc\", \"{\\\"to\\\": \\\"jane.grey@somecompany.com\\\", \\\"placeholders\\\": {\\\"name\\\": \\\"Jane\\\"}}\")\ndata.append(\"replyTo\", \"all.replies@somedomain.com\");\ndata.append(\"subject\", \"Mail subject text and placeholder ph1\");\ndata.append(\"text\", \"Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}\");\ndata.append(\"html\", \"<h1>Html body</h1><p>Rich HTML message body.</p>\");\ndata.append(\"attachment\", \"@files/image1.jpg\");\ndata.append(\"bulkId\", \"customBulkId\");\ndata.append(\"intermediateReport\", \"true\");\ndata.append(\"defaultPlaceholders\", \"{\\\"ph1\\\": \\\"Success\\\", \\\"ph2\\\": \\\"Example\\\"}\")\ndata.append(\"headers\", \"{\\\"List-Unsubscribe\\\": \\\"your unsubscribe link\\\", \\\"X-Custom-Header\\\": \\\"Header value\\\"}\")\ndata.append(\"notifyUrl\", \"https://www.example.com/email/advanced\");\ndata.append(\"notifyContentType\", \"application/json\");\ndata.append(\"trackClicks\", \"true\");\ndata.append(\"trackOpens\", \"false\");\ndata.append(\"trackingPixelPosition\", \"TOP\");\ndata.append(\"callbackData\", \"DLR callback data\");\ndata.append(\"ipPoolId\", \"08A3A7608750CC6E6080325A6ADF45B6\");\n\nconst xhr = new XMLHttpRequest();\nxhr.withCredentials = true;\n\nxhr.addEventListener(\"readystatechange\", function() {\n    if (this.readyState === 4) {\n        console.log(this.responseText);\n    }\n});\n\nxhr.open(\"POST\", \"https://{{baseUrl}}}}/email/3/send\");\nxhr.setRequestHeader(\"Authorization\", \"Basic {username:password}\");\nxhr.send(data);\n"
              Send fully featured email using Python:
                summary: Send fully featured email using Python
                description: Send fully featured email using Python
                value: "\nimport requests\nimport json\n            \nurl = 'https://{base_url}/email/3/send'\nheaders = {'Authorization': 'Basic {username:password}'}\n            \nfile = open('files/image1.jpg', 'rb')\nfiles = {'attachment': ('image1.jpg', file)}\n            \ndata = {\n    'from': 'Jane Smith <jane.smith@somecompany.com>',\n    'to': [\n        'john.smith@somedomain.com',\n        'alice.smith@somedomain.com',\n        json.dumps({\n            'to': 'alice.grey@somecompany.com',\n             'placeholders': {'name': 'Alice'}\n        })\n    ],\n    'cc': json.dumps({\n          'to': 'jane.grey@somecompany.com',\n          'placeholders': {'name': 'Jane'}\n    }),\n    'replyTo': 'all.replies@somedomain.com',\n    'subject': 'Mail subject text and placeholder ph1',\n    'text': 'Dear {{name}}, this is mail body text with placeholders in body {{ph1}} and {{ph2}}',\n    'html': '<h1>Html body</h1><p>Rich HTML message body.</p>',\n    'attachment': '@/files/image1.jpg',\n    'bulkId': 'customBulkId',\n    'intermediateReport': 'true',\n    'defaultPlaceholders': '{\"ph1\": \"Success\", \"ph2\": \"Example\"}',\n    'headers': '{\"List-Unsubscribe\": \"your unsubscribe link\", \"X-CustomHeader\": \"Header value\"}',\n    'notifyUrl': 'https://www.example.com/email/advanced',\n    'notifyContentType': 'application/json',\n    'trackClicks': true,\n    'trackOpens': false,\n    'trackingPixelPosition': 'TOP',\n    'callbackData': 'DLR callback data'\n    'ipPoolId': '08A3A7608750CC6E6080325A6ADF45B6'\n}\n\nresponse = requests.post(url, headers=headers, data=data, files=files)\nfile.close()\nprint(response.text)\n"
      responses:
        '200':
          description: Successful Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse'
              examples:
                Example for single message:
                  summary: Example for single message
                  description: Example for single message
                  value:
                    bulkId: snxemd8u52v7v84iiu69
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: jgzra46v9zi1ztvd62t5
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                Example for single message with custom ID:
                  summary: Example for single message with custom ID
                  description: Example for single message with custom ID
                  value:
                    bulkId: customBulkId
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: jgzra46v9zi1ztvd62t5
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                Example for multiple message:
                  summary: Example for multiple message
                  description: Example for multiple message
                  value:
                    bulkId: 4pk1xihiy4rln2f1g2se
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: tu5k6tdo7df1bpgk7ggs
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                    - to: jane.doe@somecompany.com
                      messageId: e7zzb1v9yirml2se9zo4
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-additional-throttling-information:
        Learn more about custom throttling limits: https://www.infobip.com/docs/api
      x-scopes:
      - message:send
      - email:message:send
      - email:manage
      x-additionalInfo:
        markdown: '### Related

          - [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)

          - [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)

          - [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)

          '
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: send-email-messages-api
      - versionNumber: 3
        latest: false
        operationId: send-fully-featured-email
  /email/4/mime:
    post:
      tags:
      - channels
      summary: Send MIME email
      description: Send an email where you can specify the content as MIME message.
      operationId: send-mime-email
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema'
            examples:
              Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.:
                summary: Send email with single recipient using MIME
                description: Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and single To recipient.
                value:
                  messageId: requestMessageId
                  from: jenny.smith@company.com
                  destinations:
                  - john.smith@company
                  mimeMessage: RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo0ODoyMyArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF8xNDkzMzcyMS4xNzUwMjQzNzAzMTY0Ig0KWC1JQi1idWxrLWlkOiBkZWZhdWx0QnVsa0lkDQoNCi0tLS0tLT1fUGFydF8wXzE0OTMzNzIxLjE3NTAyNDM3MDMxNjQNCkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQ0KQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdA0KDQpIZWxsbyB3b3JsZA0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NA0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfMTQ5MzM3MjEuMTc1MDI0MzcwMzE2NC0tDQo=
              Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.:
                summary: Send email with multiple recipients using MIME
                description: Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, and multiple To recipients.
                value:
                  messageId: requestMessageId
                  from: jenny.smith@company.com
                  destinations:
                  - john.smith@company
                  - mike.smith@company
                  mimeMessage: RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1MTo1NiArMDIwMCAoQ0VTVCkNCkZyb206IGplbm55LnNtaXRoQGNvbXBhbnkuY29tDQpUbzogam9obi5zbWl0aEBjb21wYW55LmNvbSwgbWlrZS5zbWl0aEBjb21wYW55LmNvbQ0KTWVzc2FnZS1JRDogPG1lc3NhZ2VAaWQ+DQpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QNCk1JTUUtVmVyc2lvbjogMS4wDQpDb250ZW50LVR5cGU6IG11bHRpcGFydC9taXhlZDsgDQoJYm91bmRhcnk9Ii0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1NyINClgtSUItYnVsay1pZDogZGVmYXVsdEJ1bGtJZA0KDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L3BsYWluOyBjaGFyc2V0PXVzLWFzY2lpDQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0DQoNCkhlbGxvIHdvcmxkDQotLS0tLS09X1BhcnRfMF85NDM3NDk5MDIuMTc1MDI0MzkxNjE1Nw0KQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkNCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IDdiaXQNCg0KPGRpdj5IZWxsbyB3b3JsZDwvZGl2Pg0KLS0tLS0tPV9QYXJ0XzBfOTQzNzQ5OTAyLjE3NTAyNDM5MTYxNTctLQ0K
              ? Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.
              : summary: Send email with multiple recipients using complex MIME
                description: Example request with mimeMessage as a base64-encoded MIME string containing HTML, text, attachments and To, Cc and Bcc recipients.
                value:
                  messageId: requestMessageId
                  from: jenny.smith@company.com
                  destinations:
                  - john.smith@company
                  - mike.smith@company
                  - jenny.smith@company
                  mimeMessage: RGF0ZTogV2VkLCAxOCBKdW4gMjAyNSAxMjo1NTozNiArMDIwMCAoQ0VTVCkKRnJvbTogamVubnkuc21pdGhAY29tcGFueS5jb20KVG86IGpvaG4uc21pdGhAY29tcGFueS5jb20KQ2M6IG1pa2Uuc21pdGhAY29tcGFueS5jb20KQmNjOiBqZW5ueS5zbWl0aEBjb21wYW55Ck1lc3NhZ2UtSUQ6IDxtZXNzYWdlQGlkPgpTdWJqZWN0OiBUaGlzIGlzIHN1YmplY3QKTUlNRS1WZXJzaW9uOiAxLjAKQ29udGVudC1UeXBlOiBtdWx0aXBhcnQvbWl4ZWQ7CiBib3VuZGFyeT0iLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0IgpYLUlCLWJ1bGstaWQ6IGRlZmF1bHRCdWxrSWQKCi0tLS0tLT1fUGFydF8wXzY1OTQ5NDU5OS4xNzUwMjQ0MTM1OTg0CkNvbnRlbnQtVHlwZTogdGV4dC9wbGFpbjsgY2hhcnNldD11cy1hc2NpaQpDb250ZW50LVRyYW5zZmVyLUVuY29kaW5nOiA3Yml0CgpIZWxsbyB3b3JsZAoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiB0ZXh0L2h0bWw7IGNoYXJzZXQ9dXMtYXNjaWkKQ29udGVudC1UcmFuc2Zlci1FbmNvZGluZzogN2JpdAoKPGRpdj5IZWxsbyB3b3JsZCA8aW1nIHNyYz0iY2lkOmltYWdlXzEiLz4gPC9kaXY+CgotLS0tLS09X1BhcnRfMF82NTk0OTQ1OTkuMTc1MDI0NDEzNTk4NApDb250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9dXMtYXNjaWk7IG5hbWU9YXR0YWNobWVudF8xCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LURpc3Bvc2l0aW9uOiBhdHRhY2htZW50OyBmaWxlbmFtZT1hdHRhY2htZW50XzEKClZHaHBjeUJwY3lCaGRIUmhZMmh0Wlc1MElHUmhkR0U9CgoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQKQ29udGVudC1UeXBlOiBpbWFnZS9qcGVnCkNvbnRlbnQtVHJhbnNmZXItRW5jb2Rpbmc6IGJhc2U2NApDb250ZW50LUlEOiBpbWFnZV8xCgpWR2hwY3lCcGN5QmhkSFJoWTJodFpXNTBJR1JoZEdFPQoKLS0tLS0tPV9QYXJ0XzBfNjU5NDk0NTk5LjE3NTAyNDQxMzU5ODQtLQ==
      responses:
        '200':
          description: Successful Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse'
              examples:
                Example for single message:
                  summary: Example for single message
                  description: Example for single message
                  value:
                    bulkId: snxemd8u52v7v84iiu69
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: jgzra46v9zi1ztvd62t5
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                Example for single message with custom ID:
                  summary: Example for single message with custom ID
                  description: Example for single message with custom ID
                  value:
                    bulkId: customBulkId
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: jgzra46v9zi1ztvd62t5
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                Example for multiple message:
                  summary: Example for multiple message
                  description: Example for multiple message
                  value:
                    bulkId: 4pk1xihiy4rln2f1g2se
                    messages:
                    - to: john.smith@somecompany.com
                      messageId: tu5k6tdo7df1bpgk7ggs
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
                    - to: jane.doe@somecompany.com
                      messageId: e7zzb1v9yirml2se9zo4
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery.
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-additional-throttling-information:
        Learn more about custom throttling limits: https://www.infobip.com/docs/api
      x-scopes:
      - message:send
      - email:message:send
      - email:manage
      x-additionalInfo:
        markdown: '### Related

          - [Send email via SMTP API](https://www.infobip.com/docs/email/smtp-specification)

          - [Setup sender domain](https://www.infobip.com/docs/email/get-started#manage-domain-settings-register-a-new-domain)

          - [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications)

          '
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/bulks:
    get:
      tags:
      - channels
      summary: Get scheduled bulks
      description: See the scheduled time of your Email messages.
      operationId: get-scheduled-emails
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the sent bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        example:
          sendAt: '2025-12-01T15:00:00.000Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkScheduleResponse'
              examples:
                Get sent email bulks response - single bulk:
                  summary: Get sent email bulks response - single bulk
                  description: Get sent email bulks response - single bulk
                  value:
                    externalBulkId: BULK-ID-123-xyz
                    bulks:
                    - bulkId: '2033247207450906897'
                      sendAt: 2025-12-01T12:00:00.000+0000
                Get sent email bulks response - multiple bulks:
                  summary: Get sent email bulks response - multiple bulks
                  description: Get sent email bulks response - multiple bulks
                  value:
                    externalBulkId: BULK-ID-123-xyz
                    bulks:
                    - bulkId: '2033247207450906897'
                      sendAt: 2025-12-01T12:00:00.000+0000
                    - bulkId: '2033247207450906898'
                      sendAt: 2025-12-01T14:00:00.000+0000
                    - bulkId: '2033247207450906899'
                      sendAt: 2025-12-01T16:00:00.000+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    put:
      tags:
      - channels
      summary: Reschedule messages
      description: Change the date and time for sending scheduled messages.
      operationId: reschedule-emails
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the sent bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        example: BULK-ID-123-xyz
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleRequest'
            examples:
              Reschedule email bulk request:
                summary: Reschedule email bulk request
                description: Reschedule email bulk request
                value:
                  sendAt: '2025-12-01T15:00:00.000Z'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleResponse'
              examples:
                Reschedule email bulk response:
                  summary: Reschedule email bulk response
                  description: Reschedule email bulk response
                  value:
                    bulkId: '2033247207450906897'
                    sendAt: 2025-12-01T15:00:00.000+0000
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: CONFLICT
                        text: Update not allowed for bulk
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /email/1/bulks/status:
    get:
      tags:
      - channels
      summary: Get scheduled bulk statuses
      description: See the status of scheduled email messages.
      operationId: get-scheduled-email-statuses
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the sent bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        example: BULK-ID-123-xyz
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusResponse'
              examples:
                Get bulk status response - paused:
                  summary: Get bulk status response - paused
                  description: Get bulk status response - paused
                  value:
                    externalBulkId: BULK-ID-123-xyz
                    bulks:
                    - bulkId: '2033247207450906897'
                      status: PAUSED
                Get bulk status response - canceled:
                  summary: Get bulk status response - canceled
                  description: Get bulk status response - canceled
                  value:
                    externalBulkId: BULK-ID-123-xyz
                    bulks:
                    - bulkId: '2033247207450906897'
                      status: CANCELED
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    put:
      tags:
      - channels
      summary: Update scheduled message statuses
      description: Change status or completely cancel sending of scheduled messages.
      operationId: update-scheduled-email-statuses
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the sent bulk.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        example: BULK-ID-123-xyz
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusRequest'
            examples:
              Update bulk status request - pause:
                summary: Update bulk status request - pause
                description: Update bulk status request - pause
                value:
                  status: PAUSED
              Update bulk status request - cancel:
                summary: Update bulk status request - cancel
                description: Update bulk status request - cancel
                value:
                  status: CANCELED
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusResponse'
              examples:
                Update bulk status response - paused:
                  summary: Update bulk status response - paused
                  description: Update bulk status response - paused
                  value:
                    bulkId: BULK-ID-123-xyz
                    status: PAUSED
                Update bulk status response - canceled:
                  summary: Update bulk status response - canceled
                  description: Update bulk status response - canceled
                  value:
                    bulkId: BULK-ID-123-xyz
                    status: CANCELED
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Bulk not found
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: CONFLICT
                        text: Update not allowed for bulk
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /email/4/logs:
    get:
      tags:
      - channels
      summary: Get email message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-email-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.LogResponseEmailUnificationLog'
        '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:
      - email:manage
      - email:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: get-email-message-logs
      - versionNumber: 1
        latest: false
        operationId: get-email-logs
  /email/4/reports:
    get:
      tags:
      - channels
      summary: Get email delivery reports
      description: Get one-time delivery reports for all sent emails.
      externalDocs:
        description: Learn more about EMAIL channel and use cases
        url: https://www.infobip.com/docs/email
      operationId: get-outbound-email-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request.
        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/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReports'
        '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
      - email:message:send
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: get-outbound-email-message-delivery-reports
      - versionNumber: 1
        latest: false
        operationId: get-email-delivery-reports
  /email/1/logs:
    get:
      tags:
      - channels
      summary: Get email message logs
      description: This method allows you to get logs for sent emails using their messageId. Email logs are available for the last 48 hours.
      operationId: get-email-logs
      parameters:
      - name: messageId
        in: query
        description: The ID that uniquely identifies the sent email.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: from
        in: query
        description: From email address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: to
        in: query
        description: The recipient email address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Bulk ID that uniquely identifies the request.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: campaignReferenceId
        in: query
        description: The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: generalStatus
        in: query
        description: Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: sentSince
        in: query
        description: 'Tells when the email was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2021-01-02T01:00:00.123Z'
      - name: sentUntil
        in: query
        description: 'Tells when the email request was processed by Infobip.Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2021-01-02T01:00:00.123Z'
      - name: limit
        in: query
        description: Maximum number of logs.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          maximum: 1000
      - name: applicationId
        in: query
        description: '[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        description: '[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLogResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:logs:read
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: get-email-message-logs
      - versionNumber: 1
        latest: false
        operationId: get-email-logs
  /email/1/reports:
    get:
      tags:
      - channels
      summary: Get email delivery reports
      description: Get one-time delivery reports for all sent emails.
      operationId: get-email-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: Bulk ID for which report is requested.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the sent email.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: campaignReferenceId
        in: query
        description: The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of reports.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          maximum: 1000
      - name: applicationId
        in: query
        description: '[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        description: '[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier used for filtering.'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReportsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - email:message:send
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: m
      x-versions:
      - versionNumber: 4
        latest: true
        operationId: get-outbound-email-message-delivery-reports
      - versionNumber: 1
        latest: false
        operationId: get-email-delivery-reports
  /email/2/validation:
    post:
      tags:
      - channels
      summary: Validate email address
      description: 'This method lets you request validation of a single email address in real-time,

        helping you to identify and remove poor-quality emails from your list.

        '
      operationId: validate-email-addresses
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  to: john.smith@example.com
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest'
            examples:
              Request example:
                summary: Request example
                value: curl -s --user user:password https://{base_url}/email/2/validation --data-urlencode 'to=john.smith@example.com'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse'
              examples:
                Valid email box response:
                  summary: Valid email box response
                  description: Valid email box response
                  value:
                    to: john.smith@example.com
                    validMailbox: 'true'
                    validSyntax: true
                    catchAll: false
                    disposable: false
                    roleBased: false
                    risk: LOW
                Invalid email box response:
                  summary: Invalid email box response
                  description: Invalid email box response
                  value:
                    to: jane.smith@example.com
                    validMailbox: 'false'
                    validSyntax: true
                    catchAll: false
                    disposable: false
                    roleBased: false
                    detailedReasons: known_hardbounce
                    risk: HIGH
                Mailbox is unknown response:
                  summary: Mailbox is unknown response
                  description: Mailbox is unknown response
                  value:
                    to: john.doe@example.org
                    validMailbox: unknown
                    validSyntax: true
                    catchAll: false
                    disposable: false
                    roleBased: false
                    reason: INBOX_FULL
                    detailedReasons: mailbox_full
                    risk: HIGH
            application/xml:
              schema:
                $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse'
              examples:
                Valid email box response:
                  summary: Valid email box response
                  description: Valid email box response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ValidationResponse>\n      \n  <to>john.smith@example.com</to>\n      \n  <validMailbox>true</validMailbox>\n      \n  <validSyntax>true</validSyntax>\n      \n  <catchAll>false</catchAll>\n      \n  <disposable>false</disposable>\n      \n  <roleBased>false</roleBased>\n      \n  <risk>LOW</risk>\n  \n</ValidationResponse>\n"
                Invalid email box response:
                  summary: Invalid email box response
                  description: Invalid email box response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ValidationResponse>\n      \n  <to>jane.smith@example.com</to>\n      \n  <validMailbox>false</validMailbox>\n      \n  <validSyntax>true</validSyntax>\n      \n  <catchAll>false</catchAll>\n      \n  <disposable>false</disposable>\n      \n  <roleBased>false</roleBased>\n      \n  <detailedReasons>known_hardbounce</detailedReasons>\n      \n  <risk>HIGH</risk>\n  \n</ValidationResponse>\n"
                Mailbox is unknown response:
                  summary: Mailbox is unknown response
                  description: Mailbox is unknown response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ValidationResponse>\n      \n  <to>john.doe@example.org</to>\n      \n  <validMailbox>unknown</validMailbox>\n      \n  <validSyntax>true</validSyntax>\n      \n  <catchAll>false</catchAll>\n      \n  <disposable>false</disposable>\n      \n  <roleBased>false</roleBased>\n      \n  <reason>INBOX_FULL</reason>\n      \n  <detailedReasons>mailbox_full</detailedReasons>\n      \n  <risk>HIGH</risk>\n  \n</ValidationResponse>\n"
        '400':
          description: Bad request response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/febb9d147c03fd2fbfd3c2210892c186364d60568040914121c07343344b284b.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/febb9d147c03fd2fbfd3c2210892c186364d60568040914121c07343344b284b.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 150
        numberOfTimeUnits: 0
        timeUnit: s
  /email/2/validations:
    get:
      tags:
      - channels
      summary: Get email validations
      description: 'This method lets you review and analyze the outcomes of your

        submitted bulk email validations to gain insights into the quality of your email list.

        '
      operationId: get-validations
      parameters:
      - name: validationRequestId
        in: query
        description: 'Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: 'Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.

            '
          example: '2034072219640523072'
          maxLength: 200
          minLength: 0
        example: 2034072219640523072
      - name: destination
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: array
          description: The email addresses to search.
          items:
            type: string
            example: '["john.smith@example.org","jane.doe@example.org"]'
            maxLength: 320
            minLength: 1
          maxItems: 100
          minItems: 0
      - name: validMailbox
        in: query
        description: Indicates whether email address is valid.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Indicates whether email address is valid.
          example: 'true'
          pattern: ^(true|false|unknown)$
        example: true
      - name: validSyntax
        in: query
        description: Indicates whether email address syntax is valid.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          description: Indicates whether email address syntax is valid.
          example: true
        example: true
      - name: catchAll
        in: query
        description: Indicates catch all status of email address.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          description: Indicates catch all status of email address.
          example: false
        example: false
      - name: disposable
        in: query
        description: 'Indicates whether email address is disposable.

          A disposable email address is a temporary address that is often used for short-term purposes and can be discarded after use.

          '
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          description: 'Indicates whether email address is disposable.

            A disposable email address is a temporary address that is often used for short-term purposes and can be discarded after use.

            '
          example: false
        example: false
      - name: roleBased
        in: query
        description: 'Indicates whether email address is role-based.

          A role-based email address is one that is associated with a specific function or group within an organization,

          such as marketing@example.org, rather than an individual person.

          '
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          description: 'Indicates whether email address is role-based.

            A role-based email address is one that is associated with a specific function or group within an organization,

            such as marketing@example.org, rather than an individual person.

            '
          example: false
        example: false
      - name: risk
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiRisk'
        example: LOW
      - name: validatedDateFrom
        in: query
        description: 'Start date for searching validations.

          If not specified, defaults to 7 days before the current date.

          The date cannot be more than 1 month in the past.

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'Start date for searching validations.

            If not specified, defaults to 7 days before the current date.

            The date cannot be more than 1 month in the past.

            '
          example: '2025-03-01T12:03:15.12Z'
        example: '2025-03-01T12:03:15.120Z'
      - name: validatedDateTo
        in: query
        description: End date for searching validations.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: End date for searching validations.
          example: '2025-03-04T15:02:11.4Z'
        example: '2025-03-04T15:02:11.400Z'
      - name: cursor
        in: query
        description: 'A pagination token for navigating through bulk email validation results.

          Initially empty, it updates with each API response to fetch the next set of results, ensuring efficient data retrieval.

          '
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: 'A pagination token for navigating through bulk email validation results.

            Initially empty, it updates with each API response to fetch the next set of results, ensuring efficient data retrieval.

            '
          example: A1F3B5C7D9E2F4A6B8C0D1E3F5A7B9C1D3E5F7A9B2C4D6E8F0A1B3C5D7E9F2A4
        example: A1F3B5C7D9E2F4A6B8C0D1E3F5A7B9C1D3E5F7A9B2C4D6E8F0A1B3C5D7E9F2A4
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          description: Number of records per page.
          example: 100
          maximum: 1000
          minimum: 1
        example: 100
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidationPageResponse'
              examples:
                Get validations response:
                  summary: Get validations response
                  value:
                    results:
                    - destination: john.smith@example.org
                      validMailbox: 'true'
                      validSyntax: true
                      catchAll: false
                      disposable: true
                      roleBased: false
                      risk: HIGH
                      detailedReasons: disposable_address
                      bulkValidationDate: '2025-03-01T12:02:15.100Z'
                      validationRequestId: '2034072219640523072'
                    - destination: john.doe@example.org
                      validMailbox: 'true'
                      validSyntax: true
                      catchAll: false
                      disposable: false
                      roleBased: false
                      risk: LOW
                      bulkValidationDate: '2025-03-01T13:03:05.500Z'
                      validationRequestId: '2034072219640523072'
                    paging:
                      size: 100
                      previousCursor: A1F3B5C7D9E2F4A6B8C0D1E3F5A7B9C1D3E5F7A9B2C4D6E8F0A1B3C5D7E9F2A4
                      nextCursor: B78918C36BB3BDCB194C0DFD2C2FBB8F7D098E56E8B5D8699997CD97A049D739
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Validate email addresses
      description: 'This method lets you request a bulk email address validation,

        helping you to detect low-quality emails and tidy up your recipient list.

        '
      operationId: request-validations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiBulkRequest'
            examples:
              Post validations request:
                summary: Post validations request
                value:
                  validationRequestId: '2034072219640523072'
                  destinations:
                  - destination: john.smith@example.org
                  - destination: jane.doe@example.org
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.BulkResponse'
              examples:
                Post validations response:
                  summary: Post validations response
                  value:
                    validationRequestId: '2034072219640523072'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/domains:
    get:
      tags:
      - channels
      summary: Get domains
      description: This API is to get all domain associated with the account. It also provides details of the retrieved domain like the DNS records, Tracking details, Active/Blocked status,etc.
      operationId: get-all-domains
      parameters:
      - name: size
        in: query
        description: Maximum number of domains to be viewed per page. Default value is 10 with a maximum of 20 records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 10
          maximum: 20
          minimum: 1
      - name: page
        in: query
        description: Page number you want to see. Default is 0.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          minimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AllDomainsResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:message:send
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
    post:
      tags:
      - channels
      summary: Add domain
      description: This method allows you to add new domains with a limit to create a maximum of 1000 domains in a day.
      operationId: add-domain
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AddDomainRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '409':
          description: Domain already exists.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /email/1/domains/{domainName}:
    get:
      tags:
      - channels
      summary: Get domain details
      description: This API provides with the details of the domain like the DNS records, Tracking details, Active/Blocked status,etc.
      operationId: get-domain-details
      parameters:
      - name: domainName
        in: path
        description: Domain for which the details need to be viewed.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Requested domain does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:message:send
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
    delete:
      tags:
      - channels
      summary: Delete domain
      description: This method allows you to delete an existing domain.
      operationId: delete-domain
      parameters:
      - name: domainName
        in: path
        description: Domain name which needs to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: Successful.
          content:
            application/json: {}
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /email/1/domains/{domainName}/tracking:
    put:
      tags:
      - channels
      summary: Update domain tracking events
      description: API to update tracking events for the provided domain. Tracking events can be updated only for CLICKS, OPENS and UNSUBSCRIBES.
      operationId: update-tracking-events
      parameters:
      - name: domainName
        in: path
        description: Domain for which the tracking events need to be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingEventRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Requested domain does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /email/1/domains/{domainName}/verify:
    post:
      tags:
      - channels
      summary: Verify domain
      description: API request to verify records(TXT, MX, DKIM) associated with the provided domain.
      operationId: verify-domain
      parameters:
      - name: domainName
        in: path
        description: Name of the domain that has to be verified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '202':
          description: ACCEPTED
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Requested domain does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 5
  /email/1/suppressions:
    get:
      tags:
      - channels
      summary: Get suppressions
      description: This method retrieves the suppressions for domains that are owned or have permissions granted.
      operationId: get-suppressions
      parameters:
      - name: domainName
        in: query
        description: Name of the requested domain.
        required: true
        style: form
        explode: true
        schema:
          type: string
          description: Name of the requested domain.
      - name: type
        in: query
        description: Type of suppression.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiSuppressionType'
      - name: emailAddress
        in: query
        description: Email address that is suppressed.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Email address that is suppressed.
      - name: recipientDomain
        in: query
        description: Recipient domain that is suppressed.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Recipient domain that is suppressed.
      - name: createdDateFrom
        in: query
        description: Start date for searching suppressions.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: Start date for searching suppressions.
      - name: createdDateTo
        in: query
        description: End date for searching suppressions.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: End date for searching suppressions.
      - name: page
        in: query
        description: Requested page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          description: Requested page number.
          minimum: 0
      - name: size
        in: query
        description: Requested page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 100
          description: Requested page size.
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfoPageResponse'
              examples:
                Get suppressions response:
                  summary: Get suppressions response
                  value:
                    results:
                    - domainName: example.com
                      emailAddress: jane.smith@example.org
                      type: BOUNCE
                      createdDate: '2024-08-14T14:02:17.366Z'
                      reason: '550 5.1.1 <jane.smith@example.org>: user does not exist'
                    paging:
                      page: 0
                      size: 100
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request example for get suppressions:
                  summary: Bad request example for get suppressions
                  description: Bad request example for get suppressions
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: type
                      violation: must not be null
                    - property: domainName
                      violation: must not be blank
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Add suppressions
      description: This method allows you to add email addresses to the suppression list. It accepts suppression requests, saves them asynchronously, and automatically ignores any duplicate entries.
      operationId: add-suppressions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppressionRequest'
            examples:
              Add suppression request:
                summary: Add suppression request
                value:
                  suppressions:
                  - domainName: example.com
                    emailAddress:
                    - jane.smith@example.org
                    - john.doe@example.org
                    type: BOUNCE
                  - domainName: another.example.com
                    emailAddress:
                    - john.smith@example.org
                    - john.perry@example.org
                    type: BOUNCE
        required: true
      responses:
        '204':
          description: No content
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete suppressions
      description: This method allows you to delete email addresses from the suppression list. It accepts delete suppression requests and asynchronously deletes them.
      operationId: delete-suppressions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppressionRequest'
            examples:
              Delete suppression request:
                summary: Delete suppression request
                value:
                  suppressions:
                  - domainName: example.com
                    emailAddress:
                    - jane.smith@example.org
                    - john.doe@example.org
                    type: BOUNCE
                  - domainName: example.com
                    emailAddress:
                    - john.smith@example.org
                    - john.perry@example.org
                    type: COMPLAINT
                  - domainName: example.com
                    emailAddress:
                    - jack@peterson@example.org
                    type: OVER_QUOTA
        required: true
      responses:
        '204':
          description: No content
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/suppressions/domains:
    get:
      tags:
      - channels
      summary: Get suppression domains
      description: This method allows you to get domains that can be managed for suppressions and are either owned or have granted permissions.
      operationId: get-domains
      parameters:
      - name: page
        in: query
        description: Requested page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          description: Requested page number.
          minimum: 0
      - name: size
        in: query
        description: Requested page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 100
          description: Requested page size.
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfoPageResponse'
              examples:
                Get domains response:
                  summary: Get domains response
                  value:
                    results:
                    - domainName: another.example.com
                      dataAccess: OWNER
                      readBounces: true
                      createBounces: true
                      deleteBounces: true
                      readComplaints: true
                      createComplaints: true
                      deleteComplaints: true
                      readOverquotas: true
                      deleteOverquotas: true
                    - domainName: example.com
                      dataAccess: GRANTED
                      readBounces: true
                      createBounces: true
                      deleteBounces: false
                      readComplaints: true
                      createComplaints: false
                      deleteComplaints: false
                      readOverquotas: false
                      deleteOverquotas: false
                    paging:
                      page: 0
                      size: 100
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/ips:
    get:
      tags:
      - channels
      summary: Get IPs
      description: Returns all the dedicated IP addresses owned by this account.
      operationId: get-all-ips
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDetailResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: DB3F9D439088BF73F5560443C8054AC4
                    ip: 198.51.100.0
                    ipAddresses:
                    - 198.51.100.0
                    - 198.51.100.1
                    pools:
                    - id: 08A3A7608750CC6E6080325A6ADF45B6
                      name: IP pool name
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/ips/commission:
    post:
      tags:
      - channels
      summary: Commission IP
      description: "Commission a new Dedicated IP.\nDisaster Recovery is enabled by default for email traffic in the US and EU regions.Each dedicated IP is paired with a corresponding IP from a different data center within the same region. This pairing ensures that if one data center becomes unavailable, the paired IP can seamlessly take over full sending responsibilities, maintaining uninterrupted traffic flow.\nStandard pricing for dedicated IPs applies. Charges are incurred at the time of commissioning and recur monthly on the 1st of each month. For Disaster Recovery regions, each IP in the pair is billed separately at the standard rate.\nTo confirm the pricing applicable to your account, please contact your Account Manager.\n        "
      operationId: commission-ip
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: DB3F9D439088BF73F5560443C8054AC4
                    ip: 198.51.100.0
                    ipAddresses:
                    - 198.51.100.0
                    - 198.51.100.1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/ips/{ipId}:
    get:
      tags:
      - channels
      summary: Get IP
      description: Get detailed information about provided dedicated IP.
      operationId: get-ip-details
      parameters:
      - name: ipId
        in: path
        description: Dedicated IP identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDetailResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: DB3F9D439088BF73F5560443C8054AC4
                    ip: 198.51.100.0
                    ipAddresses:
                    - 198.51.100.0
                    - 198.51.100.1
                    pools:
                    - id: 08A3A7608750CC6E6080325A6ADF45B6
                      name: IP pool name
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipId
                      violation: Dedicated IP not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Decommission IP
      description: 'Decommission a Dedicated IP

        Once a dedicated IP is decommissioned, billing for that IP will end at the start of the next billing cycle (on the 1st of the following month). For accounts with Disaster Recovery enabled in the US and EU regions, paired dedicated IPs will be decommissioned together.

        '
      operationId: decommission-ip
      parameters:
      - name: ipId
        in: path
        description: Dedicated IP identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipId
                      violation: Dedicated IP not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/pools:
    get:
      tags:
      - channels
      summary: Get IP pools
      description: Returns all the pools that are owned (created) by this account.
      operationId: get-ip-pools
      parameters:
      - name: name
        in: query
        description: IP pool name.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 100
          minLength: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolDetailResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: 08A3A7608750CC6E6080325A6ADF45B6
                    name: IP pool name
                    ips:
                    - id: DB3F9D439088BF73F5560443C8054AC4
                      ip: 198.51.100.0
                      ipAddresses:
                      - 198.51.100.0
                      - 198.51.100.1
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create IP pool
      description: Create a new IP pool.
      operationId: create-ip-pool
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolCreateApiRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  name: IP Pool name
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 08A3A7608750CC6E6080325A6ADF45B6
                    name: IP pool name
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/pools/{poolId}:
    get:
      tags:
      - channels
      summary: Get IP pool
      description: Get detailed information about a provided IP pool.
      operationId: get-ip-pool
      parameters:
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolDetailResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 08A3A7608750CC6E6080325A6ADF45B6
                    name: IP pool name
                    ips:
                    - id: DB3F9D439088BF73F5560443C8054AC4
                      ip: 198.51.100.0
                      ipAddresses:
                      - 198.51.100.0
                      - 198.51.100.1
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipPoolId
                      violation: IP pool not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update IP pool
      description: Update a provided IP pool.
      operationId: update-ip-pool
      parameters:
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolCreateApiRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  name: IP Pool name
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 08A3A7608750CC6E6080325A6ADF45B6
                    name: IP pool name
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipPoolId
                      violation: IP pool not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete IP pool
      description: Delete provided IP pool. Deleting an IP pool also deletes any assigned IPs and any assignments to domains.
      operationId: delete-ip-pool
      parameters:
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipPoolId
                      violation: IP pool not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/pools/{poolId}/ips:
    post:
      tags:
      - channels
      summary: Assign IP to pool
      description: Assign provided dedicated IP to the provided IP pool.
      operationId: assign-ip-to-pool
      parameters:
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolAssignIpApiRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  ipId: DB3F9D439088BF73F5560443C8054AC4
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipPoolId
                      violation: IP pool not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/pools/{poolId}/ips/{ipId}:
    delete:
      tags:
      - channels
      summary: Unassign IP from pool
      description: Unassign provided IP from the specific pool.
      operationId: remove-ip-from-pool
      parameters:
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: ipId
        in: path
        description: Dedicated IP identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
          content:
            application/json: {}
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ipPoolId
                      violation: IP pool not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/paginated/ips:
    get:
      tags:
      - channels
      summary: Get IPs (paginated)
      description: Returns paginated dedicated IP addresses owned by this account.
      operationId: get-all-ips-paginated
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 20
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDetailResponse'
                  paging:
                    $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.PageInfo'
                required:
                - paging
                - results
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - id: DB3F9D439088BF73F5560443C8054AC4
                      ip: 198.51.100.0
                      ipAddresses:
                      - 198.51.100.0
                      - 198.51.100.1
                      pools:
                      - id: 08A3A7608750CC6E6080325A6ADF45B6
                        name: IP pool name
                    paging:
                      page: 0
                      size: 20
                      totalPages: 2
                      totalResults: 25
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/paginated/pools:
    get:
      tags:
      - channels
      summary: Get IP pools (paginated)
      description: Returns paginated IP pools owned by this account.
      operationId: get-all-ip-pools-paginated
      parameters:
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 20
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  results:
                    type: array
                    items:
                      $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolDetailResponse'
                  paging:
                    $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.PageInfo'
                required:
                - paging
                - results
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - id: 08A3A7608750CC6E6080325A6ADF45B6
                      name: IP pool name
                      ips:
                      - id: DB3F9D439088BF73F5560443C8054AC4
                        ip: 198.51.100.0
                        ipAddresses:
                        - 198.51.100.0
                        - 198.51.100.1
                    paging:
                      page: 0
                      size: 20
                      totalPages: 2
                      totalResults: 25
        '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:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/domains/{domainId}:
    get:
      tags:
      - channels
      summary: Get domain
      description: Get detailed information for provided domain such as assigned pools and their IPs.
      operationId: get-ip-domain
      parameters:
      - name: domainId
        in: path
        description: Domain identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDomainResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 1
                    name: example.com
                    pools:
                    - id: 08A3A7608750CC6E6080325A6ADF45B6
                      name: IP pool name
                      priority: 0
                      ips:
                      - id: DB3F9D439088BF73F5560443C8054AC4
                        ip: 198.51.100.0
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: domainId
                      violation: Domain not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/domains/{domainId}/pools:
    post:
      tags:
      - channels
      summary: Assign IP pool to domain
      description: Assign an IP pool to the provided domain.
      operationId: assign-pool-to-domain
      parameters:
      - name: domainId
        in: path
        description: Domain identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolAssignApiRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  poolId: 08A3A7608750CC6E6080325A6ADF45B6
                  priority: 0
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: domainId
                      violation: Domain not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/ip-management/domains/{domainId}/pools/{poolId}:
    put:
      tags:
      - channels
      summary: Update IP pool sending priority
      description: Update specified pool's sending priority for the provided domain.
      operationId: update-domain-pool-priority
      parameters:
      - name: domainId
        in: path
        description: Domain identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolUpdateApiRequest'
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: domainId
                      violation: Domain not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Unassign IP pool from domain
      description: Unassign a specified pool from the provided domain.
      operationId: remove-ip-pool-from-domain
      parameters:
      - name: domainId
        in: path
        description: Domain identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          minimum: 1
      - name: poolId
        in: path
        description: IP pool identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: domainId
                      violation: Domain not found
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/email
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/templates:
    get:
      tags:
      - channels
      summary: Get email templates
      description: Retrieves a list of available email templates.
      operationId: get-email-templates
      parameters:
      - name: page
        in: query
        description: Identifies a specific page number from which to retrieve the email template details.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Identifies the maximum number of email templates returned in the list.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 20
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListPage'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create email template
      description: Creates a new email template with the provided details.
      operationId: create-email-template
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.CreateEmailTemplateRequest'
            examples:
              Create email template using cURL:
                summary: Create email template using cURL
                description: Create email template using cURL
                value: "\ncurl -X POST 'https://{baseUrl}/email/1/templates' \\\n  -H 'Authorization: {authorization}' \\\n  -H 'Accept: application/json' \\\n  -F 'name=Welcome email' \\\n  -F 'from=Infobip <noreply@example.com>' \\\n  -F 'replyTo=support@example.com' \\\n  -F 'subject=Welcome to Infobip' \\\n  -F 'preheader=Welcome to Infobip' \\\n  -F 'html=<html><head></head><body><h2>Welcome to Infobip</h2></body></html>' \\\n  -F 'landingPage=1_2345' \\\n  -F 'attachments=[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]'   \n"
              Create email template using Java:
                summary: Create email template using Java
                description: Create email template using Java
                value: "\nOkHttpClient client = new OkHttpClient().newBuilder().build();\n\nString attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encoded_data}\\\"}]\";\n\nMultipartBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n    .addFormDataPart(\"name\", \"Welcome email\")\n    .addFormDataPart(\"from\", \"Infobip <noreply@example.com>\")\n    .addFormDataPart(\"replyTo\", \"support@example.com\")\n    .addFormDataPart(\"subject\", \"Welcome to Infobip\")\n    .addFormDataPart(\"preheader\", \"Welcome to Infobip\")\n    .addFormDataPart(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n    .addFormDataPart(\"landingPage\", \"1_2345\")\n    .addFormDataPart(\"attachments\", attachmentsJson) // String representation of JSON array\n    .build();\n\nRequest request = new Request.Builder()\n    .url(\"https://{baseUrl}/email/1/templates\")\n    .method(\"POST\", body)\n    .addHeader(\"Authorization\", \"{authorization}\")\n    .addHeader(\"Accept\", \"application/json\")\n    .build();\n\nResponse response = client.newCall(request).execute();\nSystem.out.println(response.body().string());\n"
              Create email template using C#:
                summary: Create email template using C#
                description: Create email template using C#
                value: "\nvar options = new RestClientOptions(\"{baseUrl}\")\n{\n    MaxTimeout = -1,\n};\nvar client = new RestClient(options);\n\nvar request = new RestRequest(\"/email/1/templates\", Method.POST);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AddHeader(\"Accept\", \"application/json\");\n\n// Create a multipart form-data content\nvar formData = new MultipartFormDataContent();\nformData.Add(new StringContent(\"Welcome email\"), \"name\");\nformData.Add(new StringContent(\"Infobip <noreply@example.com>\"), \"from\");\nformData.Add(new StringContent(\"support@example.com\"), \"replyTo\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"subject\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"preheader\");\nformData.Add(new StringContent(\"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\"), \"html\");\nformData.Add(new StringContent(\"1_2345\"), \"landingPage\");\n\n// Add attachments as a JSON string\nvar attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]\";\nformData.Add(new StringContent(attachmentsJson), \"attachments\");\n\n// Add the form data to the request\nrequest.AddBody(formData);\n\n// Execute the request\nRestResponse response = await client.ExecuteAsync(request);\n\n// Output the response\nConsole.WriteLine(response.Content);\n"
              Create email template using Go:
                summary: Create email template using Go
                description: Create email template using Go
                value: "\npackage main\n\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"mime/multipart\"\n    \"net/http\"\n    \"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://{baseUrl}/email/1/templates\"\n\tmethod := \"POST\"\n\n\t// Create a buffer and a multipart writer\n\tvar requestBody bytes.Buffer\n\twriter := multipart.NewWriter(&requestBody)\n\n\t// Add fields to the multipart form-data\n\twriter.WriteField(\"name\", \"Welcome email\")\n\twriter.WriteField(\"from\", \"Infobip <noreply@example.com>\")\n\twriter.WriteField(\"replyTo\", \"support@example.com\")\n\twriter.WriteField(\"subject\", \"Welcome to Infobip\")\n\twriter.WriteField(\"preheader\", \"Welcome to Infobip\")\n\twriter.WriteField(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n\twriter.WriteField(\"landingPage\", \"1_2345\")\n\n\t// Add attachments as a JSON string\n\tattachmentsJson := `[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encoded_data}\"}]`\n\twriter.WriteField(\"attachments\", attachmentsJson)\n\n\t// Close the writer to finish constructing the body\n\twriter.Close()\n\n\t// Create the request\n\treq, err := http.NewRequest(method, url, &requestBody)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\t// Set necessary headers\n\treq.Header.Set(\"Authorization\", \"{authorization}\")\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", writer.FormDataContentType())\n\n\t// Send the request\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\t// Read and output the response\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tfmt.Println(string(body))\n}\n"
              Create email template using Python:
                summary: Create email template using Python
                description: Create email template using Python
                value: "\nimport requests\n\nurl = \"https://{baseUrl}/email/1/templates\"\nheaders = {\n    'Authorization': '{authorization}',\n    'Accept': 'application/json'\n}\n\n# Multipart form data\nfiles = {\n    'name': (None, 'Welcome email'),\n    'from': (None, 'Infobip <noreply@example.com'),\n    'replyTo': (None, 'support@infobip.com'),\n    'subject': (None, 'Welcome to Infobip'),\n    'preheader': (None, 'Welcome to Infobip'),\n    'html': (None, '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>'),\n    'attachments': (None, '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]'),\n    'landingPage': (None, '1_2345')\n}\n\nresponse = requests.post(url, headers=headers, files=files)\n\nprint(response.text)\n"
              Create email template using PHP:
                summary: Create email template using PHP
                description: Create email template using PHP
                value: "\n<?php\n\n$curl = curl_init();\n\n$data = array(\n    'name' => 'Welcome email',\n    'from' => 'Infobip <noreply@example.com>',\n    'replyTo' => 'support@example.com',\n    'subject' => 'Welcome to Infobip',\n    'preheader' => 'Welcome to Infobip',\n    'html' => '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>',\n    'attachments' => '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]',\n    'landingPage' => '1_2345'\n);\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => 'https://{baseUrl}/email/1/templates',\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => '',\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 0,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => 'POST',\n    CURLOPT_POSTFIELDS => $data,\n    CURLOPT_HTTPHEADER => array(\n        'Authorization: {authorization}',\n        'Accept: application/json'\n    ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n?>\n"
              Create email template using JavaScript:
                summary: Create email template using JavaScript
                description: Create email template using JavaScript
                value: "\nconst formData = new FormData();\nformData.append('name', 'Welcome email');\nformData.append('from', 'Infobip <noreply@example.com>');\nformData.append('replyTo', 'support@example.com');\nformData.append('subject', 'Welcome to Infobip');\nformData.append('preheader', 'Welcome to Infobip');\nformData.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nformData.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nformData.append('landingPage', '1_2345');\n\nfetch('https://{baseUrl}/email/1/templates', {\n    method: 'POST',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json'\n    },\n    body: formData // Send FormData object with attachments\n})\n    .then(response => response.json())\n    .then(data => console.log(data))\n    .catch(error => console.error('Error:', error));\n"
              Create email template using NodeJs:
                summary: Create email template using NodeJs
                description: Create email template using NodeJs
                value: "\nconst https = require('follow-redirects').https;\nconst FormData = require('form-data');\nconst fs = require('fs');\n\nconst form = new FormData();\nform.append('name', 'Welcome email');\nform.append('from', 'Infobip <noreply@example.com>');\nform.append('replyTo', 'support@example.com');\nform.append('subject', 'Welcome to Infobip');\nform.append('preheader', 'Welcome to Infobip');\nform.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nform.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nform.append('landingPage', '1_2345');\n\n// Prepare options for the request\nconst options = {\n    method: 'POST',\n    hostname: '{baseUrl}',\n    path: '/email/1/templates',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        ...form.getHeaders()  // This automatically includes 'Content-Type' and boundary\n    },\n    maxRedirects: 20\n};\n\n// Send the request\nconst req = https.request(options, function(res) {\n    let chunks = [];\n\n    res.on('data', function(chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on('end', function() {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n\n    res.on('error', function(error) {\n        console.error(error);\n    });\n});\n\n// Pipe the form data into the request body\nform.pipe(req);\n"
              Create email template using Ruby:
                summary: Create email template using Ruby
                description: Create email template using Ruby
                value: "\nrequire 'uri'\nrequire 'net/http'\nrequire 'json'\nrequire 'mime/types'\nrequire 'multipart/post'\n\nurl = URI(\"https://{baseUrl}/email/1/templates\")\n\n# Prepare the data as a hash\ndata = {\n  \"name\" => \"Welcome email\",\n  \"from\" => \"Infobip <noreply@example.com>\",\n  \"replyTo\" => \"support@example.com\",\n  \"subject\" => \"Welcome to Infobip\",\n  \"preheader\" => \"Welcome to Infobip\",\n  \"html\" => \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\",\n  \"attachments\" => [\n    {\n      \"contentType\" => \"application/pdf\",\n      \"fileName\" => \"attachment.pdf\",\n      \"data\" => \"{base64encodedData}\"\n    }\n  ],\n  \"landingPage\" => \"1_2345\"\n}\n\n# Prepare the multipart data\nmultipart_data = Multipart::Post.prepare_multipart(data)\n\n# Initialize Net::HTTP for the request\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\n# Create the request\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = \"{authorization}\"\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"multipart/form-data; boundary=#{multipart_data.boundary}\"\nrequest.body = multipart_data.body\n\n# Send the request\nresponse = https.request(request)\n\n# Print the response body\nputs response.read_body\n"
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/templates/{templateId}:
    get:
      tags:
      - channels
      summary: Get email template
      description: Retrieves the details of a specific email template by its identifier (ID).
      operationId: get-email-template
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update email template
      description: Updates an existing email template with new data.
      operationId: update-email-template
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.CreateEmailTemplateRequest'
            examples:
              Update email template using cURL:
                summary: Update email template using cURL
                description: Update email template using cURL
                value: "\ncurl -X PUT 'https://{baseUrl}/email/1/templates/{templateId}' \\\n  -H 'Authorization: {authorization}' \\\n  -H 'Accept: application/json' \\\n  -F 'name=Welcome email' \\\n  -F 'from=Infobip <noreply@example.com>' \\\n  -F 'replyTo=support@example.com' \\\n  -F 'subject=Welcome to Infobip' \\\n  -F 'preheader=Welcome to Infobip' \\\n  -F 'html=<html><head></head><body><h2>Welcome to Infobip</h2></body></html>' \\\n  -F 'landingPage=1_2345' \\\n  -F 'attachments=[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]'   \n"
              Update email template using Java:
                summary: Update email template using Java
                description: Update email template using Java
                value: "\nOkHttpClient client = new OkHttpClient().newBuilder().build();\n\nString attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]\";\n\nMultipartBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n    .addFormDataPart(\"name\", \"Welcome email\")\n    .addFormDataPart(\"from\", \"Infobip <noreply@example.com>\")\n    .addFormDataPart(\"replyTo\", \"support@example.com\")\n    .addFormDataPart(\"subject\", \"Welcome to Infobip\")\n    .addFormDataPart(\"preheader\", \"Welcome to Infobip\")\n    .addFormDataPart(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n    .addFormDataPart(\"landingPage\", \"1_2345\")\n    .addFormDataPart(\"attachments\", attachmentsJson) // String representation of JSON array\n    .build();\n\nRequest request = new Request.Builder()\n    .url(\"https://{baseUrl}/email/1/templates/{templateId}\")\n    .method(\"PUT\", body)\n    .addHeader(\"Authorization\", \"{authorization}\")\n    .addHeader(\"Accept\", \"application/json\")\n    .build();\n\nResponse response = client.newCall(request).execute();\nSystem.out.println(response.body().string());\n"
              Update email template using C#:
                summary: Update email template using C#
                description: Update email template using C#
                value: "\nvar options = new RestClientOptions(\"{baseUrl}\")\n{\n    MaxTimeout = -1,\n};\nvar client = new RestClient(options);\n\nvar request = new RestRequest(\"/email/1/templates/{templateId}\", Method.PUT);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AddHeader(\"Accept\", \"application/json\");\n\n// Create a multipart form-data content\nvar formData = new MultipartFormDataContent();\nformData.Add(new StringContent(\"Welcome email\"), \"name\");\nformData.Add(new StringContent(\"Infobip <noreply@example.com>\"), \"from\");\nformData.Add(new StringContent(\"support@example.com\"), \"replyTo\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"subject\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"preheader\");\nformData.Add(new StringContent(\"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\"), \"html\");\nformData.Add(new StringContent(\"1_2345\"), \"landingPage\");\n\n// Add attachments as a JSON string\nvar attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]\";\nformData.Add(new StringContent(attachmentsJson), \"attachments\");\n\n// Add the form data to the request\nrequest.AddBody(formData);\n\n// Execute the request\nRestResponse response = await client.ExecuteAsync(request);\n\n// Output the response\nConsole.WriteLine(response.Content);\n"
              Update email template using Go:
                summary: Update email template using Go
                description: Update email template using Go
                value: "\npackage main\n\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"mime/multipart\"\n    \"net/http\"\n    \"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://{baseUrl}/email/1/templates/{templateId}\"\n\tmethod := \"PUT\"\n\n\t// Create a buffer and a multipart writer\n\tvar requestBody bytes.Buffer\n\twriter := multipart.NewWriter(&requestBody)\n\n\t// Add fields to the multipart form-data\n\twriter.WriteField(\"name\", \"Welcome email\")\n\twriter.WriteField(\"from\", \"Infobip <noreply@example.com>\")\n\twriter.WriteField(\"replyTo\", \"support@example.com\")\n\twriter.WriteField(\"subject\", \"Welcome to Infobip\")\n\twriter.WriteField(\"preheader\", \"Welcome to Infobip\")\n\twriter.WriteField(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n\twriter.WriteField(\"landingPage\", \"1_2345\")\n\n\t// Add attachments as a JSON string\n\tattachmentsJson := `[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encoded_data}\"}]`\n\twriter.WriteField(\"attachments\", attachmentsJson)\n\n\t// Close the writer to finish constructing the body\n\twriter.Close()\n\n\t// Create the request\n\treq, err := http.NewRequest(method, url, &requestBody)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\t// Set necessary headers\n\treq.Header.Set(\"Authorization\", \"{authorization}\")\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", writer.FormDataContentType())\n\n\t// Send the request\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\t// Read and output the response\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tfmt.Println(string(body))\n}\n"
              Update email template using Python:
                summary: Update email template using Python
                description: Update email template using Python
                value: "\nimport requests\n\nurl = \"https://{baseUrl}/email/1/templates/{templateId}\"\nheaders = {\n    'Authorization': '{authorization}',\n    'Accept': 'application/json'\n}\n\n# Multipart form data\nfiles = {\n    'name': (None, 'Welcome email'),\n    'from': (None, 'Infobip <noreply@example.com'),\n    'replyTo': (None, 'support@infobip.com'),\n    'subject': (None, 'Welcome to Infobip'),\n    'preheader': (None, 'Welcome to Infobip'),\n    'html': (None, '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>'),\n    'attachments': (None, '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]'),\n    'landingPage': (None, '1_2345')\n}\n\nresponse = requests.put(url, headers=headers, files=files)\n\nprint(response.text)\n"
              Update email template using PHP:
                summary: Update email template using PHP
                description: Update email template using PHP
                value: "\n<?php\n\n$curl = curl_init();\n\n$data = array(\n    'name' => 'Welcome email',\n    'from' => 'Infobip <noreply@example.com>',\n    'replyTo' => 'support@example.com',\n    'subject' => 'Welcome to Infobip',\n    'preheader' => 'Welcome to Infobip',\n    'html' => '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>',\n    'attachments' => '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]',\n    'landingPage' => '1_2345'\n);\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => 'https://{baseUrl}/email/1/templates/{templateId}',\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => '',\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 0,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => 'PUT',\n    CURLOPT_POSTFIELDS => $data,\n    CURLOPT_HTTPHEADER => array(\n        'Authorization: {authorization}',\n        'Accept: application/json'\n    ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n?>\n"
              Update email template using JavaScript:
                summary: Update email template using JavaScript
                description: Update email template using JavaScript
                value: "\nconst formData = new FormData();\nformData.append('name', 'Welcome email');\nformData.append('from', 'Infobip <noreply@example.com>');\nformData.append('replyTo', 'support@example.com');\nformData.append('subject', 'Welcome to Infobip');\nformData.append('preheader', 'Welcome to Infobip');\nformData.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nformData.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nformData.append('landingPage', '1_2345');\n\nfetch('https://{baseUrl}/email/1/templates/{templateId}', {\n    method: 'PUT',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json'\n    },\n    body: formData // Send FormData object with attachments\n})\n    .then(response => response.json())\n    .then(data => console.log(data))\n    .catch(error => console.error('Error:', error));\n"
              Update email template using NodeJs:
                summary: Update email template using NodeJs
                description: Update email template using NodeJs
                value: "\nconst https = require('follow-redirects').https;\nconst FormData = require('form-data');\nconst fs = require('fs');\n\nconst form = new FormData();\nform.append('name', 'Welcome email');\nform.append('from', 'Infobip <noreply@example.com>');\nform.append('replyTo', 'support@example.com');\nform.append('subject', 'Welcome to Infobip');\nform.append('preheader', 'Welcome to Infobip');\nform.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nform.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nform.append('landingPage', '1_2345');\n\n// Prepare options for the request\nconst options = {\n    method: 'PUT',\n    hostname: '{baseUrl}',\n    path: '/email/1/templates/{templateId}',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        ...form.getHeaders()  // This automatically includes 'Content-Type' and boundary\n    },\n    maxRedirects: 20\n};\n\n// Send the request\nconst req = https.request(options, function(res) {\n    let chunks = [];\n\n    res.on('data', function(chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on('end', function() {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n\n    res.on('error', function(error) {\n        console.error(error);\n    });\n});\n\n// Pipe the form data into the request body\nform.pipe(req);\n"
              Update email template using Ruby:
                summary: Update email template using Ruby
                description: Update email template using Ruby
                value: "\nrequire 'uri'\nrequire 'net/http'\nrequire 'json'\nrequire 'mime/types'\nrequire 'multipart/post'\n\nurl = URI(\"https://{baseUrl}/email/1/templates/{templateId}\")\n\n# Prepare the data as a hash\ndata = {\n  \"name\" => \"Welcome email\",\n  \"from\" => \"Infobip <noreply@example.com>\",\n  \"replyTo\" => \"support@example.com\",\n  \"subject\" => \"Welcome to Infobip\",\n  \"preheader\" => \"Welcome to Infobip\",\n  \"html\" => \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\",\n  \"attachments\" => [\n    {\n      \"contentType\" => \"application/pdf\",\n      \"fileName\" => \"attachment.pdf\",\n      \"data\" => \"{base64encodedData}\"\n    }\n  ],\n  \"landingPage\" => \"1_2345\"\n}\n\n# Prepare the multipart data\nmultipart_data = Multipart::Post.prepare_multipart(data)\n\n# Initialize Net::HTTP for the request\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\n# Create the request\nrequest = Net::HTTP::Put.new(url)\nrequest[\"Authorization\"] = \"{authorization}\"\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"multipart/form-data; boundary=#{multipart_data.boundary}\"\nrequest.body = multipart_data.body\n\n# Send the request\nresponse = https.request(request)\n\n# Print the response body\nputs response.read_body\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete email template
      description: Deletes a specific email template by its ID.
      operationId: delete-email-template
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No content
          content:
            '*/*':
              schema:
                type: object
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Patch email template
      description: Partially updates an existing email template with the provided changes.
      operationId: patch-email-template
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.CreateEmailTemplateRequest'
            examples:
              Patch email template using cURL:
                summary: Patch email template using cURL
                description: Patch email template using cURL
                value: "\ncurl -X PATCH 'https://{baseUrl}/email/1/templates/{templateId}' \\\n  -H 'Authorization: {authorization}' \\\n  -H 'Accept: application/json' \\\n  -F 'name=Welcome email' \\\n  -F 'from=Infobip <noreply@example.com>' \\\n  -F 'replyTo=support@example.com' \\\n  -F 'subject=Welcome to Infobip' \\\n  -F 'preheader=Welcome to Infobip' \\\n  -F 'html=<html><head></head><body><h2>Welcome to Infobip</h2></body></html>' \\\n  -F 'landingPage=1_2345' \\\n  -F 'attachments=[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]'   \n"
              Patch email template using Java:
                summary: Patch email template using Java
                description: Patch email template using Java
                value: "\nOkHttpClient client = new OkHttpClient().newBuilder().build();\n\nString attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]\";\n\nMultipartBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n    .addFormDataPart(\"name\", \"Welcome email\")\n    .addFormDataPart(\"from\", \"Infobip <noreply@example.com>\")\n    .addFormDataPart(\"replyTo\", \"support@example.com\")\n    .addFormDataPart(\"subject\", \"Welcome to Infobip\")\n    .addFormDataPart(\"preheader\", \"Welcome to Infobip\")\n    .addFormDataPart(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n    .addFormDataPart(\"landingPage\", \"1_2345\")\n    .addFormDataPart(\"attachments\", attachmentsJson) // String representation of JSON array\n    .build();\n\nRequest request = new Request.Builder()\n    .url(\"https://{baseUrl}/email/1/templates/{templateId}\")\n    .method(\"PUT\", body)\n    .addHeader(\"Authorization\", \"{authorization}\")\n    .addHeader(\"Accept\", \"application/json\")\n    .build();\n\nResponse response = client.newCall(request).execute();\nSystem.out.println(response.body().string());\n"
              Patch email template using C#:
                summary: Patch email template using C#
                description: Patch email template using C#
                value: "\nvar options = new RestClientOptions(\"{baseUrl}\")\n{\n    MaxTimeout = -1,\n};\nvar client = new RestClient(options);\n\nvar request = new RestRequest(\"/email/1/templates/{templateId}\", Method.PATCH);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AddHeader(\"Accept\", \"application/json\");\n\n// Create a multipart form-data content\nvar formData = new MultipartFormDataContent();\nformData.Add(new StringContent(\"Welcome email\"), \"name\");\nformData.Add(new StringContent(\"Infobip <noreply@example.com>\"), \"from\");\nformData.Add(new StringContent(\"support@example.com\"), \"replyTo\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"subject\");\nformData.Add(new StringContent(\"Welcome to Infobip\"), \"preheader\");\nformData.Add(new StringContent(\"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\"), \"html\");\nformData.Add(new StringContent(\"1_2345\"), \"landingPage\");\n\n// Add attachments as a JSON string\nvar attachmentsJson = \"[{\\\"contentType\\\":\\\"application/pdf\\\",\\\"fileName\\\":\\\"attachment.pdf\\\",\\\"data\\\":\\\"{base64encodedData}\\\"}]\";\nformData.Add(new StringContent(attachmentsJson), \"attachments\");\n\n// Add the form data to the request\nrequest.AddBody(formData);\n\n// Execute the request\nRestResponse response = await client.ExecuteAsync(request);\n\n// Output the response\nConsole.WriteLine(response.Content);\n"
              Patch email template using Go:
                summary: Patch email template using Go
                description: Patch email template using Go
                value: "\npackage main\n\nimport (\n    \"bytes\"\n    \"fmt\"\n    \"mime/multipart\"\n    \"net/http\"\n    \"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://{baseUrl}/email/1/templates/{templateId}\"\n\tmethod := \"PUT\"\n\n\t// Create a buffer and a multipart writer\n\tvar requestBody bytes.Buffer\n\twriter := multipart.NewWriter(&requestBody)\n\n\t// Add fields to the multipart form-data\n\twriter.WriteField(\"name\", \"Welcome email\")\n\twriter.WriteField(\"from\", \"Infobip <noreply@example.com>\")\n\twriter.WriteField(\"replyTo\", \"support@example.com\")\n\twriter.WriteField(\"subject\", \"Welcome to Infobip\")\n\twriter.WriteField(\"preheader\", \"Welcome to Infobip\")\n\twriter.WriteField(\"html\", \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\")\n\twriter.WriteField(\"landingPage\", \"1_2345\")\n\n\t// Add attachments as a JSON string\n\tattachmentsJson := `[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encoded_data}\"}]`\n\twriter.WriteField(\"attachments\", attachmentsJson)\n\n\t// Close the writer to finish constructing the body\n\twriter.Close()\n\n\t// Create the request\n\treq, err := http.NewRequest(method, url, &requestBody)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\t// Set necessary headers\n\treq.Header.Set(\"Authorization\", \"{authorization}\")\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", writer.FormDataContentType())\n\n\t// Send the request\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\t// Read and output the response\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tfmt.Println(string(body))\n}\n"
              Patch email template using Python:
                summary: Patch email template using Python
                description: Patch email template using Python
                value: "\nimport requests\n\nurl = \"https://{baseUrl}/email/1/templates/{templateId}\"\nheaders = {\n    'Authorization': '{authorization}',\n    'Accept': 'application/json'\n}\n\n# Multipart form data\nfiles = {\n    'name': (None, 'Welcome email'),\n    'from': (None, 'Infobip <noreply@example.com'),\n    'replyTo': (None, 'support@infobip.com'),\n    'subject': (None, 'Welcome to Infobip'),\n    'preheader': (None, 'Welcome to Infobip'),\n    'html': (None, '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>'),\n    'attachments': (None, '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]'),\n    'landingPage': (None, '1_2345')\n}\n\nresponse = requests.patch(url, headers=headers, files=files)\n\nprint(response.text)\n"
              Patch email template using PHP:
                summary: Patch email template using PHP
                description: Patch email template using PHP
                value: "\n<?php\n\n$curl = curl_init();\n\n$data = array(\n    'name' => 'Welcome email',\n    'from' => 'Infobip <noreply@example.com>',\n    'replyTo' => 'support@example.com',\n    'subject' => 'Welcome to Infobip',\n    'preheader' => 'Welcome to Infobip',\n    'html' => '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>',\n    'attachments' => '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]',\n    'landingPage' => '1_2345'\n);\n\ncurl_setopt_array($curl, array(\n    CURLODT_URL => 'https://{baseUrl}/email/1/templates/{templateId}',\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => '',\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 0,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => 'PATCH',\n    CURLOPT_POSTFIELDS => $data,\n    CURLOPT_HTTPHEADER => array(\n        'Authorization: {authorization}',\n        'Accept: application/json'\n    ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n?>\n"
              Patch email template using JavaScript:
                summary: Patch email template using JavaScript
                description: Patch email template using JavaScript
                value: "\nconst formData = new FormData();\nformData.append('name', 'Welcome email');\nformData.append('from', 'Infobip <noreply@example.com>');\nformData.append('replyTo', 'support@example.com');\nformData.append('subject', 'Welcome to Infobip');\nformData.append('preheader', 'Welcome to Infobip');\nformData.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nformData.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nformData.append('landingPage', '1_2345');\n\nfetch('https://{baseUrl}/email/1/templates/{templateId}', {\n    method: 'PATCH',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json'\n    },\n    body: formData // Send FormData object with attachments\n})\n    .then(response => response.json())\n    .then(data => console.log(data))\n    .catch(error => console.error('Error:', error));\n"
              Patch email template using NodeJs:
                summary: Patch email template using NodeJs
                description: Patch email template using NodeJs
                value: "\nconst https = require('follow-redirects').https;\nconst FormData = require('form-data');\nconst fs = require('fs');\n\nconst form = new FormData();\nform.append('name', 'Welcome email');\nform.append('from', 'Infobip <noreply@example.com>');\nform.append('replyTo', 'support@example.com');\nform.append('subject', 'Welcome to Infobip');\nform.append('preheader', 'Welcome to Infobip');\nform.append('html', '<html><head></head><body><h2>Welcome to Infobip</h2></body></html>');\nform.append('attachments', '[{\"contentType\":\"application/pdf\",\"fileName\":\"attachment.pdf\",\"data\":\"{base64encodedData}\"}]');\nform.append('landingPage', '1_2345');\n\n// Prepare options for the request\nconst options = {\n    method: 'PATCH',\n    hostname: '{baseUrl}',\n    path: '/email/1/templates/{templateId}',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        ...form.getHeaders()  // This automatically includes 'Content-Type' and boundary\n    },\n    maxRedirects: 20\n};\n\n// Send the request\nconst req = https.request(options, function(res) {\n    let chunks = [];\n\n    res.on('data', function(chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on('end', function() {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n\n    res.on('error', function(error) {\n        console.error(error);\n    });\n});\n\n// Pipe the form data into the request body\nform.pipe(req);\n    "
              Patch email template using Ruby:
                summary: Patch email template using Ruby
                description: Patch email template using Ruby
                value: "\nrequire 'uri'\nrequire 'net/http'\nrequire 'json'\nrequire 'mime/types'\nrequire 'multipart/post'\n\nurl = URI(\"https://{baseUrl}/email/1/templates/{templateId}\")\n\n# Prepare the data as a hash\ndata = {\n  \"name\" => \"Welcome email\",\n  \"from\" => \"Infobip <noreply@example.com>\",\n  \"replyTo\" => \"support@example.com\",\n  \"subject\" => \"Welcome to Infobip\",\n  \"preheader\" => \"Welcome to Infobip\",\n  \"html\" => \"<html><head></head><body><h2>Welcome to Infobip</h2></body></html>\",\n  \"attachments\" => [\n    {\n      \"contentType\" => \"application/pdf\",\n      \"fileName\" => \"attachment.pdf\",\n      \"data\" => \"{base64encodedData}\"\n    }\n  ],\n  \"landingPage\" => \"1_2345\"\n}\n\n# Prepare the multipart data\nmultipart_data = Multipart::Post.prepare_multipart(data)\n\n# Initialize Net::HTTP for the request\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\n# Create the request\nrequest = Net::HTTP::Patch.new(url)\nrequest[\"Authorization\"] = \"{authorization}\"\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"multipart/form-data; boundary=#{multipart_data.boundary}\"\nrequest.body = multipart_data.body\n\n# Send the request\nresponse = https.request(request)\n\n# Print the response body\nputs response.read_body\n"
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/templates/{templateId}/preview:
    post:
      tags:
      - channels
      summary: Generate email template preview
      description: Generates a rendered preview of an email template by replacing placeholders with the provided key-value data.
      operationId: generate-email-template-preview
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplatePreviewRequest'
            examples:
              Generate email template preview cURL:
                summary: Generate email template preview cURL
                description: Generate email template preview cURL
                value: "\ncurl -X POST \"{baseUrl}/email/1/templates/{templateId}/preview\" \\\n  -H \"Authorization: {authorization}\" \\\n  -H \"Accept: application/json\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n    \"placeholders\": {\n        \"firstName\": \"John\",\n        \"lastName\": \"Doe\"\n    }\n}'\n"
              Generate email template preview Java:
                summary: Generate email template preview Java
                description: Generate email template preview Java
                value: "\nOkHttpClient client = new OkHttpClient().newBuilder().build();\n\n// Define the JSON payload\nString payload = \"{\"placeholders\": {\"firstName\":\"John\", \"lastName\":\"Doe\"}}\"\n\n// Create the request body\nMediaType mediaType = MediaType.parse(\"application/json\");\nRequestBody body = RequestBody.create(payload, mediaType);\n\n// Build the request\nRequest request = new Request.Builder()\n    .url(\"https://{baseUrl}/email/1/templates/{templateId}/preview\")\n    .method(\"POST\", body)\n    .addHeader(\"Authorization\", \"{authorization}\")\n    .addHeader(\"Accept\", \"application/json\")\n    .addHeader(\"Content-Type\", \"application/json\")\n    .build();\n\n// Execute the request\nResponse response = client.newCall(request).execute();\n\n// Print the response\nSystem.out.println(response.body().string());\n"
              Generate email template preview C#:
                summary: Generate email template preview C#
                description: Generate email template preview C#
                value: "\nvar options = new RestClientOptions(\"{baseUrl}\")\n{\n    MaxTimeout = -1,\n};\nvar client = new RestClient(options);\n\nvar request = new RestRequest(\"/email/1/templates/{templateId}/preview\", Method.POST);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AddHeader(\"Accept\", \"application/json\");\n\n// Create a multipart form-data content\nvar payload = new {\n    placeholders = new {\n        firstName = \"John\",\n        lastName = \"Doe\"\n    }\n};\n\n// Add the form data to the request\nrequest.AddJsonBody(payload);\n\n// Execute the request\nRestResponse response = await client.ExecuteAsync(request);\n\n// Output the response\nConsole.WriteLine(response.Content);\n"
              Generate email template preview Go:
                summary: Generate email template preview Go
                description: Generate email template preview Go
                value: "\npackage main\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://{baseUrl}/email/1/templates/{templateId}/preview\"\n\tmethod := \"POST\"\n\n\t// Define the JSON payload\n\tjsonData := []byte(`{\n        \"placeholders\": {\n            \"firstName\": \"John\",\n            \"lastName\": \"Doe\"\n        }\n    }`)\n\n\t// Create the request\n\treq, err := http.NewRequest(method, url, bytes.NewBuffer(jsonData))\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\t// Set necessary headers\n\treq.Header.Set(\"Authorization\", \"{authorization}\")\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", \"application/json\")\n\n\t// Send the request\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\t// Read and output the response\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\tfmt.Println(string(body))\n} \n"
              Generate email template preview Python:
                summary: Generate email template preview Python
                description: Generate email template preview Python
                value: "\nimport requests\nimport json\n\nurl = \"https://{baseUrl}/email/1/templates/{templateId}/preview\"\n\nheaders = {\n    \"Authorization\": \"{authorization}\",\n    \"Accept\": \"application/json\",\n    \"Content-Type\": \"application/json\"\n}\n\n# JSON payload\npayload = {\n  \"placeholders\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  }\n}\n\nresponse = requests.post(url, headers=headers, data=json.dumps(payload))\n\nprint(response.text)    \n"
              Generate email template preview PHP:
                summary: Generate email template preview PHP
                description: Generate email template preview PHP
                value: "\n<?php\n\n$curl = curl_init();\n\n// Prepare JSON payload\n$data = array(\n    \"placeholders\" => array(\n        \"firstName\" => \"John\",\n        \"lastName\" => \"Doe\"\n    )\n);\n$jsonData = json_encode($data);\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => 'https://{baseUrl}/email/1/templates/{templateId}/preview',\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => '',\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 0,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => 'POST',\n    CURLOPT_POSTFIELDS => $jsonData,\n    CURLOPT_HTTPHEADER => array(\n        'Authorization: {authorization}',\n        'Accept: application/json',\n        'Content-Type: application/json'\n    ),\n));\n\n$response = curl_exec($curl);\ncurl_close($curl);\n\necho $response;\n?>\n"
              Generate email template preview JavaScript:
                summary: Generate email template preview JavaScript
                description: Generate email template preview JavaScript
                value: "\nconst payload = {\n  \"placeholders\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  }\n};\n\nfetch('https://{baseUrl}/email/1/templates/{templateId}/preview', {\n    method: 'POST',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        'Content-Type': 'application/json'\n    },\n    body: JSON.stringify(payload)\n})\n    .then(response => response.json())\n    .then(data => console.log(data))\n    .catch(error => console.error('Error:', error)); \n"
              Generate email template preview NodeJs:
                summary: Generate email template preview NodeJs
                description: Generate email template preview NodeJs
                value: "\nconst https = require('follow-redirects').https;\n\n// Prepare the JSON payload\nconst data = JSON.stringify({\n  \"placeholders\": {\n    \"firstName\": \"John\",\n    \"lastName\": \"Doe\"\n  }\n});\n\n// Prepare options for the request\nconst options = {\n    method: 'POST',\n    hostname: '{baseUrl}',\n    path: '/email/1/templates/{templateId}/preview',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        'Content-Type': 'application/json',\n        'Content-Length': Buffer.byteLength(data)\n    },\n    maxRedirects: 20\n};\n\n// Send the request\nconst req = https.request(options, function(res) {\n    let chunks = [];\n\n    res.on('data', function(chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on('end', function() {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n\n    res.on('error', function(error) {\n        console.error(error);\n    });\n});\n\n// Write the JSON body to the request\nreq.write(data);\nreq.end();    \n"
              Generate email template preview Ruby:
                summary: Generate email template preview Ruby
                description: Generate email template preview Ruby
                value: "\nrequire 'net/http'\nrequire 'json'\nrequire 'uri'\n\nurl = URI(\"https://{baseUrl}/email/1/templates/{templateId}/preview\")\n\n# Prepare the JSON payload\npayload = {\n  \"placeholders\" => {\n    \"firstName\" => \"John\",\n    \"lastName\" => \"Doe\"\n  }\n}\n\n# Initialize Net::HTTP\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\n# Create the POST request\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = \"{authorization}\"\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"application/json\"\nrequest.body = payload.to_json\n\n# Send the request\nresponse = https.request(request)\n\n# Print the response body\nputs response.body    \n"
      responses:
        '200':
          description: OK
          content:
            text/html:
              schema:
                type: string
              examples:
                Response example:
                  summary: Response example
                  value: <html>Hello, John Doe</html>
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/templates/{templateId}/attachments:
    get:
      tags:
      - channels
      summary: Get email template attachments
      description: Retrieves a list of attachments associated with a specific email template.
      operationId: get-email-template-attachments
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.AttachmentList'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Upload email template attachment
      description: Uploads an attachment to a specific email template.
      operationId: upload-email-template-attachment
      parameters:
      - name: templateId
        in: path
        description: Unique identifier (ID) of the email template.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Base64EncodedFile'
            examples:
              Upload template attachment using cURL:
                summary: Upload template attachment using cURL
                description: Upload template attachment using cURL
                value: "\ncurl -X POST 'https://{baseUrl}/email/1/templates/{templateId}/attachments' \\\n  -H 'Authorization: {authorization}' \\\n  -H 'Accept: application/json' \\\n  -F 'fileName=attachment.pdf' \\\n  -F 'contentType=application/pdf' \\\n  -F 'data={base64encodedData}' \\\n"
              Upload template attachment using Java:
                summary: Upload template attachment using Java
                description: Upload template attachment using Java
                value: "\nOkHttpClient client = new OkHttpClient().newBuilder().build();\n\nMultipartBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n    .addFormDataPart(\"fileName\", \"attachment.pdf\")\n    .addFormDataPart(\"contentType\", \"application/pdf\")\n    .addFormDataPart(\"data\", \"{base64encodedData}\")\n    .build();\n    \nRequest request = new Request.Builder()\n    .url(\"https://{baseUrl}/email/1/templates/{templateId}/attachments\")\n    .method(\"POST\", body)\n    .addHeader(\"Authorization\", \"{authorization}\")\n    .addHeader(\"Accept\", \"application/json\")\n    .build();\n    \nResponse response = client.newCall(request).execute();\nSystem.out.println(response.body().string());\n"
              Upload template attachment using C#:
                summary: Upload template attachment using C#
                description: Upload template attachment using C#
                value: "\nvar options = new RestClientOptions(\"{baseUrl}\")\n{\n    MaxTimeout = -1,\n};\nvar client = new RestClient(options);\n\nvar request = new RestRequest(\"POST\", Method.POST);\nrequest.AddHeader(\"Authorization\", \"{authorization}\");\nrequest.AddHeader(\"Accept\", \"application/json\");\n\n// Create a multipart form-data content\nvar formData = new MultipartFormDataContent();\nformData.Add(new StringContent(\"attachment.pdf\"), \"fileName\");\nformData.Add(new StringContent(\"application/pdf\"), \"contentType\");\nformData.Add(new StringContent({base64encoded_data}), \"data\");\n\n// Add the form data to the request\nrequest.AddBody(formData);\n\n// Execute the request\nRestResponse response = await client.ExecuteAsync(request);\n\n// Output the response\nConsole.WriteLine(response.Content);\n"
              Upload template attachment using Go:
                summary: Upload template attachment using Go
                description: Upload template attachment using Go
                value: "\npackage main\n\nimport (\n\t\"bytes\"\n\t\"fmt\"\n\t\"mime/multipart\"\n\t\"net/http\"\n\t\"io/ioutil\"\n)\n\nfunc main() {\n\n\turl := \"https://{baseUrl}/email/1/templates/{templateId}/attachments\"\n\tmethod := \"POST\"\n\n\t// Create a buffer and a multipart writer\n\tvar requestBody bytes.Buffer\n\twriter := multipart.NewWriter(&requestBody)\n\n\t// Add fields to the multipart form-data\n\twriter.WriteField(\"fileName\", \"attachment.pdf\")\n    writer.WriteField(\"contentType\", \"application/pdf\")\n    writer.WriteField(\"data\", \"{base64encodedData}\")\n\n\t// Close the writer to finish constructing the body\n\twriter.Close()\n\n\t// Create the request\n\treq, err := http.NewRequest(method, url, &requestBody)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\n\t// Set necessary headers\n\treq.Header.Set(\"Authorization\", \"{authorization}\")\n\treq.Header.Set(\"Accept\", \"application/json\")\n\treq.Header.Set(\"Content-Type\", writer.FormDataContentType())\n\n\t// Send the request\n\tclient := &http.Client{}\n\tres, err := client.Do(req)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tdefer res.Body.Close()\n\n\t// Read and output the response\n\tbody, err := ioutil.ReadAll(res.Body)\n\tif err != nil {\n\t\tfmt.Println(err)\n\t\treturn\n\t}\n\tfmt.Println(string(body))\n}\n"
              Upload template attachment using Python:
                summary: Upload template attachment using Python
                description: Upload template attachment using Python
                value: "\nimport requests\n\nurl = \"https://{baseUrl}/email/1/templates/{templateId}/attachments\"\nheaders = {\n    'Authorization': '{authorization}',\n    'Accept': 'application/json'\n}\n\n# Multipart form data\nfiles = {\n    'fileName': (None, 'attachment.pdf'),\n    'contentType': (None, 'application/pdf'),\n    'data': (None, '{base64encodedData}')\n}\n\nresponse = requests.post(url, headers=headers, files=files)\n\nprint(response.text)\n"
              Upload template attachment using PHP:
                summary: Upload template attachment using PHP
                description: Upload template attachment using PHP
                value: "\n<?php\n\n$curl = curl_init();\n\n$data = array(\n    'fileName' => 'attachment.pdf',\n    'contentType' => 'application/pdf',\n    'data' => '{base64encodedData}'\n);\n\ncurl_setopt_array($curl, array(\n    CURLOPT_URL => 'https://{baseUrl}/email/1/templates/{templateId}/attachments',\n    CURLOPT_RETURNTRANSFER => true,\n    CURLOPT_ENCODING => '',\n    CURLOPT_MAXREDIRS => 10,\n    CURLOPT_TIMEOUT => 0,\n    CURLOPT_FOLLOWLOCATION => true,\n    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\n    CURLOPT_CUSTOMREQUEST => 'POST',\n    CURLOPT_POSTFIELDS => $data,\n    CURLOPT_HTTPHEADER => array(\n        'Authorization: {authorization}',\n        'Accept: application/json'\n    ),\n));\n\n$response = curl_exec($curl);\n\ncurl_close($curl);\necho $response;\n?>\n"
              Upload template attachment using JavaScript:
                summary: Upload template attachment using JavaScript
                description: Upload template attachment using JavaScript
                value: "\nconst formData = new FormData();\nformData.append('fileName', 'attachment.pdf');\nformData.append('contentType', 'application/pdf');\nformData.append('data', '{base64encodedData}');\n\nfetch('https://{baseUrl}/email/1/templates/{templateId}/attachments', {\n    method: '{METHOD}',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json'\n    },\n    body: formData\n})\n    .then(response => response.json())\n    .then(data => console.log(data))\n    .catch(error => console.error('Error:', error));\n"
              Upload template attachment using NodeJs:
                summary: Upload template attachment using NodeJs
                description: Upload template attachment using NodeJs
                value: "\nconst https = require('follow-redirects').https;\nconst FormData = require('form-data');\nconst fs = require('fs');\n\nconst form = new FormData();\nform.append('fileName', 'attachment.pdf');\nform.append('contentType', 'application/pdf');\nform.append('data', '{base64encodedData}');\n\n// Prepare options for the request\nconst options = {\n    method: 'POST',\n    hostname: '{baseUrl}',\n    path: '/email/1/templates/{templateId}/attachments',\n    headers: {\n        'Authorization': '{authorization}',\n        'Accept': 'application/json',\n        ...form.getHeaders()  // This automatically includes 'Content-Type' and boundary\n    },\n    maxRedirects: 20\n};\n\n// Send the request\nconst req = https.request(options, function(res) {\n    let chunks = [];\n\n    res.on('data', function(chunk) {\n        chunks.push(chunk);\n    });\n\n    res.on('end', function() {\n        const body = Buffer.concat(chunks);\n        console.log(body.toString());\n    });\n\n    res.on('error', function(error) {\n        console.error(error);\n    });\n});\n\n// Pipe the form data into the request body\nform.pipe(req);\n"
              Upload template attachment using Ruby:
                summary: Upload template attachment using Ruby
                description: Upload template attachment using Ruby
                value: "\nrequire 'net/http'\nrequire 'json'\nrequire 'mime/types'\nrequire 'multipart/post'\n\nurl = URI(\"https://{baseUrl}/email/1/templates/{templateId}/attachments\")\n\n# Prepare the data as a hash\ndata = {\n    \"fileName\" => \"attachment.pdf\",\n    \"contentType\" => \"application/pdf\",\n    \"data\" => \"{base64encodedData}\"\n}\n\n# Prepare the multipart data\nmultipart_data = Multipart::Post.prepare_multipart(data)\n\n# Initialize Net::HTTP for the request\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\n# Create the request\nrequest = Net::HTTP::Post.new(url)\nrequest[\"Authorization\"] = \"{authorization}\"\nrequest[\"Accept\"] = \"application/json\"\nrequest[\"Content-Type\"] = \"multipart/form-data; boundary=#{multipart_data.boundary}\"\nrequest.body = multipart_data.body\n\n# Send the request\nresponse = https.request(request)\n\n# Print the response body\nputs response.read_body    \n"
      responses:
        '201':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /email/1/templates/{templateId}/attachments/{attachmentId}:
    delete:
      tags:
      - channels
      summary: Delete email template attachment
      description: Removes a specific attachment from an email template.
      operationId: delete-email-template-attachment
      parameters:
      - name: attachmentId
        in: path
        description: Attachment ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: templateId
        in: path
        description: Template ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '204':
          description: No content
          content:
            '*/*':
              schema:
                type: object
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - email:manage
      - email:templates:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/template:
    post:
      tags:
      - channels
      summary: Send WhatsApp template message
      description: Send a single or multiple template messages to one or more recipients. Template messages can be sent and delivered at anytime. Each template needs to be registered and pre-approved by WhatsApp. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-template-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessage'
            examples:
              Body template message:
                summary: Body template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                          - Placeholder Value 2
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Text header template message:
                summary: Text header template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        header:
                          type: TEXT
                          placeholder: placeholder value
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Document header template message:
                summary: Document header template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        header:
                          type: DOCUMENT
                          mediaUrl: http://example.com/document
                          filename: document.pdf
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Image header template message:
                summary: Image header template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        header:
                          type: IMAGE
                          mediaUrl: http://example.com/image
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Video header template message:
                summary: Video header template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        header:
                          type: VIDEO
                          mediaUrl: http://example.com/video
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Location header template message:
                summary: Location header template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        header:
                          type: LOCATION
                          latitude: 45.79359
                          longitude: 15.94613
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Quick reply button template message:
                summary: Quick reply button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: QUICK_REPLY
                          parameter: 'Yes'
                        - type: QUICK_REPLY
                          parameter: 'No'
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Coupon template message:
                summary: Coupon template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: COPY_CODE
                          parameter: exampleCode
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Dynamic URL button template message:
                summary: Dynamic URL button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: URL
                          parameter: docs
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Static URL button template message:
                summary: Static URL button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                        buttons: []
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Template message with SMS failover:
                summary: Template message with SMS failover
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
                    smsFailover:
                      from: InfoSMS
                      text: SMS message to be sent if WhatsApp template message could not be delivered.
              Bulk template messages:
                summary: Bulk template messages
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
                  - from: '441134960000'
                    to: '441134960002'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381db
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
                  bulkId: BULK-ID-123-xyz
              Authentication with one-tap button template message:
                summary: Authentication with one-tap button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Authentication Code Value
                        buttons:
                        - type: URL
                          parameter: Authentication Code Value
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Authentication with copy code button template message:
                summary: Authentication with copy code button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Authentication Code Value
                        buttons:
                        - type: URL
                          parameter: Authentication Code Value
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Carousel message:
                summary: Carousel message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        carousel:
                          cards:
                          - header:
                              type: IMAGE
                              mediaUrl: http://example.com/image
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Carousel message with buttons in card:
                summary: Carousel message with buttons in card
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        carousel:
                          cards:
                          - header:
                              type: IMAGE
                              mediaUrl: http://example.com/image
                            buttons:
                            - type: QUICK_REPLY
                              parameter: 'Yes'
                            - type: QUICK_REPLY
                              parameter: 'No'
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Limited-time offer without expiration time:
                summary: Limited-time offer without expiration time
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                        buttons:
                        - type: URL
                          parameter: docs
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Limited-time offer with expiration time:
                summary: Limited-time offer with expiration time
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders:
                          - Placeholder Value 1
                        buttons:
                        - type: COPY_CODE
                          parameter: exampleCode
                        - type: URL
                          parameter: docs
                        limitedTimeOffer:
                          expirationTime: '2030-01-01T10:00:00.000Z'
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Flow button template message:
                summary: Flow button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: FLOW
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Flow button with flow token and data template message:
                summary: Flow button with flow token and data template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: FLOW
                          flowToken: Flow token
                          data:
                            key: value
                            key2: value2
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Catalog button template message:
                summary: Catalog button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: CATALOG
                          thumbnailProductRetailerId: qihxicpdu3
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Catalog button template message without optional fields:
                summary: Catalog button template message without optional fields
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: CATALOG
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Multi Product button template message:
                summary: Multi Product button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: MULTI_PRODUCT
                          thumbnailProductRetailerId: qihxicpdu3
                          sections:
                          - title: Title
                            productRetailerIds:
                            - '1'
                            - '2'
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Multi Product button template message without optional fields:
                summary: Multi Product button template message without optional fields
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: MULTI_PRODUCT
                          sections:
                          - title: Title
                            productRetailerIds:
                            - '1'
                            - '2'
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for Brazil Pix DC button template message:
                summary: Order Details for Brazil Pix DC button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: BRAZIL_PIX_DC
                              id: fd3e847h2
                              code: 00020101021226900014br.gov.bcb.pix2568pix
                              merchantName: Company Name
                              keyType: CNPJ
                              key: 01234567891234
                            orderCurrency: BRL
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for Brazil Link button template message:
                summary: Order Details for Brazil Link button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: BRAZIL_LINK
                              id: fd3e847h2
                              paymentLink: https://example.com/payment-link
                            orderCurrency: BRL
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for Brazil Boleto button template message:
                summary: Order Details for Brazil Boleto button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: BRAZIL_BOLETO
                              id: fd3e847h2
                              code: 03399026944140000002628346101018898510000008848
                            orderCurrency: BRL
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for Brazil Payments button template message:
                summary: Order Details for Brazil Payments button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: BRAZIL_PAYMENTS
                              payments:
                              - type: BRAZIL_PIX_DC
                                id: fd3e847h2
                                code: 00020101021226900014br.gov.bcb.pix2568pix
                                merchantName: Company Name
                                keyType: CNPJ
                                key: 01234567891234
                              - type: BRAZIL_BOLETO
                                id: fd3e847h2
                                code: 03399026944140000002628346101018898510000008848
                            orderCurrency: BRL
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for PG PayU button template message:
                summary: Order Details for PG PayU button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: PG_PAYU
                              id: fd3e847h2
                              beneficiary:
                                name: John Smith
                                firstAddressLine: address line
                                secondAddressLine: address line
                                city: city
                                state: state
                                country: INDIA
                                postalCode: '123456'
                              callbackData:
                              - customData1
                              - customData2
                              - customData3
                              - customData4
                            orderCurrency: INR
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for PG Razorpay button template message:
                summary: Order Details for PG Razorpay button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: PG_RAZORPAY
                              id: fd3e847h2
                              beneficiary:
                                name: John Smith
                                firstAddressLine: address line
                                secondAddressLine: address line
                                city: city
                                state: state
                                country: INDIA
                                postalCode: '123456'
                              callbackData:
                                key0: customData1
                                key1: customData2
                                key2: customData3
                                key3: customData4
                                key4: customData5
                                key5: customData6
                                key6: customData7
                                key7: customData8
                                key8: customData9
                                key9: customData10
                                key10: customData11
                                key11: customData12
                                key12: customData13
                                key13: customData14
                                key14: customData15
                            orderCurrency: INR
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for UPI Intent Link button template message:
                summary: Order Details for UPI Intent Link button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: UPI_INTENT
                              id: fd3e847h2
                              beneficiary:
                                name: John Smith
                                firstAddressLine: address line
                                secondAddressLine: address line
                                city: city
                                state: state
                                country: INDIA
                                postalCode: '123456'
                              format:
                                type: LINK
                                paymentLink: upi://pay?pa=example@upi&pn=Example%20Merchant&mc=4722&&tr=1234567890
                            orderCurrency: INR
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Details for UPI Link button template message:
                summary: Order Details for UPI Link button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: ORDER_DETAILS
                          action:
                            payment:
                              type: UPI_LINK
                              id: fd3e847h2
                              beneficiary:
                                name: John Smith
                                firstAddressLine: address line
                                secondAddressLine: address line
                                city: city
                                state: state
                                country: INDIA
                                postalCode: '123456'
                              paymentLink: https://payment.example.com/upi-link
                            orderCurrency: INR
                            orderType: DIGITAL_GOODS
                            totalAmount:
                              value: 21000
                            order:
                              catalogId: '1'
                              items:
                              - retailerId: '1'
                                name: discounted product
                                amount:
                                  value: 10000
                                saleAmount:
                                  value: 5000
                                quantity: 2
                              - retailerId: '2'
                                name: product
                                amount:
                                  value: 10000
                                quantity: 1
                              subtotal:
                                value: 20000
                              tax:
                                value: 1000
                                description: tax included
                              shipping:
                                value: 1000
                                description: shipping cost
                              discount:
                                amount:
                                  value: 1000
                                  description: discount
                                programName: membership discount
                              orderExpiration:
                                expirationSeconds: 500
                                description: limited offer
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Order Status template message:
                summary: Order Status template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        orderStatus:
                          orderStatuses:
                          - type: ORDER_STATUS
                            payment:
                              type: UPI_INTENT
                              id: paymentId
                            status: PROCESSING
                            description: Order status description
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
              Voice call button template message:
                summary: Voice call button template message
                value:
                  messages:
                  - from: '441134960000'
                    to: '441134960001'
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    content:
                      templateName: template_name
                      templateData:
                        body:
                          placeholders: []
                        buttons:
                        - type: VOICE_CALL
                          callValidityPeriod: 1440
                          callContextPayload: context-payload
                      language: en_GB
                    callbackData: Callback data
                    notifyUrl: https://www.example.com/whatsapp
                    urlOptions:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/click-report
                      removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    messages:
                    - to: '441134960001'
                      messageCount: 1
                      messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                    bulkId: '2034072219640523073'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Extra whitespaces error response:
                  summary: Extra whitespaces error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.templateData.header.placeholder:
                          - cannot have new-line/tab characters or more than 4 consecutive spaces
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.templateData.header.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Filename validation error response:
                  summary: Filename validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.templateData.header.filename:
                          - size must be between 1 and 240
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/text:
    post:
      tags:
      - channels
      summary: Send WhatsApp text message
      description: Send a text message to a single recipient. Text messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-text-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextMessage'
            examples:
              Text message:
                summary: Text message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Text message with previewable url:
                summary: Text message with previewable url
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    text: 'Some text with url: http://example.com'
                    previewUrl: true
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: false
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Text validation error response:
                  summary: Text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.text:
                          - size must be between 1 and 4096
                          - must not be blank
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/document:
    post:
      tags:
      - channels
      summary: Send WhatsApp document message
      description: Send a document to a single recipient. Document messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-document-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentMessage'
            examples:
              Document message:
                summary: Document message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/document
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Document message with all fields:
                summary: Document message with all fields
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/document
                    caption: Some document caption
                    filename: filename.pdf
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Caption validation error response:
                  summary: Caption validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.caption:
                          - size must be between 0 and 3000
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/image:
    post:
      tags:
      - channels
      summary: Send WhatsApp image message
      description: Send an image to a single recipient. Image messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-image-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMessage'
            examples:
              Image message:
                summary: Image message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/image
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Image message with caption:
                summary: Image message with caption
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/image
                    caption: Some image caption
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Caption validation error response:
                  summary: Caption validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.caption:
                          - size must be between 0 and 3000
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/audio:
    post:
      tags:
      - channels
      summary: Send WhatsApp audio message
      description: Send an audio to a single recipient. Audio messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-audio-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioMessage'
            examples:
              Audio message:
                summary: Audio message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/audio
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
              Voice note:
                summary: Voice note
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/voice.ogg
                    voice: true
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/video:
    post:
      tags:
      - channels
      summary: Send WhatsApp video message
      description: Send a video to a single recipient. Video messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-video-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMessage'
            examples:
              Video message:
                summary: Video message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/video
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Video message with caption:
                summary: Video message with caption
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/video
                    caption: Some video caption
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Caption validation error response:
                  summary: Caption validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.caption:
                          - size must be between 0 and 3000
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/sticker:
    post:
      tags:
      - channels
      summary: Send WhatsApp sticker message
      description: Send a sticker to a single recipient. Sticker messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-sticker-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerMessage'
            examples:
              Sticker message:
                summary: Sticker message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    mediaUrl: http://example.com/sticker
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/location:
    post:
      tags:
      - channels
      summary: Send WhatsApp location message
      description: Send a location to a single recipient. Location messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-location-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationMessage'
            examples:
              Location message:
                summary: Location message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    latitude: 44.9526862
                    longitude: 13.8545217
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
              Location message with all fields:
                summary: Location message with all fields
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    latitude: 44.9526862
                    longitude: 13.8545217
                    name: Infobip
                    address: Vodnjan, Croatia
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Location validation error response:
                  summary: Location validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.latitude:
                          - must be greater than or equal to -90
                          content.longitude:
                          - must be less than or equal to 180
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/contact:
    post:
      tags:
      - channels
      summary: Send WhatsApp contact message
      description: Send a contact to a single recipient. Contact messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-contact-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsMessage'
            examples:
              Single contact message:
                summary: Single contact message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    contacts:
                    - addresses:
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: WORK
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: HOME
                      birthday: '2010-01-01'
                      emails:
                      - email: John.Smith@example.com
                        type: WORK
                      - email: John.Smith.priv@example.com
                        type: HOME
                      name:
                        firstName: John
                        lastName: Smith
                        middleName: B
                        namePrefix: Mr.
                        formattedName: Mr. John Smith
                      org:
                        company: Company Name
                        department: Department
                        title: Director
                      phones:
                      - phone: '+441134960019'
                        type: HOME
                        waId: '441134960019'
                      - phone: '+441134960000'
                        type: WORK
                        waId: '441134960000'
                      urls:
                      - url: http://example.com/John.Smith
                        type: WORK
                      - url: http://example.com/home/John.Smith
                        type: HOME
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
              Multiple contacts message:
                summary: Multiple contacts message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    contacts:
                    - addresses:
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: WORK
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: HOME
                      birthday: '2010-01-01'
                      emails:
                      - email: John.Smith@example.com
                        type: WORK
                      - email: John.Smith.priv@example.com
                        type: HOME
                      name:
                        firstName: John
                        lastName: Smith
                        middleName: B
                        namePrefix: Mr.
                        formattedName: Mr. John Smith
                      org:
                        company: Company Name
                        department: Department
                        title: Director
                      phones:
                      - phone: '+441134960019'
                        type: HOME
                        waId: '441134960019'
                      - phone: '+441134960000'
                        type: WORK
                        waId: '441134960000'
                      urls:
                      - url: http://example.com/John.Smith
                        type: WORK
                      - url: http://example.com/home/John.Smith
                        type: HOME
                    - addresses:
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: WORK
                      - street: Istarska
                        city: Vodnjan
                        zip: '52215'
                        country: Croatia
                        countryCode: HR
                        type: HOME
                      birthday: '2010-01-01'
                      emails:
                      - email: Alexander.Abraham@example.com
                        type: WORK
                      - email: Alexander.Abraham.priv@example.com
                        type: HOME
                      name:
                        firstName: Alexander
                        lastName: Abraham
                        middleName: B
                        namePrefix: Mr.
                        formattedName: Mr. Alexander Abraham
                      org:
                        company: Company Name
                        department: Department
                        title: Director
                      phones:
                      - phone: '+441134960010'
                        type: HOME
                        waId: '441134960010'
                      - phone: '+441134960011'
                        type: WORK
                        waId: '441134960011'
                      urls:
                      - url: http://example.com/Alexander.Abraham
                        type: WORK
                      - url: http://example.com/home/Alexander.Abraham
                        type: HOME
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Incorrect date format error response:
                  summary: Incorrect date format error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.contacts[0].birthday:
                          - must be in the YYYY-MM-DD format
                Incorrect email error response:
                  summary: Incorrect email error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.contacts[0].emails[0].email:
                          - must be a well-formed email address
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/buttons:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive buttons message
      description: Send an interactive buttons message to a single recipient. Interactive buttons messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-buttons-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsMessage'
            examples:
              Interactive reply buttons message:
                summary: Interactive reply buttons message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttons:
                      - type: REPLY
                        id: '1'
                        title: 'Yes'
                      - type: REPLY
                        id: '2'
                        title: 'No'
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Text header interactive reply buttons message:
                summary: Text header interactive reply buttons message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttons:
                      - type: REPLY
                        id: '1'
                        title: 'Yes'
                      - type: REPLY
                        id: '2'
                        title: 'No'
                    header:
                      type: TEXT
                      text: Header
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Video header interactive reply buttons message:
                summary: Video header interactive reply buttons message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttons:
                      - type: REPLY
                        id: '1'
                        title: 'Yes'
                      - type: REPLY
                        id: '2'
                        title: 'No'
                    header:
                      type: VIDEO
                      mediaUrl: https://example.com/video
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Image header interactive reply buttons message:
                summary: Image header interactive reply buttons message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttons:
                      - type: REPLY
                        id: '1'
                        title: 'Yes'
                      - type: REPLY
                        id: '2'
                        title: 'No'
                    header:
                      type: IMAGE
                      mediaUrl: https://example.com/image
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Document header interactive reply buttons message:
                summary: Document header interactive reply buttons message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttons:
                      - type: REPLY
                        id: '1'
                        title: 'Yes'
                      - type: REPLY
                        id: '2'
                        title: 'No'
                    header:
                      type: DOCUMENT
                      mediaUrl: https://example.com/document
                      filename: document.pdf
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.header.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Body text validation error response:
                  summary: Body text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.body.text:
                          - size must be between 1 and 1024
                          - must not be blank
                Buttons validation error response:
                  summary: Buttons validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.buttons:
                          - ids and titles must be unique
                          - size must be between 1 and 3
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/list:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive list message
      description: Send an interactive list message to a single recipient. Interactive list messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-list-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListMessage'
            examples:
              Interactive list message:
                summary: Interactive list message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      title: Choose one
                      sections:
                      - rows:
                        - id: '1'
                          title: row title
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Header interactive list message:
                summary: Header interactive list message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      title: Choose one
                      sections:
                      - title: First section title
                        rows:
                        - id: '1'
                          title: first row title
                          description: first row description
                        - id: '2'
                          title: second row title
                          description: second row description
                      - title: Second section title
                        rows:
                        - id: '3'
                          title: third row title
                    header:
                      type: TEXT
                      text: Header
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Header text validation error response:
                  summary: Header text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.header.text:
                          - size must be between 1 and 60
                          - must not be blank
                Sections validation error response:
                  summary: Sections validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.sections:
                          - number of rows must be between 1 and 10
                          - row's ids must be unique across sections
                          - titles must not be blank when more than one section provided
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/media-carousel:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive media carousel message
      description: Send an interactive media carousel message to a single recipient. Interactive media carousel messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-media-carousel-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselMessage'
            examples:
              Interactive media carousel message with url button:
                summary: Interactive media carousel message with url button
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      cards:
                      - header:
                          url: https://www.example.com/image.png
                          type: IMAGE
                        body:
                          text: Some text
                        button:
                          displayText: some button text
                          url: https://www.example.com
                      - header:
                          url: https://www.example.com/image.png
                          type: IMAGE
                        body:
                          text: Some text
                        button:
                          displayText: some button text
                          url: https://www.example.com
                      type: URL
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Header interactive media carousel message:
                summary: Header interactive media carousel message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      cards:
                      - header:
                          url: https://www.example.com/image.png
                          type: IMAGE
                        body:
                          text: Some text
                        buttons:
                        - id: some button id
                          title: some button title
                      - header:
                          url: https://www.example.com/image.png
                          type: IMAGE
                        body:
                          text: Some text
                        buttons:
                        - id: some button id
                          title: some button title
                      type: QUICK_REPLY
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Action cards validation error response:
                  summary: Action cards validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.cards:
                          - size must be between 2 and 10
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/location-request:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive location request message
      description: Send an interactive location request message to a single recipient. Interactive location request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-location-request-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestMessage'
            examples:
              Interactive location request message:
                summary: Interactive location request message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/product:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive product message
      description: Send an interactive product message to a single recipient. Interactive product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-product-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductMessage'
            examples:
              Interactive product message:
                summary: Interactive product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      catalogId: '1'
                      productRetailerId: '2'
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Body interactive product message:
                summary: Body interactive product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      catalogId: '1'
                      productRetailerId: '2'
                    body:
                      text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Footer interactive product message:
                summary: Footer interactive product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      catalogId: '1'
                      productRetailerId: '2'
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Body and footer interactive product message:
                summary: Body and footer interactive product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      catalogId: '1'
                      productRetailerId: '2'
                    body:
                      text: Some text
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Footer text validation error response:
                  summary: Footer text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.footer.text:
                          - size must be between 1 and 60
                          - must not be blank
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/multi-product:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive multi-product message
      description: Send an interactive multi-product message to a single recipient. Interactive multi-product messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-multi-product-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductMessage'
            examples:
              Interactive multi-product message:
                summary: Interactive multi-product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    header:
                      type: TEXT
                      text: Header
                    body:
                      text: Some text
                    action:
                      catalogId: '1'
                      sections:
                      - title: Title
                        productRetailerIds:
                        - '1'
                        - '2'
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Footer interactive multi-product message:
                summary: Footer interactive multi-product message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    header:
                      type: TEXT
                      text: Header
                    body:
                      text: Some text
                    action:
                      catalogId: '1'
                      sections:
                      - title: Title
                        productRetailerIds:
                        - '1'
                        - '2'
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Footer text validation error response:
                  summary: Footer text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.footer.text:
                          - size must be between 1 and 60
                          - must not be blank
                Sections validation error response:
                  summary: Sections validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.sections:
                          - size must be between 1 and 10
                          - titles must not be blank when more than one section provided
                          - number of products must be between 1 and 30
                Product retailer ids validation error response:
                  summary: Product retailer ids validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.sections[0].productRetailerIds:
                          - products in section must be unique
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/order-details:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive order-details message
      description: Send an interactive order-details message to a single recipient. <br/> An order-details message is a structured message containing essential information about the customer's selected products. Alternatively, a [single](#channels/whatsapp/send-whatsapp-interactive-product-message) or [multi-product](#channels/whatsapp/send-whatsapp-interactive-multi-product-message) interactive message can serve this purpose. <br/> Interactive order-details messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-order-details-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsMessage'
            examples:
              Interactive UPI PayU order-details message:
                summary: Interactive UPI PayU order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: UPI_PAYU
                        id: fd3e847h2
                        productDescription: tshirt100
                        customerFirstName: John
                        customerLastName: Smith
                        customerEmail: John.Smith@example.com
                        callbackData:
                        - customData1
                        - customData2
                        - customData3
                        - customData4
                        - customData5
                      paymentConfiguration: payment-config
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                        orderDetailsType: QUICK_PAY
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil order-details message:
                summary: Interactive Brazil order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL
                        id: fd3e847h2
                      paymentConfiguration: payment-config
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil Pix DC order-details message:
                summary: Interactive Brazil Pix DC order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL_PIX_DC
                        id: fd3e847h2
                        code: 00020101021226900014br.gov.bcb.pix2568pix
                        merchantName: Company Name
                        keyType: CNPJ
                        key: 01234567891234
                      paymentConfiguration: payment-config
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil Pix DC order-details message without paymentConfiguration:
                summary: Interactive Brazil Pix DC order-details message without paymentConfiguration
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL_PIX_DC
                        id: fd3e847h2
                        code: 00020101021226900014br.gov.bcb.pix2568pix
                        merchantName: Company Name
                        keyType: CNPJ
                        key: 01234567891234
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil Link order-details message:
                summary: Interactive Brazil Link order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL_LINK
                        id: fd3e847h2
                        paymentLink: https://example.com/payment-link
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil Boleto order-details message:
                summary: Interactive Brazil Boleto order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL_BOLETO
                        id: fd3e847h2
                        code: 03399026944140000002628346101018898510000008848
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive Brazil Payments order-details message:
                summary: Interactive Brazil Payments order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: BRAZIL_PAYMENTS
                        payments:
                        - type: BRAZIL_PIX_DC
                          id: fd3e847h2
                          code: 00020101021226900014br.gov.bcb.pix2568pix
                          merchantName: Company Name
                          keyType: CNPJ
                          key: 01234567891234
                        - type: BRAZIL_BOLETO
                          id: fd3e847h2
                          code: 03399026944140000002628346101018898510000008848
                      orderCurrency: BRL
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive PG PayU order-details message:
                summary: Interactive PG PayU order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: PG_PAYU
                        id: fd3e847h2
                        beneficiary:
                          name: John Smith
                          firstAddressLine: address line
                          secondAddressLine: address line
                          city: city
                          state: state
                          country: INDIA
                          postalCode: '123456'
                        callbackData:
                        - customData1
                        - customData2
                        - customData3
                        - customData4
                      paymentConfiguration: payment-config
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive PG Razorpay order-details message:
                summary: Interactive PG Razorpay order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: PG_RAZORPAY
                        id: fd3e847h2
                        beneficiary:
                          name: John Smith
                          firstAddressLine: address line
                          secondAddressLine: address line
                          city: city
                          state: state
                          country: INDIA
                          postalCode: '123456'
                        callbackData:
                          key0: customData1
                          key1: customData2
                          key2: customData3
                          key3: customData4
                          key4: customData5
                          key5: customData6
                          key6: customData7
                          key7: customData8
                          key8: customData9
                          key9: customData10
                          key10: customData11
                          key11: customData12
                          key12: customData13
                          key13: customData14
                          key14: customData15
                      paymentConfiguration: payment-config
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive UPI Intent Link order-details message:
                summary: Interactive UPI Intent Link order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: UPI_INTENT
                        id: fd3e847h2
                        beneficiary:
                          name: John Smith
                          firstAddressLine: address line
                          secondAddressLine: address line
                          city: city
                          state: state
                          country: INDIA
                          postalCode: '123456'
                        format:
                          type: LINK
                          paymentLink: upi://pay?pa=example@upi&pn=Example%20Merchant&mc=4722&&tr=1234567890
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive UPI Link order-details message:
                summary: Interactive UPI Link order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: UPI_LINK
                        id: fd3e847h2
                        beneficiary:
                          name: John Smith
                          firstAddressLine: address line
                          secondAddressLine: address line
                          city: city
                          state: state
                          country: INDIA
                          postalCode: '123456'
                        paymentLink: https://payment.example.com/upi-link
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        catalogId: '1'
                        items:
                        - retailerId: '1'
                          name: discounted product
                          amount:
                            value: 10000
                          saleAmount:
                            value: 5000
                          quantity: 2
                        - retailerId: '2'
                          name: product
                          amount:
                            value: 10000
                          quantity: 1
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Header interactive UPI PayU order-details message:
                summary: Header interactive UPI PayU order-details message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      payment:
                        type: UPI_PAYU
                        id: fd3e847h2
                        productDescription: tshirt100
                        customerFirstName: John
                        customerLastName: Smith
                        customerEmail: John.Smith@example.com
                        callbackData:
                        - customData1
                        - customData2
                        - customData3
                        - customData4
                        - customData5
                      paymentConfiguration: payment-config
                      orderCurrency: INR
                      orderType: DIGITAL_GOODS
                      totalAmount:
                        value: 21000
                      order:
                        items:
                        - retailerId: '1'
                          name: product
                          amount:
                            value: 10000
                          quantity: 2
                          originCountry: country of origin
                          importerName: importer name
                          importerAddress:
                            firstAddressLine: address line
                            secondAddressLine: address line
                            city: city
                            zoneCode: zone code
                            postalCode: postal code
                            countryCode: country code
                        subtotal:
                          value: 20000
                        tax:
                          value: 1000
                          description: tax included
                        shipping:
                          value: 1000
                          description: shipping cost
                        discount:
                          amount:
                            value: 1000
                            description: discount
                          programName: membership discount
                        orderExpiration:
                          expirationSeconds: 500
                          description: limited offer
                    header:
                      type: IMAGE
                      mediaUrl: https://example.com/image
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.header.mediaUrl:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Missing catalogId validation error response:
                  summary: Missing catalogId validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.order:
                          - if catalogId is not present then originCountry, importerName and importerAddress must be specified
                Total amount validation error response:
                  summary: Total amount validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action:
                          - totalAmount must be sum of subtotal, tax and shipping reduced by discount
                Sale amount validation error response:
                  summary: Sale amount validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.order.items[0]:
                          - saleAmount must be less than amount
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/order-status:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive order-status message
      description: Send an interactive order-status message to a single recipient. <br/> An order-status message delivers real-time updates to customers about the current status of their order. <br/> Interactive order-status messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-order-status-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusMessage'
            examples:
              Interactive order-status message:
                summary: Interactive order-status message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      payment:
                        type: UPI_PAYU
                        id: '16085194825'
                      status: SHIPPED
                      description: Order shipped
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Body interactive order-status message:
                summary: Body interactive order-status message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      payment:
                        type: UPI_PAYU
                        id: '16085194825'
                      status: SHIPPED
                      description: Order shipped
                    body:
                      text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Footer interactive order-status message:
                summary: Footer interactive order-status message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      payment:
                        type: UPI_PAYU
                        id: '16085194825'
                      status: SHIPPED
                      description: Order shipped
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Body and footer interactive order-status message:
                summary: Body and footer interactive order-status message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    action:
                      payment:
                        type: UPI_PAYU
                        id: '16085194825'
                      status: SHIPPED
                      description: Order shipped
                    body:
                      text: Some text
                    footer:
                      text: Footer
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Payment validation error response:
                  summary: Payment validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.payment.id:
                          - must not be blank
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/flow:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive flow message
      description: Send an interactive flow message to a single recipient. Interactive flow messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-flow-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowMessage'
            examples:
              Interactive flow message:
                summary: Interactive flow message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      mode: PUBLISHED
                      flowMessageVersion: 3
                      flowToken: Flow token
                      flowId: 98E8D4AA79E2697757FAA
                      callToActionButton: Button text
                      flowAction: NAVIGATE
                      flowActionPayload:
                        screen: product_screen
                        data:
                          product_name: name
                          product_price: 200
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Header and footer interactive flow message:
                summary: Header and footer interactive flow message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      mode: PUBLISHED
                      flowMessageVersion: 3
                      flowToken: Flow token
                      flowId: 98E8D4AA79E2697757FAA
                      callToActionButton: Button text
                      flowAction: NAVIGATE
                      flowActionPayload:
                        screen: product_screen
                        data:
                          product_name: name
                          product_price: 200
                    header:
                      type: TEXT
                      text: Header text
                    footer:
                      text: Footer text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Flow action payload validation error response:
                  summary: Flow action payload validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.flowActionPayload.screen:
                          - must not be blank
                Call to action button validation error response:
                  summary: Call to action button validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.callToActionButton:
                          - must not be blank
                          - size must be between 1 and 20
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/url-button:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive url button message
      description: Send an interactive url button message to a single recipient.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-url-button-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonMessage'
            examples:
              Interactive url button message:
                summary: Interactive url button message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      displayText: Display text
                      url: https://www.example.com
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Header and footer interactive url button message:
                summary: Header and footer interactive url button message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      displayText: Display text
                      url: https://www.example.com
                    header:
                      type: TEXT
                      text: Header text
                    footer:
                      text: Footer text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Url validation error response:
                  summary: Url validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.url:
                          - size must be between 1 and 2048
                          - is not a valid url
                          - must not be blank
                Url button display text validation error response:
                  summary: Url button display text validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.displayText:
                          - must not be blank
                          - size must be between 1 and 20
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/call-permission-request:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive call permission request message
      description: Send an interactive call permission request message to a single recipient. Interactive call permission request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-call-permission-request-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveCallPermissionRequestMessage'
            examples:
              Interactive call permission request message:
                summary: Interactive call permission request message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/voice-button:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive voice button message
      description: Send an interactive voice button message to a single recipient. Interactive voice button messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-voice-button-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessage'
            examples:
              Interactive voice button message:
                summary: Interactive voice button message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
              Interactive voice button message with all action fields:
                summary: Interactive voice button message with all action fields
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                    action:
                      buttonDisplayText: Call us
                      callValidityPeriod: 1440
                      callContextPayload: context-payload
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Voice button action validation error response:
                  summary: Voice button action validation error response
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          content.action.callValidityPeriod:
                          - must be less than or equal to 43200
                          content.action.callContextPayload:
                          - size must be between 1 and 512
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/in-thread-authentication-request:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive in-thread authentication request message
      description: Send an interactive in-thread authentication request message to a single recipient. Interactive in-thread authentication request messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-in-thread-authentication-request-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveInThreadAuthenticationRequestMessage'
            examples:
              Interactive in-thread authentication request message:
                summary: Interactive in-thread authentication request message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/message/interactive/request-contact-info:
    post:
      tags:
      - channels
      summary: Send WhatsApp interactive request contact info message
      description: Send an interactive request contact info message to a single recipient. Interactive request contact info messages can only be successfully delivered if the recipient has contacted the business within the last 24 hours, otherwise [template message](#channels/whatsapp/send-whatsapp-template-message) should be used. <br/> The API response will not contain the final delivery status, use [Delivery Reports](#channels/whatsapp/receive-whatsapp-delivery-reports) instead.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-interactive-request-contact-info-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoMessage'
            examples:
              Interactive request contact info message:
                summary: Interactive request contact info message
                value:
                  from: '441134960000'
                  to: '441134960001'
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  content:
                    body:
                      text: Some text
                  callbackData: Callback data
                  notifyUrl: https://www.example.com/whatsapp
                  urlOptions:
                    shortenUrl: true
                    trackClicks: true
                    trackingUrl: https://example.com/click-report
                    removeProtocol: true
        required: true
      responses:
        '200':
          description: Message accepted for delivery
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    to: '441134960001'
                    messageCount: 1
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 4000
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/events:
    post:
      tags:
      - channels
      summary: Send WhatsApp events
      description: Send WhatsApp events to multiple recipients.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: send-whatsapp-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventRequest'
            examples:
              Typing indicator:
                summary: Typing indicator
                value:
                  events:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      type: TYPING_INDICATOR
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '441134960001'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - whatsapp:message:send
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/media/{mediaId}:
    get:
      tags:
      - channels
      summary: Download inbound media
      description: Download WhatsApp media sent by end-users.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: download-whatsapp-inbound-media
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: mediaId
        in: path
        description: ID of the media.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 20250_13_123e4567-e89b-12d3-a456-426655440000
      responses:
        '200':
          description: Media successfully downloaded
          content:
            '*/*':
              schema:
                type: string
                format: binary
                description: Media binary stream response
        '302':
          description: Redirect to CDN URL for cached media
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Media not found or expired
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - whatsapp:inbound-message:read
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
    head:
      tags:
      - channels
      summary: Get media metadata
      description: Get metadata of WhatsApp media sent by end-users to check media type and the size of a file without downloading the content.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-media-metadata
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: mediaId
        in: path
        description: ID of the media.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 20250_13_123e4567-e89b-12d3-a456-426655440000
      responses:
        '200':
          description: Media metadata successfully downloaded
          headers:
            Content-Length:
              description: The size of a media file in bytes.
              required: true
              style: simple
              explode: false
              schema:
                type: string
            Content-Type:
              description: The Content type of a media file.
              required: true
              style: simple
              explode: false
              schema:
                type: string
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Media not found or expired
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/message/{messageId}/read:
    post:
      tags:
      - channels
      summary: Mark as read
      description: Mark WhatsApp messages sent by end-users as read.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: mark-whatsapp-message-as-read
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: messageId
        in: path
        description: ID of the message to be marked as read.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: abcdef_ghij124567890klmnopr
      responses:
        '204':
          description: Message successfully marked as read
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.MarkAsReadErrorResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/payments/upi/payu/{paymentId}:
    get:
      tags:
      - channels
      summary: Get India UPI PayU payment status
      description: Get India UPI PayU payment and transaction status.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-upi-payu-payment-status
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: paymentId
        in: path
        description: Unique identifier of the payment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 25
          minLength: 1
        example: 16085194825
      responses:
        '200':
          description: Payment successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment'
              examples:
                Success response:
                  summary: Success response
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                Success response with callbackData:
                  summary: Success response with callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                    - customData1
                    - customData2
                    - customData3
                    - customData4
                Success response with key-value callbackData:
                  summary: Success response with key-value callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                      customKey1: customValue1
                      customKey2: customValue2
                      customKey3: customValue3
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Transaction not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - whatsapp:inbound-message:read
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/payments/br/{paymentId}:
    get:
      tags:
      - channels
      summary: Get Brazil payment status
      description: Get Brazil payment and transaction status.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-brazil-payment-status
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: paymentId
        in: path
        description: Unique identifier of the payment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9\-_.]{1,35}$
        example: 16085194825
      responses:
        '200':
          description: Payment successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment'
              examples:
                Success response:
                  summary: Success response
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                Success response with callbackData:
                  summary: Success response with callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                    - customData1
                    - customData2
                    - customData3
                    - customData4
                Success response with key-value callbackData:
                  summary: Success response with key-value callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                      customKey1: customValue1
                      customKey2: customValue2
                      customKey3: customValue3
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Transaction not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - whatsapp:inbound-message:read
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/payments/upi/{paymentId}:
    get:
      tags:
      - channels
      summary: Get India UPI PayU/Razorpay payment status
      description: Get India UPI PayU/Razor payment and transaction status.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-upi-payment-status
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: paymentId
        in: path
        description: Unique identifier of the payment.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          pattern: ^[A-Za-z0-9\-_.]{1,35}$
        example: 16085194825
      responses:
        '200':
          description: Payment successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment'
              examples:
                Success response:
                  summary: Success response
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                Success response with callbackData:
                  summary: Success response with callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                    - customData1
                    - customData2
                    - customData3
                    - customData4
                Success response with key-value callbackData:
                  summary: Success response with key-value callbackData
                  value:
                    referenceId: '72123248136'
                    paymentId: '16085194825'
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T00:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                    callbackData:
                      customKey1: customValue1
                      customKey2: customValue2
                      customKey3: customValue3
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Transaction not found.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - whatsapp:inbound-message:read
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/2/senders/{sender}/templates:
    get:
      tags:
      - channels
      summary: Get WhatsApp Templates
      description: Get all the templates and their statuses for a given sender.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-templates
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      responses:
        '200':
          description: List of all templates and their statuses for a given sender.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatesApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        header:
                          format: IMAGE
                        body:
                          text: example {{1}} body
                        footer:
                          text: exampleFooter
                        type: MEDIA
                      quality: HIGH
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template_with_header
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        header:
                          text: exampleContent
                          format: TEXT
                        body:
                          text: example {{1}} body
                        footer:
                          text: exampleFooter
                        type: MEDIA
                      quality: MEDIUM
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template_with_buttons
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        header:
                          format: IMAGE
                        body:
                          text: example {{1}} body
                        footer:
                          text: exampleFooter
                        buttons:
                        - type: PHONE_NUMBER
                          text: Dial 911
                          phoneNumber: '911'
                        - type: URL
                          text: Visit our website
                          url: https://www.infobip.com
                        type: MEDIA
                      quality: LOW
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Text template:
                  summary: Text template
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: text_template
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        body:
                          text: example {{1}} body
                        type: TEXT
                      quality: UNKNOWN
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create WhatsApp Template
      description: Create a WhatsApp template. Once created, Infobip submits a template for WhatsApp's review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: create-whatsapp-template
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest'
            examples:
              Template:
                summary: Template
                value:
                  name: text_template
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
              Template with image header:
                summary: Template with image header
                value:
                  name: media_template_with_image_header
                  language: en
                  category: MARKETING
                  structure:
                    header:
                      example: https://www.example.com/image.png
                      format: IMAGE
                    body:
                      text: body {{1}} content
                      examples:
                      - example
              Template with footer:
                summary: Template with footer
                value:
                  name: media_template_with_footer
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    footer:
                      text: footer content
              Template with quick reply buttons:
                summary: Template with quick reply buttons
                value:
                  name: media_template_with_quick_reply_buttons
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: QUICK_REPLY
                      text: quick reply 1
                    - type: QUICK_REPLY
                      text: quick reply 2
                    - type: QUICK_REPLY
                      text: quick reply 3
              Template with call to action buttons:
                summary: Template with call to action buttons
                value:
                  name: media_template_with_call_to_action_buttons
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: PHONE_NUMBER
                      text: call agent
                      phoneNumber: '007'
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
              template with dynamic url button:
                summary: template with dynamic url button
                value:
                  name: media_template_with_dynamic_url_button
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
              Template with all elements:
                summary: Template with all elements
                value:
                  name: media_template_with_all_elements
                  language: en
                  category: MARKETING
                  structure:
                    header:
                      example: https://www.example.com/image.png
                      format: IMAGE
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    footer:
                      text: footer content
                    buttons:
                    - type: PHONE_NUMBER
                      text: call agent
                      phoneNumber: '007'
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
              Template with copy code button:
                summary: Template with copy code button
                value:
                  name: media_template_with_copy_code_button
                  language: en
                  category: MARKETING
                  structure:
                    header:
                      example: https://www.example.com/image.png
                      format: IMAGE
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: COPY_CODE
                      example: exampleCode
              Template with flow button:
                summary: Template with flow button
                value:
                  name: media_template_with_flow_button
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: FLOW
                      text: exampleText
                      flowId: 123456
                      flowAction: NAVIGATE
                      navigateScreen: exampleNavigateScreen
              Template with catalog button:
                summary: Template with catalog button
                value:
                  name: media_template_with_catalog_button
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: CATALOG
              Template with multi product button:
                summary: Template with multi product button
                value:
                  name: media_template_with_multi_product_button
                  language: en
                  category: MARKETING
                  structure:
                    header:
                      example: https://www.example.com/image.png
                      format: IMAGE
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: MULTI_PRODUCT
              Template with order details button:
                summary: Template with order details button
                value:
                  name: media_template_with_order_details_button
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: ORDER_DETAILS
                      variant: BRAZIL
              Template with voice call button:
                summary: Template with voice call button
                value:
                  name: media_template_with_order_details_button
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: VOICE_CALL
                      text: Call Now
                      callValidityPeriod: 1440
              Template with request contact info button:
                summary: Template with request contact info button
                value:
                  name: media_template_with_request_contact_info
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: REQUEST_CONTACT_INFO
                      text: Share Contact Info
              Template with order status subcategory:
                summary: Template with order status subcategory
                value:
                  name: media_template_with_order_status_subcategory
                  language: en
                  category: UTILITY
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                  subCategory: ORDER_STATUS
              Template with carousel:
                summary: Template with carousel
                value:
                  name: media_template_with_carousel
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    carousel:
                      cards:
                      - header:
                          example: https://www.example.com/image.png
                          format: IMAGE
                        body:
                          text: body {{1}} content
                          examples:
                          - example
                        buttons:
                        - type: PHONE_NUMBER
                          text: call agent
                          phoneNumber: '007'
                        - type: URL
                          text: visit website
                          url: https://www.infobip.com/{{1}}
                          example: https://www.infobip.com/docs
              Template with limited time offer:
                summary: Template with limited time offer
                value:
                  name: media_template_with_limited_time_offer
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
                    limitedTimeOffer:
                      hasExpiration: false
                      text: Example offer
              Template with limited time offer with expiration:
                summary: Template with limited time offer with expiration
                value:
                  name: media_template_with_limited_time_offer
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: COPY_CODE
                      example: exampleCode
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
                    limitedTimeOffer:
                      hasExpiration: true
                      text: Example offer
              Template with call permission request:
                summary: Template with call permission request
                value:
                  name: media_template_with_call_permission_request
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    callPermissionRequest: {}
              Authentication template with copy code button:
                summary: Authentication template with copy code button
                value:
                  name: authentication_template_with_copy_code_button
                  language: en
                  category: AUTHENTICATION
                  structure:
                    body:
                      addSecurityRecommendation: true
                    footer:
                      codeExpirationMinutes: 5
                    buttons:
                    - text: Copy code
                      otpType: COPY_CODE
              Authentication template with one-tap button:
                summary: Authentication template with one-tap button
                value:
                  name: authentication_template_with_one_tap_button
                  language: en
                  category: AUTHENTICATION
                  structure:
                    body:
                      addSecurityRecommendation: false
                    footer:
                      codeExpirationMinutes: 10
                    buttons:
                    - text: '123456'
                      autofillText: '123456'
                      packageName: com.example.myapplication
                      signatureHash: K8a%2FAINcGX7
                      otpType: ONE_TAP
              Authentication template with validity period:
                summary: Authentication template with validity period
                value:
                  name: authentication_template_with_validity_period
                  language: en
                  category: AUTHENTICATION
                  structure:
                    body:
                      addSecurityRecommendation: true
                    footer:
                      codeExpirationMinutes: 5
                    buttons:
                    - text: Copy code
                      otpType: COPY_CODE
                  validityPeriod:
                    amount: 5
                    timeUnit: MINUTES
              Template platform data:
                summary: Template platform data
                value:
                  name: text_template
                  language: en
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                  platform:
                    entityId: entityId
                    applicationId: applicationId
        required: true
      responses:
        '201':
          description: Template created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: HIGH
                    platform:
                      entityId: entityId
                      applicationId: applicationId
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_header
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        text: exampleContent
                        format: TEXT
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: MEDIUM
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_buttons
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      buttons:
                      - type: PHONE_NUMBER
                        text: Dial 911
                        phoneNumber: '911'
                      - type: URL
                        text: Visit our website
                        url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Copy Code:
                  summary: Media Template with Copy Code
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_copy_code
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: COPY_CODE
                        text: Copy offer code
                        example: exampleCopyCode
                      shorteningOptions:
                        customDomain: my-domain
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Order Details:
                  summary: Media Template with Order Details
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_order_details
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: ORDER_DETAILS
                        variant: BRAZIL
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Voice Call:
                  summary: Media Template with Voice Call
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_voice_call
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: VOICE_CALL
                        text: Call Now
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Request Contact Info:
                  summary: Media Template with Request Contact Info
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_request_contact_info
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: REQUEST_CONTACT_INFO
                        text: Share Contact Info
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Order Status Template:
                  summary: Order Status Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: order_status_template
                    language: en
                    status: APPROVED
                    category: UTILITY
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    subCategory: ORDER_STATUS
                Media Template with Carousel:
                  summary: Media Template with Carousel
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_carousel
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      carousel:
                        cards:
                        - header:
                            format: IMAGE
                          body:
                            text: example {{1}} body
                          buttons:
                          - type: PHONE_NUMBER
                            text: Dial 911
                            phoneNumber: '911'
                          - type: URL
                            text: Visit our website
                            url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Flow Button:
                  summary: Media Template with Flow Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_flow_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: FLOW
                        text: example text
                        flowId: 123456
                        flowAction: NAVIGATE
                        navigateScreen: exampleScreen
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Catalog Button:
                  summary: Media Template with Catalog Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_catalog_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: CATALOG
                        text: View catalog
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Multi Product Button:
                  summary: Media Template with Multi Product Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_multi_product_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: MULTI_PRODUCT
                        text: View items
                      shorteningOptions:
                        customDomain: example.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Text template:
                  summary: Text template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: text_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template:
                  summary: Authentication Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template with validity period:
                  summary: Authentication Template with validity period
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    validityPeriod:
                      amount: 2
                      timeUnit: MINUTES
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Not found:
                  summary: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1000
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/2/senders/{sender}/templates/{templateName}:
    delete:
      tags:
      - channels
      summary: Delete WhatsApp Template
      description: 'Delete a WhatsApp template.

        * If registered in multiple languages, deleting the message template will also delete all its languages.

        * The template will be deleted for all senders registered under the same WhatsApp Business Account (WABA).

        * The system will attempt to deliver sent messages for 30 days, regardless of the template deletion.

        * Once deleted, the name of the approved template cannot be reused for 30 days.'
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: delete-whatsapp-template
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: templateName
        in: path
        description: Template name. Must only contain lowercase alphanumeric characters and underscores.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          pattern: ^[a-z0-9_]{1,512}$
        example: template_name
      responses:
        '204':
          description: Template deleted.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 200
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/2/senders/{sender}/templates/{id}:
    get:
      tags:
      - channels
      summary: Get WhatsApp Template
      description: Get a single template with its status for a given template ID.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-template
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: id
        in: path
        description: Template ID. Must be a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '5653923468715475'
      responses:
        '200':
          description: Template with its status for a given template ID.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: HIGH
                    platform:
                      entityId: entityId
                      applicationId: applicationId
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_header
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        text: exampleContent
                        format: TEXT
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: MEDIUM
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_buttons
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      buttons:
                      - type: PHONE_NUMBER
                        text: Dial 911
                        phoneNumber: '911'
                      - type: URL
                        text: Visit our website
                        url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Copy Code:
                  summary: Media Template with Copy Code
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_copy_code
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: COPY_CODE
                        text: Copy offer code
                        example: exampleCopyCode
                      shorteningOptions:
                        customDomain: my-domain
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Order Details:
                  summary: Media Template with Order Details
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_order_details
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: ORDER_DETAILS
                        variant: BRAZIL
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Voice Call:
                  summary: Media Template with Voice Call
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_voice_call
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: VOICE_CALL
                        text: Call Now
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Request Contact Info:
                  summary: Media Template with Request Contact Info
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_request_contact_info
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: REQUEST_CONTACT_INFO
                        text: Share Contact Info
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Order Status Template:
                  summary: Order Status Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: order_status_template
                    language: en
                    status: APPROVED
                    category: UTILITY
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    subCategory: ORDER_STATUS
                Media Template with Carousel:
                  summary: Media Template with Carousel
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_carousel
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      carousel:
                        cards:
                        - header:
                            format: IMAGE
                          body:
                            text: example {{1}} body
                          buttons:
                          - type: PHONE_NUMBER
                            text: Dial 911
                            phoneNumber: '911'
                          - type: URL
                            text: Visit our website
                            url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Flow Button:
                  summary: Media Template with Flow Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_flow_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: FLOW
                        text: example text
                        flowId: 123456
                        flowAction: NAVIGATE
                        navigateScreen: exampleScreen
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Catalog Button:
                  summary: Media Template with Catalog Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_catalog_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: CATALOG
                        text: View catalog
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Multi Product Button:
                  summary: Media Template with Multi Product Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_multi_product_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: MULTI_PRODUCT
                        text: View items
                      shorteningOptions:
                        customDomain: example.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Text template:
                  summary: Text template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: text_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template:
                  summary: Authentication Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template with validity period:
                  summary: Authentication Template with validity period
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    validityPeriod:
                      amount: 2
                      timeUnit: MINUTES
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Template with the specified ID does not exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Not found:
                  summary: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Edit WhatsApp Template
      description: 'Edit a WhatsApp template. Once edited, Infobip submits a template for WhatsApp''s review and approval. When approved, a template can be sent to end users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/remaining-compliant#message-templates) for additional info.

        * Only templates with an approved, rejected, or paused status can be edited.

        * Use the structure provided in the [Create WhatsApp Template](#channels/whatsapp/whatsapp-service-management/create-whatsapp-template) endpoint.

        * Category of an approved template cannot be edited.

        * Approved templates can be edited up to 10 times in a 30-day window, or 1 time in a 24-hour window. Rejected or paused templates can be edited an unlimited number of times.'
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: edit-whatsapp-template
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: id
        in: path
        description: Template ID. Must be a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '5653923468715475'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateEditPublicApiRequest'
            examples:
              Template:
                summary: Template
                value:
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    type: TEXT
              Authentication template:
                summary: Authentication template
                value:
                  category: AUTHENTICATION
                  structure:
                    body:
                      addSecurityRecommendation: true
                    footer:
                      codeExpirationMinutes: 5
                    buttons:
                    - text: Copy code
                      otpType: COPY_CODE
              Template category:
                summary: Template category
                value:
                  category: MARKETING
              Template structure:
                summary: Template structure
                value:
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    type: TEXT
              Template validity period:
                summary: Template validity period
                value:
                  validityPeriod:
                    amount: 120
                    timeUnit: SECONDS
              Carousel template structure:
                summary: Carousel template structure
                value:
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    carousel:
                      cards:
                      - header:
                          example: https://www.example.com/image.png
                          format: IMAGE
                        body:
                          text: body {{1}} content
                          examples:
                          - example
                        buttons:
                        - type: QUICK_REPLY
                          text: quick reply 1
                        - type: URL
                          text: visit website
                          url: https://www.infobip.com/{{1}}
                          example: https://www.infobip.com/docs
                    type: MEDIA
              Limited time offer template structure:
                summary: Limited time offer template structure
                value:
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: COPY_CODE
                      example: Copy code
                    - type: URL
                      text: visit website
                      url: https://www.infobip.com/{{1}}
                      example: https://www.infobip.com/docs
                    limitedTimeOffer:
                      hasExpiration: true
                      text: Example offer
                    type: MEDIA
              Call permission request template structure:
                summary: Call permission request template structure
                value:
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    callPermissionRequest: {}
                    type: MEDIA
              Request contact info template structure:
                summary: Request contact info template structure
                value:
                  category: MARKETING
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    buttons:
                    - type: REQUEST_CONTACT_INFO
                      text: Share Contact Info
                    type: MEDIA
              Template platform data:
                summary: Template platform data
                value:
                  platform:
                    entityId: entityId
                    applicationId: applicationId
              Order status template structure:
                summary: Order status template structure
                value:
                  structure:
                    body:
                      text: body {{1}} content
                      examples:
                      - example
                    type: TEXT
                  subCategory: ORDER_STATUS
        required: true
      responses:
        '200':
          description: Template edited.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: HIGH
                    platform:
                      entityId: entityId
                      applicationId: applicationId
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_header
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        text: exampleContent
                        format: TEXT
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      type: MEDIA
                    quality: MEDIUM
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_buttons
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      footer:
                        text: exampleFooter
                      buttons:
                      - type: PHONE_NUMBER
                        text: Dial 911
                        phoneNumber: '911'
                      - type: URL
                        text: Visit our website
                        url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Copy Code:
                  summary: Media Template with Copy Code
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_copy_code
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: COPY_CODE
                        text: Copy offer code
                        example: exampleCopyCode
                      shorteningOptions:
                        customDomain: my-domain
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Order Details:
                  summary: Media Template with Order Details
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_order_details
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: ORDER_DETAILS
                        variant: BRAZIL
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Voice Call:
                  summary: Media Template with Voice Call
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_voice_call
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: VOICE_CALL
                        text: Call Now
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Request Contact Info:
                  summary: Media Template with Request Contact Info
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_request_contact_info
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: REQUEST_CONTACT_INFO
                        text: Share Contact Info
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Order Status Template:
                  summary: Order Status Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: order_status_template
                    language: en
                    status: APPROVED
                    category: UTILITY
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    subCategory: ORDER_STATUS
                Media Template with Carousel:
                  summary: Media Template with Carousel
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_carousel
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      carousel:
                        cards:
                        - header:
                            format: IMAGE
                          body:
                            text: example {{1}} body
                          buttons:
                          - type: PHONE_NUMBER
                            text: Dial 911
                            phoneNumber: '911'
                          - type: URL
                            text: Visit our website
                            url: https://www.infobip.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Flow Button:
                  summary: Media Template with Flow Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_flow_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: FLOW
                        text: example text
                        flowId: 123456
                        flowAction: NAVIGATE
                        navigateScreen: exampleScreen
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Catalog Button:
                  summary: Media Template with Catalog Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_catalog_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: CATALOG
                        text: View catalog
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Media Template with Multi Product Button:
                  summary: Media Template with Multi Product Button
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_multi_product_button
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      header:
                        format: IMAGE
                      body:
                        text: example {{1}} body
                      buttons:
                      - type: MULTI_PRODUCT
                        text: View items
                      shorteningOptions:
                        customDomain: example.com
                      type: MEDIA
                    quality: LOW
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Text template:
                  summary: Text template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: text_template
                    language: en
                    status: APPROVED
                    category: MARKETING
                    structure:
                      body:
                        text: example {{1}} body
                      type: TEXT
                    quality: UNKNOWN
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template:
                  summary: Authentication Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                Authentication Template with validity period:
                  summary: Authentication Template with validity period
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: authentication_template
                    language: en
                    status: APPROVED
                    category: AUTHENTICATION
                    structure:
                      body:
                        text: '*{{1}}* is your verification code.'
                        examples:
                        - '123456'
                      footer:
                        text: This code expires in 15 minutes.
                      buttons:
                      - type: URL
                        text: Copy Code
                        url: https://wwww.whatsapp.com/otp/code/?otp_type=COPY_CODE&code=otp{{1}}
                      type: MEDIA
                    quality: HIGH
                    createdAt: 2024-01-01T00:00:00.000+0000
                    lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    validityPeriod:
                      amount: 2
                      timeUnit: MINUTES
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Not found:
                  summary: Not found
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/templates:
    get:
      tags:
      - channels
      summary: Get WhatsApp Templates
      description: Get all the templates and their statuses for a given sender. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/get-whatsapp-templates).
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: deprecated-get-whatsapp-templates
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      responses:
        '200':
          description: List of all templates and their statuses for a given sender.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplatesApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template
                      language: en
                      status: APPROVED
                      category: ACCOUNT_UPDATE
                      structure:
                        header:
                          format: IMAGE
                        body: example {{1}} body
                        footer: exampleFooter
                        type: MEDIA
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template_with_header
                      language: en
                      status: APPROVED
                      category: ACCOUNT_UPDATE
                      structure:
                        header:
                          text: exampleContent
                          format: TEXT
                        body: example {{1}} body
                        footer: exampleFooter
                        type: MEDIA
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template_with_buttons
                      language: en
                      status: APPROVED
                      category: ACCOUNT_UPDATE
                      structure:
                        header:
                          format: IMAGE
                        body: example {{1}} body
                        footer: exampleFooter
                        buttons:
                        - text: Dial 911
                          type: PHONE_NUMBER
                          phoneNumber: '911'
                        - text: Visit our website
                          type: URL
                          url: https://www.infobip.com
                        type: MEDIA
                Text template:
                  summary: Text template
                  value:
                    templates:
                    - id: '111'
                      businessAccountId: 222
                      name: text_template
                      language: en
                      status: APPROVED
                      category: ACCOUNT_UPDATE
                      structure:
                        body: example {{1}} body
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create WhatsApp Template
      description: Create a WhatsApp template. Created template will be submitted for WhatsApp's review and approval. Once approved, template can be sent to end-users. Refer to [template guidelines](https://www.infobip.com/docs/whatsapp/message-types#guidelines-amp-best-practices) for additional info. This version is deprecated as of June 29th 2022, meaning no fixes/updates will be provided and no new parameters will be added. This API will be deleted at the end of the year. Please use the [latest version](#channels/whatsapp/create-whatsapp-template).
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: deprecated-create-whatsapp-template
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8cb345d2b2e2a0cd5a7383bf2012768938eaa465c6e4f6554958ac7f4a58aa3f.V1TemplatePublicApiRequest'
            examples:
              Template with body:
                summary: Template with body
                value:
                  name: text_template
                  language: en
                  category: ACCOUNT_UPDATE
                  structure:
                    body: body {{1}} content
                    type: TEXT
        required: true
      responses:
        '201':
          description: Template created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse'
              examples:
                Media Template:
                  summary: Media Template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template
                    language: en
                    status: APPROVED
                    category: ACCOUNT_UPDATE
                    structure:
                      header:
                        format: IMAGE
                      body: example {{1}} body
                      footer: exampleFooter
                      type: MEDIA
                Media Template with Text header:
                  summary: Media Template with Text header
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_header
                    language: en
                    status: APPROVED
                    category: ACCOUNT_UPDATE
                    structure:
                      header:
                        text: exampleContent
                        format: TEXT
                      body: example {{1}} body
                      footer: exampleFooter
                      type: MEDIA
                Media Template with Buttons:
                  summary: Media Template with Buttons
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: media_template_with_buttons
                    language: en
                    status: APPROVED
                    category: ACCOUNT_UPDATE
                    structure:
                      header:
                        format: IMAGE
                      body: example {{1}} body
                      footer: exampleFooter
                      buttons:
                      - text: Dial 911
                        type: PHONE_NUMBER
                        phoneNumber: '911'
                      - text: Visit our website
                        type: URL
                        url: https://www.infobip.com
                      type: MEDIA
                Text template:
                  summary: Text template
                  value:
                    id: '111'
                    businessAccountId: 222
                    name: text_template
                    language: en
                    status: APPROVED
                    category: ACCOUNT_UPDATE
                    structure:
                      body: example {{1}} body
                      type: TEXT
        '400':
          description: Template has invalid category, too long text or a template with a given name already exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 200
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/templates:
    get:
      tags:
      - channels
      summary: Get account WhatsApp templates
      description: Retrieve all templates associated with your account based on the provided filter criteria.
      externalDocs:
        description: Learn more about the WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-account-whatsapp-templates
      parameters:
      - name: sender
        in: query
        description: List of registered WhatsApp senders numbers separated by comma. Must be in international format.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
          uniqueItems: true
        example: '447796344125'
      - name: status
        in: query
        description: List of template statuses, separated by commas.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - APPROVED
            - IN_APPEAL
            - PENDING
            - REJECTED
            - PENDING_DELETION
            - DELETED
            - REINSTATED
            - FLAGGED
            - FIRST_PAUSED
            - SECOND_PAUSED
            - DISABLED
          uniqueItems: true
      - name: name
        in: query
        description: Template name.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: language
        in: query
        description: List of languages for the templates, separated by commas.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - af
            - sq
            - ar
            - ar_EG
            - ar_AE
            - ar_LB
            - ar_MA
            - ar_QA
            - az
            - bn
            - bn_IN
            - bg
            - ca
            - zh_CN
            - zh_HK
            - zh_TW
            - hr
            - cs
            - da
            - nl
            - nl_BE
            - en
            - en_GB
            - en_US
            - en_AE
            - en_AU
            - en_CA
            - en_GH
            - en_IE
            - en_IN
            - en_JM
            - en_MY
            - en_NZ
            - en_QA
            - en_SG
            - en_UG
            - en_ZA
            - et
            - fil
            - fi
            - fr
            - fr_BE
            - fr_CA
            - fr_CH
            - fr_CI
            - fr_MA
            - ka
            - de
            - de_AT
            - de_CH
            - el
            - gu
            - ha
            - he
            - hi
            - hu
            - id
            - ga
            - it
            - ja
            - kn
            - kk
            - rw_RW
            - ko
            - ky_KG
            - lo
            - lv
            - lt
            - mk
            - ms
            - ml
            - mr
            - nb
            - fa
            - pl
            - pt_BR
            - pt_PT
            - pa
            - ro
            - ru
            - sr
            - si_LK
            - sk
            - sl
            - es
            - es_AR
            - es_CL
            - es_CO
            - es_CR
            - es_DO
            - es_EC
            - es_HN
            - es_MX
            - es_PA
            - es_PE
            - es_ES
            - es_UY
            - sw
            - sv
            - ta
            - te
            - th
            - tr
            - uk
            - ur
            - uz
            - vi
            - zu
            - unknown
          uniqueItems: true
        example: en,en_US
      - name: category
        in: query
        description: List of template categories, separated by commas.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - MARKETING
            - AUTHENTICATION
            - UTILITY
          uniqueItems: true
      - name: applicationId
        in: query
        description: Application ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        description: Entity ID used in outbound send requests. It is also returned in notification events. For more details, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Current page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: Number of items per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
      - name: orderBy
        in: query
        description: 'Sorting criteria in the format property,direction. Can be ascending (ASC) or descending (DESC). Available properties: category, language, name, status, templateId'
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: templateId,ASC
        example: name,ASC
      responses:
        '200':
          description: List of all filtered templates
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatesApiResponsePaginated'
              examples:
                Filtered single template:
                  summary: Filtered single template
                  value:
                    results:
                    - id: '111'
                      businessAccountId: 222
                      name: media_template
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        header:
                          format: IMAGE
                        body:
                          text: example {{1}} body
                        footer:
                          text: exampleFooter
                        type: MEDIA
                      quality: HIGH
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    paging:
                      page: 0
                      size: 99
                      totalPages: 1
                      totalResults: 1
                Filtered templates with pagination:
                  summary: Filtered templates with pagination
                  value:
                    results:
                    - id: '111'
                      businessAccountId: 222
                      name: text_template
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        body:
                          text: example {{1}} body
                        type: TEXT
                      quality: UNKNOWN
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    - id: '111'
                      businessAccountId: 222
                      name: media_template
                      language: en
                      status: APPROVED
                      category: MARKETING
                      structure:
                        header:
                          format: IMAGE
                        body:
                          text: example {{1}} body
                        footer:
                          text: exampleFooter
                        type: MEDIA
                      quality: HIGH
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      createdAt: 2024-01-01T00:00:00.000+0000
                      lastUpdatedAt: 2024-01-01T00:00:00.000+0000
                    paging:
                      page: 0
                      size: 2
                      totalPages: 5
                      totalResults: 10
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Provided status is invalid:
                  summary: Provided status is invalid
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: status
                      violation: Provide one of the valid values.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/flows:
    get:
      tags:
      - channels
      summary: Get WhatsApp Flows
      description: Get all the flows for a given sender.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-flows
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      responses:
        '200':
          description: List of all flows for a given sender
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetSenderFlowsResponse'
              examples:
                List of all flows for given sender:
                  summary: List of all flows for given sender
                  value:
                    flows:
                    - id: '123456'
                      name: My flow
                      businessAccountId: 987654
                      categories:
                      - SURVEY
                      status: DRAFT
                    - id: '1234567'
                      name: My second flow
                      businessAccountId: 987654
                      categories:
                      - SIGN_IN
                      status: PUBLISHED
                      initialScreens:
                      - form_feedback_one
                      - form_feedback_two
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1000
        numberOfTimeUnits: 0
        timeUnit: h
    post:
      tags:
      - channels
      summary: Create WhatsApp Flow
      description: Create a WhatsApp flow. If successful, flow will be created in DRAFT status with default flow.json. Flow.json contains structure of the flow and other fields given in request can be updated until publication.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: create-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.CreateFlowRequest'
            examples:
              Simple create flow request:
                summary: Simple create flow request
                value:
                  name: My flow
                  categories:
                  - SURVEY
              Cloning create flow request:
                summary: Cloning create flow request
                value:
                  name: My flow
                  categories:
                  - SIGN_IN
                  cloneFlowId: '912079080628183'
        required: true
      responses:
        '201':
          description: Flow Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse'
              examples:
                Flow created:
                  summary: Flow created
                  value:
                    id: '123456'
                    name: My flow
                    businessAccountId: 987654
                    categories:
                    - SURVEY
                    status: DRAFT
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow name not unique:
                  summary: Flow name not unique
                  value:
                    errorCode: E400
                    description: Flow creation failed due to validation errors.
                    action: Please use different flow name.
                    violations:
                    - property: name
                      violation: Flow with given name already exists.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/{flowId}:
    delete:
      tags:
      - channels
      summary: Delete WhatsApp Flow
      description: Delete a WhatsApp flow. Only flows in DRAFT status can be deleted.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: delete-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow to be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      responses:
        '204':
          description: Flow deleted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow is already published:
                  summary: Flow is already published
                  value:
                    errorCode: E400
                    description: Deletion attempt failed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: flowId
                      violation: Cannot delete flow which is not in DRAFT status.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
                Flow not found error:
                  summary: Flow not found error
                  value:
                    errorCode: WA-FLOW-ID404
                    description: Flow not found.
                    action: Please check the flowId and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
    patch:
      tags:
      - channels
      summary: Update WhatsApp Flow
      description: Update a WhatsApp flow. Only flows in DRAFT status can be modified.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: update-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow to be modified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.UpdateFlowRequest'
            examples:
              Update flow request:
                summary: Update flow request
                value:
                  name: My new name
                  categories:
                  - CONTACT_US
        required: true
      responses:
        '204':
          description: Flow updated
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow is in non-updatable state:
                  summary: Flow is in non-updatable state
                  value:
                    errorCode: E400
                    description: Updating attempt failed.
                    action: Please create new flow.
                    violations:
                    - property: flowId
                      violation: Flow can only be modified in DRAFT status.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/{flowId}/publish:
    post:
      tags:
      - channels
      summary: Publish WhatsApp Flow
      description: Publish a WhatsApp flow. If successful, the flow will change its status to PUBLISHED. From now on the flow cannot be modified.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: publish-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow to be published.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      responses:
        '204':
          description: Flow published
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow is not in DRAFT status:
                  summary: Flow is not in DRAFT status
                  value:
                    errorCode: E400
                    description: Publishing attempt failed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: flowId
                      violation: Cannot publish flow which is not in DRAFT status.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/{flowId}/json:
    get:
      tags:
      - channels
      summary: Get WhatsApp Flow JSON
      description: Get the Flow JSON attached to a specified flow.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-flow-json
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow the JSON is attached to.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      responses:
        '200':
          description: Attached Flow JSON
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetFlowJsonResponse'
              examples:
                Flow JSON for a specified Flow:
                  summary: Flow JSON for a specified Flow
                  value:
                    externalDownloadUrl: https://example.com
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
                Flow not found error:
                  summary: Flow not found error
                  value:
                    errorCode: WA-FLOW-ID404
                    description: Flow not found.
                    action: Please check the flowId and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1000
        numberOfTimeUnits: 0
        timeUnit: h
    put:
      tags:
      - channels
      summary: Add WhatsApp Flow JSON
      description: 'Add WhatsApp Flow JSON. File created from provided JSON content is sent and validated, errors found are provided in response. Regardless of whether any validation errors are returned, the Flow JSON is loaded on the Meta side and the request is considered successful. The maximum size of created file is 10MB. More information about JSON structure can be found under Meta documentation: https://developers.facebook.com/docs/whatsapp/flows/reference/flowjson.'
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: add-whatsapp-flow-json
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow to attach JSON to.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJson'
            examples:
              Exemplary Flow JSON body request:
                summary: Exemplary Flow JSON body request
                value:
                  version: '2.1'
                  data_api_version: '3.0'
                  routing_model:
                    MY_FIRST_SCREEN: []
                  screens:
                    id: MY_FIRST_SCREEN
                    title: MY_FIRST_SCREEN
                    terminal: true
                    data:
                      hello_world_text:
                        type: string
                        __example__: Hello World
                    layout:
                      type: SingleColumnLayout
                      children:
                      - type: TextHeading
                        text: ${data.hello_world_text}
                      - type: Footer
                        label: Static footer label
                        on-click-action:
                          name: data_exchange
                          payload: {}
        required: true
      responses:
        '201':
          description: Flow JSON Added
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonResponse'
              examples:
                Validation errors:
                  summary: Validation errors
                  value:
                    validationErrors:
                    - error: INVALID_PROPERTY
                      errorType: JSON_SCHEMA_ERROR
                      message: The property "initial-text" cannot be specified at "$root/screens/0/layout/children/2/children/0".
                      lineStart: 46
                      lineEnd: 46
                      columnStart: 17
                      columnEnd: 30
                No validation errors:
                  summary: No validation errors
                  value:
                    validationErrors: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow is in non-updatable state:
                  summary: Flow is in non-updatable state
                  value:
                    errorCode: E400
                    description: Updating attempt failed.
                    action: Please create new flow.
                    violations:
                    - property: flowId
                      violation: Flow can only be modified in DRAFT status.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/{flowId}/deprecate:
    post:
      tags:
      - channels
      summary: Deprecate WhatsApp Flow
      description: Deprecate a WhatsApp flow. If successful, flow will change its status to DEPRECATED. From now on flow cannot be sent anymore.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: deprecate-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow to be deprecated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      responses:
        '204':
          description: Flow deprecated
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Flow is already deprecated:
                  summary: Flow is already deprecated
                  value:
                    errorCode: E400
                    description: Deprecation attempt failed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: flowId
                      violation: Cannot deprecate already deprecated flow.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/{flowId}/preview:
    get:
      tags:
      - channels
      summary: Get WhatsApp Flow's preview
      description: Get flow's preview URL. Link does not require login and will expire in 30 days.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-flow-preview
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      - name: flowId
        in: path
        description: ID of the flow for which the preview URL will be generated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '123456'
      responses:
        '200':
          description: Flow's preview URL
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowPreview'
              examples:
                Flow's preview URL:
                  summary: Flow's preview URL
                  value:
                    previewUrl: https://example.com
                    expiresAt: '2024-01-01T12:00:00Z'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/flows/generate:
    post:
      tags:
      - channels
      summary: Generate WhatsApp Flow
      description: Use this endpoint to automatically generate a WhatsApp Flow definition  using AI, based on a natural language prompt. Provide a descriptive prompt (e.g., "Create a Static WhatsApp Flow to collect details like Name, Surname and email for our global event next week."). The AI will generate a flow configuration designed to match your intent. If you include a responseId from an earlier request, the prompt will be used to modify or refine the flow that was previously generated, so you can adjust and improve it step by step.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: generate-whatsapp-flow
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowRequestApiData'
        required: true
      responses:
        '200':
          description: Generated whatsapp flow
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowResponseApiData'
              examples:
                Generated flow:
                  summary: Generated flow
                  value:
                    originalPrompt: Flow that contains form with name, surname and email of the user.
                    responseId: '12346'
                    generatedFlow:
                      version: '7.0'
                      screens:
                      - id: USER_INFO_FORM
                        title: User Information
                        terminal: true
                        success: true
                        layout:
                          type: SingleColumnLayout
                          children:
                          - type: Form
                            name: user_info_form
                            children:
                            - type: TextInput
                              label: Name
                              name: name
                              required: true
                            - type: TextInput
                              label: Surname
                              name: surname
                              required: true
                            - type: TextInput
                              label: Email
                              name: email
                              input-type: email
                              required: true
                            - type: Footer
                              label: Submit
                              on-click-action:
                                name: complete
                                payload:
                                  name: ${form.name}
                                  surname: ${form.surname}
                                  email: ${form.email}
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found error:
                  summary: Sender not found error
                  value:
                    errorCode: WA-FLOW-SENDER404
                    description: Sender not found.
                    action: Please check the sender and try again.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: h
  /whatsapp/1/senders/{sender}/media:
    delete:
      tags:
      - channels
      summary: Delete media
      description: Delete WhatsApp media. May be outbound or inbound media.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: delete-whatsapp-media
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.UrlDeletionRequest'
        required: true
      responses:
        '204':
          description: Media successfully deleted
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Media not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 30
        numberOfTimeUnits: 0
        timeUnit: m
  /whatsapp/1/senders/quality:
    get:
      tags:
      - channels
      summary: Get quality information of WhatsApp senders
      description: Get WhatsApp sender information, such as quality rating, status, and current limit of given senders. Only senders associated with your account are included in the response.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-senders-quality
      parameters:
      - name: senders
        in: query
        description: List of comma-separated WhatsApp sender numbers.
        required: true
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: string
            description: WhatsApp sender.
          maxItems: 100
          minItems: 1
        example: 447796344125,447796344126
      responses:
        '200':
          description: List of WhatsApp senders quality.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityResponse'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    results:
                    - sender: '441134960000'
                      qualityRating: MEDIUM
                      status: CONNECTED
                      currentLimit: LIMIT_100K
                      lastUpdated: '2022-02-18T08:12:26.422Z'
                    - sender: '441134960001'
                      qualityRating: LOW
                      status: BANNED
                      currentLimit: UNLIMITED
                      lastUpdated: '2022-02-18T08:12:26.420Z'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/01b456ee89723218fe6e9044f9e602d2dda7aa7bf5bc0607681dd5bae7f811b9.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/business-info:
    get:
      tags:
      - channels
      summary: Get business info of WhatsApp sender
      description: Get WhatsApp sender business information, such as about, address, description, email, vertical, websites, and display name.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-sender-business-info
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      responses:
        '200':
          description: WhatsApp sender business info.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoResponse'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    about: Infobip Business Account
                    address: 35-38 New Bridge Street, London EC4V 6BW
                    description: Infobip is a global cloud communications platform.
                    email: info@example.com
                    vertical: PROFESSIONAL_SERVICES
                    websites:
                    - https://www.infobip.com
                    displayName: Infobip
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Update business info of WhatsApp sender
      description: Update WhatsApp sender business information, such as about, address, description, email, vertical, websites, and logo.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: update-whatsapp-sender-business-info
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoRequest'
            examples:
              Business Info update:
                summary: Business Info update
                value:
                  about: Infobip Business Account
                  address: 35-38 New Bridge Street, London EC4V 6BW
                  description: Infobip is a global cloud communications platform.
                  email: info@example.com
                  vertical: PROFESSIONAL_SERVICES
                  websites:
                  - https://www.infobip.com
                  logoUrl: https://example.com/logo
        required: true
      responses:
        '204':
          description: WhatsApp sender business info updated.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Logo is not supported:
                  summary: Logo is not supported
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: logoUrl
                      violation: image/gif is not supported logo type
                    resources: []
                Failed to download logo:
                  summary: Failed to download logo
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: logoUrl
                      violation: Failed to download file with status 404 NOT_FOUND
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/business-info/logo:
    get:
      tags:
      - channels
      summary: Download business logo of WhatsApp sender
      description: Download WhatsApp sender business logo.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-sender-business-logo
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      responses:
        '200':
          description: WhatsApp sender business logo.
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
                Logo not found:
                  summary: Logo not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/calls/{userNumber}/permissions:
    get:
      tags:
      - channels
      summary: Get calling permission
      description: Get calling permission info of WhatsApp sender for specified end user number, including status, allowed actions, and limitations.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-calling-permission
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      - name: userNumber
        in: path
        description: End user phone number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      responses:
        '200':
          description: Sender’s calling permission successfully retrieved
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppCallingPermissionResponse'
              examples:
                Calling permission successfully retrieved:
                  summary: Calling permission successfully retrieved
                  value:
                    status: TEMPORARY
                    actions:
                    - name: SEND_CALL_PERMISSION_REQUEST
                      canPerformAction: true
                      limits:
                      - timePeriod: PT24H
                        maxAllowed: 1
                        currentUsage: 0
                      - timePeriod: PT168H
                        maxAllowed: 2
                        currentUsage: 0
                    - name: START_CALL
                      canPerformAction: true
                      limits:
                      - timePeriod: PT24H
                        maxAllowed: 5
                        currentUsage: 1
                    expirationTime: '2025-10-07T10:09:08.007Z'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Not found:
                  summary: Not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/senders/{sender}/public-key:
    get:
      tags:
      - channels
      summary: Get WhatsApp sender public key
      description: "Retrieves the public key for WhatsApp encryption. The public key enables\n            end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows."
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: get-whatsapp-sender-public-key
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      responses:
        '200':
          description: Public key retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.SenderPublicKeyResponse'
              examples:
                Public key with VALID status:
                  summary: Public key with VALID status
                  value:
                    publicKey: '-----BEGIN RSA PUBLIC KEY-----

                      MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA0Z3VS5JJcds3xfn+fvhK

                      Xid8o1nH9GGphKFKKCy3j9R4h4K/1J4XJWzLtXf3oDqj6e5X9U1N+8X0CjQxGjQ0

                      -----END RSA PUBLIC KEY-----'
                    publicKeySignatureStatus: VALID
                Public key with MISMATCH status (empty key):
                  summary: Public key with MISMATCH status (empty key)
                  value:
                    publicKey: ' '
                    publicKeySignatureStatus: MISMATCH
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Upload WhatsApp sender public key
      description: "Uploads a public key for WhatsApp encryption. The public key enables\n            end-to-end encrypted data exchange with WhatsApp, such as in WhatsApp Flows.\n            Previous keys are replaced when new ones are uploaded using this endpoint."
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: upload-whatsapp-sender-public-key
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 15
          minLength: 1
          pattern: '[0-9]+'
        example: '447796344125'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.UploadKeyApiDoc'
            examples:
              Curl - Upload PEM formatted public key file:
                summary: Curl - Upload PEM formatted public key file
                description: Curl - Upload PEM formatted public key file
                value: 'curl --request POST ''https://{base_url}/whatsapp/1/senders/{sender}/public-key'' \

                  --header ''Authorization: {authorization}'' \

                  --form ''file="@public_key.pem"'''
        required: true
      responses:
        '204':
          description: Public key uploaded successfully.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/embedded-signup/registrations/business-account/{businessAccountId}/senders:
    post:
      tags:
      - channels
      summary: Add WhatsApp sender
      description: Add a WhatsApp sender to your WhatsApp Business Account and initiate the verification process. If the sender is recognized as already verified, it will be automatically submitted for registration.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: add-whatsapp-sender
      parameters:
      - name: businessAccountId
        in: path
        description: WhatsApp Business Account Id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: '12345567897878'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.PhoneNumberRequest'
        required: true
      responses:
        '202':
          description: Sender accepted for verification, if it is already verified it will be submitted for registration.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/embedded-signup/registrations/senders/{sender}/verification:
    put:
      tags:
      - channels
      summary: Retry WhatsApp sender verification
      description: Retry the WhatsApp sender verification process in the event of a non-delivered verification code.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: retry-whatsapp-sender-verification
      parameters:
      - name: sender
        in: path
        description: WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          pattern: \d+
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.OtpRequest'
        required: true
      responses:
        '202':
          description: Sender accepted for verification.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Verify WhatsApp sender
      description: Verify your WhatsApp sender and submit it for registration.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: verify-whatsapp-sender
      parameters:
      - name: sender
        in: path
        description: WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          pattern: \d+
        example: '447796344125'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.VerifyCodeRequest'
        required: true
      responses:
        '202':
          description: Sender accepted for registration.
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 15
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/{sender}/contacts/{userNumber}/identity:
    get:
      tags:
      - channels
      summary: Get identity
      description: Get end user's identity info. Feature is not enabled by default.
      externalDocs:
        description: Learn more.
        url: https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes
      operationId: get-whatsapp-identity
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: userNumber
        in: path
        description: End user's number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 441134960001
      responses:
        '200':
          description: Identity successfully retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityInfo'
              examples:
                Success response:
                  summary: Success response
                  value:
                    acknowledged: true
                    hash: eU2Fdi4EMUw=
                    createdAt: 2022-02-18T08:12:26.422+0000
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Recipient does not exist for a given sender or identity has changed.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      - whatsapp:message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Confirm identity
      description: Confirm end user's identity. Feature is not enabled by default.
      externalDocs:
        description: Learn more.
        url: https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes
      operationId: confirm-whatsapp-identity
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: userNumber
        in: path
        description: End user's number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 441134960001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityConfirmation'
            examples:
              Request:
                summary: Request
                value:
                  hash: eU2Fdi4EMUw=
        required: true
      responses:
        '204':
          description: Identity successfully confirmed.
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Identity was not found or recipient does not exist for a given sender.
        '409':
          description: Incorrect identity hash provided.
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      - whatsapp:message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete identity
      description: Delete end user's identity. Feature is not enabled by default.
      externalDocs:
        description: Learn more.
        url: https://www.infobip.com/docs/whatsapp/manage-integration/additional-functionalities#detect-identity-changes
      operationId: delete-whatsapp-identity
      parameters:
      - name: sender
        in: path
        description: Registered WhatsApp sender number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 447796344125
      - name: userNumber
        in: path
        description: End user's number. Must be in international format.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 441134960001
      responses:
        '204':
          description: Identity successfully deleted.
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:manage
      - whatsapp:message:send
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/conversions:
    post:
      tags:
      - channels
      summary: Submit conversions
      description: Submit WhatsApp conversion events. Events are indivisible, either all are submitted or none.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: submit-whatsapp-conversions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventRequest'
            examples:
              Submit Conversion Event:
                summary: Submit Conversion Event
                value:
                  sourceId: '263258390011723'
                  conversions:
                  - ctwaClickId: ARAkLkA8rmlFeiCktEJQ-QT
                    type: PURCHASE
                    details:
                      currency: USD
                      value: 100
                    conversionTime: 2024-05-14T10:11:45.057+0000
              Submit Conversion Events:
                summary: Submit Conversion Events
                value:
                  sourceId: '263258390011723'
                  conversions:
                  - ctwaClickId: ARAkLkA8rmlFeiCktEJQ-QT
                    type: PURCHASE
                    details:
                      currency: USD
                      value: 100
                    conversionTime: 2024-05-14T10:11:45.057+0000
                  - ctwaClickId: ALAkRkA0rmzFeoCktEJQ-PT
                    type: LEAD_SUBMITTED
                    details:
                      currency: USD
                      value: 200
                    conversionTime: 2024-05-14T12:11:45.057+0000
        required: true
      responses:
        '204':
          description: Conversions were submitted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Unresolved page ID:
                  summary: Unresolved page ID
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: sourceId
                      violation: Can't find appropriate `sourceId` among connected conversion sources.
                    resources: []
                Ambiguous page ID:
                  summary: Ambiguous page ID
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: sourceId
                      violation: '`sourceId` is ambiguous. Exact `sourceId` should be specified.'
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:conversions
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /whatsapp/1/conversions/waba:
    post:
      tags:
      - channels
      summary: Submit WABA conversions
      description: Submit WhatsApp conversion events using your WhatsApp Business Account (WABA) phone number as the source. Each conversion event is linked to an ad click via ctwaClickId — a unique identifier contained within the inbound WhatsApp message originating from the ad. You can optionally include conversion details such as value and currency, and a conversion timestamp (up to 7 days in the past). Events are submitted in batches of up to 1,000 and are indivisible — either all are submitted or none.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: submit-waba-whatsapp-conversions
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.WABAConversionEventRequest'
            examples:
              Submit WABA Conversion Event:
                summary: Submit WABA Conversion Event
                value:
                  conversions:
                  - conversionTime: '2024-05-14T10:11:45.057Z'
                    ctwaClickId: ARAkLkA8rmlFeiCktEJQ-QT
                    details:
                      currency: USD
                      value: 100
                    type: PURCHASE
                  sourceId: '1234567890'
              Submit WABA Conversion Events:
                summary: Submit WABA Conversion Events
                value:
                  conversions:
                  - conversionTime: '2024-05-14T10:11:45.057Z'
                    ctwaClickId: ARAkLkA8rmlFeiCktEJQ-QT
                    details:
                      currency: USD
                      value: 100
                    type: PURCHASE
                  - conversionTime: '2024-05-14T12:11:45.057Z'
                    ctwaClickId: ALAkRkA0rmzFeoCktEJQ-PT
                    details:
                      currency: USD
                      value: 200
                    type: LEAD_SUBMITTED
                  sourceId: '1234567890'
        required: true
      responses:
        '204':
          description: Conversions were submitted
        '400':
          description: Bad request or missing required fields
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                WABA phone number not found:
                  summary: WABA phone number not found
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: sourceId
                      violation: Can't find appropriate `sourceId` among registered WABA phone numbers.
                    resources: []
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: WABA not found or no dataset configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                WABA not found or no dataset configured:
                  summary: WABA not found or no dataset configured
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: sourceId
                      violation: No WABA or dataset found for the provided `sourceId`.
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - whatsapp:conversions
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/2/messages:
    post:
      tags:
      - channels
      summary: Send Viber messages
      description: Send text, image, video or file messages to a multiple recipients.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberRequest'
            examples:
              Text message with SMS failover:
                summary: Text message with SMS failover
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      type: TEXT
                    options:
                      smsFailover:
                        sender: '441134960000'
                        text: Some failover text
              Text message:
                summary: Text message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      type: TEXT
              Text with button message:
                summary: Text with button message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      button:
                        title: Button title
                        action: https://www.example.com/action
                      type: TEXT
              Text message to primary device only:
                summary: Text message to primary device only
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      type: TEXT
                    options:
                      toPrimaryDeviceOnly: true
              Text with button message to primary device only:
                summary: Text with button message to primary device only
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      button:
                        title: Button title
                        action: https://www.example.com/action
                      type: TEXT
                    options:
                      toPrimaryDeviceOnly: true
              Image message:
                summary: Image message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      mediaUrl: https://www.example.com/image.jpg
                      showImageInFullScreen: false
                      type: IMAGE
              Image with text message:
                summary: Image with text message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      mediaUrl: https://www.example.com/image.jpg
                      showImageInFullScreen: false
                      type: IMAGE
              Image with text and button message:
                summary: Image with text and button message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      mediaUrl: https://www.example.com/image.jpg
                      showImageInFullScreen: false
                      button:
                        title: Button title
                        action: https://www.example.com/action
                      type: IMAGE
              Video message:
                summary: Video message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      mediaUrl: https://www.example.com/video.mp4
                      mediaDuration: PT5S
                      thumbnailUrl: https://www.example.com/video.jpg
                      type: VIDEO
              Video with text message:
                summary: Video with text message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      mediaUrl: https://www.example.com/video.mp4
                      mediaDuration: PT5S
                      thumbnailUrl: https://www.example.com/video.jpg
                      type: VIDEO
              Video with text and action button message:
                summary: Video with text and action button message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      mediaUrl: https://www.example.com/video.mp4
                      mediaDuration: PT5S
                      thumbnailUrl: https://www.example.com/video.jpg
                      button:
                        title: button title
                        action: https://www.example.com/action
                      type: VIDEO
              File message:
                summary: File message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      fileName: file.xlsx
                      mediaUrl: https://www.example.com/file.xlsx
                      type: FILE
              List message:
                summary: List message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      options:
                      - Option 1
                      - Option 2
                      - Option 3
                      type: LIST
              Template:
                summary: Template
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      templateId: some template id
                      parameters:
                        pin: '123'
                      language: en
                      type: TEMPLATE
              Carousel message:
                summary: Carousel message
                value:
                  messages:
                  - sender: '441134960000'
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Carousel text
                      cards:
                      - text: Card 1 text
                        mediaUrl: https://www.example.com/card1.jpg
                        buttons:
                        - title: Button 1
                          action: https://www.example.com/action1
                        - title: Button 2
                          action: https://www.example.com/action2
                      - text: Card 2 text
                        mediaUrl: https://www.example.com/card2.jpg
                        buttons:
                        - title: Button 3
                          action: https://www.example.com/action3
                      type: CAROUSEL
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '441134960001'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
  /viber/1/message/text:
    post:
      tags:
      - channels
      summary: Send Viber text message(s)
      description: Send one or many text message(s) possibly to multiple recipients.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-text-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkTextMessage'
        required: true
      responses:
        '200':
          description: Messages accepted for delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkMessageInfo'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/1/message/image:
    post:
      tags:
      - channels
      summary: Send Viber image message
      description: Send an image message to a single recipient.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-image-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberImageMessage'
        required: true
      responses:
        '200':
          description: Message accepted for delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/1/message/file:
    post:
      tags:
      - channels
      summary: Send Viber file message
      description: Send a file message to a single recipient.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-file-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberFileMessage'
        required: true
      responses:
        '200':
          description: Message accepted for delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/1/message/video:
    post:
      tags:
      - channels
      summary: Send Viber video message
      description: Send a video message to a single recipient.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-video-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberVideoMessage'
        required: true
      responses:
        '200':
          description: Message accepted for delivery.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/2/reports:
    get:
      tags:
      - channels
      summary: Get Viber delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: get-outbound-viber-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports'
              examples:
                Delivery report:
                  summary: Delivery report
                  value:
                    results:
                    - bulkId: '1688025180464000013'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: '1688025180464000014'
                      to: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                      sender: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bm:message:send
      - viber-bm:manage
  /viber/2/logs:
    get:
      tags:
      - channels
      summary: Get Viber message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-viber-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogResponseLogViberOutboundContent'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bm:logs:read
      - viber-bm:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /viber/1/senders/{sender}/templates:
    get:
      tags:
      - channels
      summary: Get Viber templates
      description: Retrieve Viber templates available for specific sender.
      operationId: get-viber-templates
      parameters:
      - name: sender
        in: path
        description: Sender id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Sender id.
      - name: page
        in: query
        description: Current page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      - name: size
        in: query
        description: Number of items per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          maximum: 100
          minimum: 1
      - name: orderBy
        in: query
        description: 'Sorting criteria in the format `property,direction`. Can be ascending (ASC) or descending (DESC). Available properties: id, sender, channel, templateId, name, createdAt.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: createdAt,ASC
        example: name,ASC
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.GetViberTemplatesResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bm:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create Viber template
      description: Create a new Viber template for a given sender. Templates must be approved by Viber before they can be used for sending messages.
      operationId: create-viber-template
      parameters:
      - name: sender
        in: path
        description: Sender id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Sender id.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateRequest'
            examples:
              OTP template:
                summary: OTP template
                value:
                  category: OTP
                  body:
                  - language: en
                    template: Your verification code is {{pin}}. Valid for 10 minutes.
                  params:
                  - type: TEXT
                    name: pin
                    example: '123456'
              Transactional template:
                summary: Transactional template
                value:
                  category: TRANSACTIONAL
                  body:
                  - language: en
                    template: 'Booking confirmation #{{bookingNumber}} for {{customerName}}. Come join us!'
                  params:
                  - type: TEXT
                    name: bookingNumber
                    example: K999
                  - type: TEXT
                    name: customerName
                    example: Luke
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bm:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 25
        numberOfTimeUnits: 0
        timeUnit: s
  /viber/1/senders/{sender}/templates/{templateId}:
    get:
      tags:
      - channels
      summary: Get Viber template
      description: Retrieve details of a specific Viber template by its ID and associated sender.
      operationId: get-viber-template
      parameters:
      - name: sender
        in: path
        description: Sender id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Sender id.
      - name: templateId
        in: path
        description: Id of existing template.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Id of existing template.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bm:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - channels
      summary: Delete Viber template
      description: Delete a specific Viber template. Deleted templates can no longer be used for sending messages.
      operationId: delete-viber-template
      parameters:
      - name: sender
        in: path
        description: Sender id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Sender id.
      - name: templateId
        in: path
        description: Id of existing template.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Id of existing template.
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bm:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /viber-bot/1/messages:
    post:
      tags:
      - channels
      summary: Send a Viber Bot message
      description: Send one or more messages to multiple recipients.
      externalDocs:
        description: Learn more about Viber Bot channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: send-viber-bot-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotRequest'
            examples:
              Send a Viber Bot message:
                summary: Send a Viber Bot message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Hello!
                      type: TEXT
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Viber Bot message response:
                  summary: Viber Bot message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bot:message:send
      - viber-bot:manage
  /viber-bot/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound Viber bot message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-viber-bot-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogResponseLogViberBotOutboundContent'
              examples:
                Logs report:
                  summary: Logs report
                  value:
                    results:
                    - sender: '44113496000'
                      destination: '66855538125'
                      bulkId: '2034072219640523072'
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      sentAt: 2023-02-01T23:15:03.379+0000
                      doneAt: 2023-02-01T23:16:34.582+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Sent text
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - viber-bot:logs:read
      - viber-bot:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /viber-bot/1/reports:
    get:
      tags:
      - channels
      summary: Get Viber Bot delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Viber Bot channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: get-outbound-viber-bot-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '2034072219640523072'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      to: '66855538125'
                      sender: '44113496000'
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - viber-bot:message:send
      - viber-bot:manage
  /line/1/messages:
    post:
      tags:
      - channels
      summary: Send a LINE message
      description: Send one or more [LINE Official Notifications](https://www.infobip.com/docs/line/message-types#line-official-notifications-lon) messages to multiple recipients.
      externalDocs:
        description: Learn more about LINE channel and use cases
        url: https://www.infobip.com/docs/line
      operationId: send-line-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineRequest'
            examples:
              Send a LINE message:
                summary: Send a LINE message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      altText: Thank you for your purchase. We have successfully received your order.
                      contents:
                        header:
                          layout: HORIZONTAL
                          paddingAll: none
                          paddingTop: md
                          paddingBottom: md
                          paddingStart: lg
                          paddingEnd: lg
                          offsetTop: none
                          contents:
                          - url: https://example.com/logo
                            flex: 2
                            align: CENTER
                            gravity: CENTER
                            size: 80%
                            type: IMAGE
                          - contents:
                            - text: OFFICIAL NOTIFICATION
                              type: SPAN
                            flex: 20
                            size: 14px
                            align: CENTER
                            gravity: CENTER
                            wrap: true
                            color: '#ffffff'
                            weight: REGULAR
                            position: RELATIVE
                            type: TEXT
                          - text: powered by
                            contents:
                            - text: powered by
                              size: 10px
                              weight: REGULAR
                              style: ITALIC
                              type: SPAN
                            flex: 7
                            align: END
                            gravity: CENTER
                            wrap: true
                            color: '#ffffff'
                            offsetTop: 0.3px
                            type: TEXT
                          - text: powered by
                            contents:
                            - text: LINE
                              size: 12px
                              weight: BOLD
                              type: SPAN
                            flex: 4
                            align: CENTER
                            gravity: CENTER
                            wrap: true
                            color: '#ffffff'
                            type: TEXT
                          type: BOX
                        body:
                          layout: VERTICAL
                          paddingAll: none
                          paddingTop: xl
                          paddingBottom: lg
                          paddingStart: xxl
                          paddingEnd: xxl
                          contents:
                          - layout: VERTICAL
                            paddingTop: none
                            offsetTop: none
                            offsetBottom: none
                            contents:
                            - text: Purchase complete
                              size: lg
                              wrap: true
                              weight: BOLD
                              type: TEXT
                            type: BOX
                          - layout: HORIZONTAL
                            paddingTop: lg
                            contents:
                            - contents:
                              - text: Thank you for your purchase. We have successfully received your order.
                                type: SPAN
                              wrap: true
                              offsetTop: none
                              type: TEXT
                            type: BOX
                          type: BOX
                        footer:
                          layout: HORIZONTAL
                          borderWidth: none
                          margin: none
                          paddingTop: sm
                          paddingBottom: md
                          action:
                            label: action
                            uri: https://example.com/action
                            type: URI
                          contents:
                          - contents:
                            - text: 'Learn more about LINE Official Notification '
                              color: '#BDBDBD'
                              type: SPAN
                            - text: here
                              color: '#00b4ff'
                              decoration: UNDERLINE
                              type: SPAN
                            - text: .
                              color: '#BDBDBD'
                              type: SPAN
                            size: 10px
                            align: CENTER
                            wrap: true
                            type: TEXT
                          type: BOX
                        style:
                          header:
                            backgroundColor: '#06C755'
                          footer:
                            backgroundColor: '#EEEEEE'
                        type: BUBBLE
                      type: LINE_NOTIFICATION
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                LINE message response:
                  summary: LINE message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - line:message:send
      - line:manage
  /line/1/reports:
    get:
      tags:
      - channels
      summary: Get LON delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about LINE channel and use cases
        url: https://www.infobip.com/docs/line
      operationId: get-outbound-line-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReports'
              examples:
                Delivery report:
                  summary: Delivery report
                  value:
                    results:
                    - bulkId: '1688025180464000013'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: '1688025180464000014'
                      to: '66855538125'
                      sender: OFFICIAL-ACCOUNT-ID-123
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - line:message:send
      - line:manage
  /zalo/2/messages:
    post:
      tags:
      - channels
      summary: Send Zalo messages
      description: Send messages to multiple recipients. Only [template messages](https://www.infobip.com/docs/zalo/message-types) registered with Zalo can be sent. The API response will not contain the final delivery status, use [Delivery Reports](/docs/api/channels/zalo/zalo-logs-and-status-reports/receive-outbound-zalo-delivery-reports) instead.
      externalDocs:
        description: Learn more about Zalo channel and use cases
        url: https://www.infobip.com/docs/zalo
      operationId: send-zalo-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloRequest'
            examples:
              Template message without validity period and without SMS failover:
                summary: Template message without validity period and without SMS failover
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '41793026727'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: John Smith
                        date: 20/03/2018
                      type: TEMPLATE
              Encrypted template message without validity period and without SMS failover:
                summary: Encrypted template message without validity period and without SMS failover
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '41793026727'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: MCCCIjANB***hidden***Mvb0CAwEHHQ==
                        date: MKKCIjANB***hidden***Mvb0CAwEBBQ==
                      type: TEMPLATE
                    options:
                      encrypted: true
              Template message with validity period and without SMS failover:
                summary: Template message with validity period and without SMS failover
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '41793026727'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: John Smith
                        date: 20/03/2018
                      type: TEMPLATE
                    options:
                      validityPeriod:
                        amount: 30
                        timeUnit: MINUTES
              Encrypted template message with validity period and with SMS failover:
                summary: Encrypted template message with validity period and with SMS failover
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '41793026727'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: MCCCIjANB***hidden***Mvb0CAwEHHQ==
                        date: MKKCIjANB***hidden***Mvb0CAwEBBQ==
                      type: TEMPLATE
                    options:
                      validityPeriod:
                        amount: 30
                        timeUnit: MINUTES
                      smsFailover:
                        sender: '41793026726'
                        text: Failover message text
                        validityPeriod:
                          amount: 2
                          timeUnit: HOURS
                      encrypted: true
              UID template message with validity period and with SMS failover with destination matching:
                summary: UID template message with validity period and with SMS failover with destination matching
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: John Smith
                        date: 20/03/2018
                      type: TEMPLATE
                    options:
                      validityPeriod:
                        amount: 30
                        timeUnit: MINUTES
                      smsFailover:
                        sender: '41793026726'
                        text: Failover message text
                        validityPeriod:
                          amount: 2
                          timeUnit: HOURS
                        destinationMatching:
                        - initial: '1234567890123456789'
                          failover: '41793026727'
              Template message without validity period and without SMS failover and with sending mode:
                summary: Template message without validity period and without SMS failover and with sending mode
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '41793026727'
                    content:
                      templateName: 322307
                      templateData:
                        customer_name: John Smith
                        date: 20/03/2018
                      type: TEMPLATE
                    options:
                      sendingMode: AUTO
              Text message to user:
                summary: Text message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      text: Hello! Thank you for following our Official Account.
                      type: TEXT
              Image message to user:
                summary: Image message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      caption: Check out our latest promotion!
                      url: https://example.com/promotion.png
                      type: IMAGE
              GIF message to user:
                summary: GIF message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      caption: Enjoy this animation!
                      url: https://example.com/animation.gif
                      width: 400
                      height: 300
                      type: GIF
              Sticker message to user:
                summary: Sticker message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      id: e1540df031b5deb81a4
                      type: STICKER
              Quote consultation message to user:
                summary: Quote consultation message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      text: We are open Monday to Friday, 9am to 6pm.
                      quoteMessageId: 85f7bfaf11b4dfed86a2
                      type: QUOTE_CONSULTATION
              User information request form to user:
                summary: User information request form to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      title: Please share your contact details
                      subtitle: We'll use this to send you personalized offers
                      imageUrl: https://example.com/form-banner.png
                      type: USER_INFORMATION_REQUEST_FORM
              File message to user:
                summary: File message to user
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      url: https://example.com/invoice.pdf
                      type: FILE
              Reaction to user message:
                summary: Reaction to user message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-XY12Z3
                    destinations:
                    - to: '1234567890123456789'
                    content:
                      reactIcon: HEART
                      reactMessageId: d2e222a71207d35e8a11
                      type: REACTION
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: '41793026727'
        '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
      - zalo:message:send
      - zalo:manage
  /zalo/1/logs:
    get:
      tags:
      - channels
      summary: Get Zalo logs
      description: You should use this method for displaying logs in the user interface or for some other less frequent usage.
      operationId: get-zalo-logs
      parameters:
      - name: from
        in: query
        description: Message sender.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Message sender.
      - name: to
        in: query
        description: Message destination.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Message destination.
      - name: messageId
        in: query
        description: List of message IDs (separated by comma) for which logs are requested.
        required: false
        style: form
        explode: true
        schema:
          type: array
          description: List of message IDs (separated by comma) for which logs are requested.
          example: 1,2,3
          items:
            type: string
            description: List of message IDs (separated by comma) for which logs are requested.
            example: 1,2,3
      - name: generalStatus
        in: query
        description: Sent Message status.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.IpCoreGeneralStatus'
      - name: sentSince
        in: query
        description: 'Lower limit on date and time of sending message. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'Lower limit on date and time of sending message. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      - name: sentUntil
        in: query
        description: 'Upper limit on date and time of sending message. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'Upper limit on date and time of sending message. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      - name: limit
        in: query
        description: Maximal number of messages in returned logs. If you want to fetch more than 1000 logs you can retrieve them in pages using `sentSince` and `sentUntil` parameters.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          description: Maximal number of messages in returned logs. If you want to fetch more than 1000 logs you can retrieve them in pages using `sentSince` and `sentUntil` parameters.
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: Logs for given criteria are being fetched.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.LogsResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e2e56e613b621c92a292daf20c76b6dbff0520ca1b47769205b02fa7192a30b4.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - zalo:logs:read
      - zalo:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /zalo/1/sender/{sender}/templates:
    get:
      tags:
      - channels
      summary: Get Zalo templates
      description: Returns all templates for a given sender filtered by status.
      operationId: get-zalo-templates
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      - name: page
        in: query
        description: Results page to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      - name: size
        in: query
        description: Number of records per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          maximum: 100
          minimum: 1
      - name: status
        in: query
        description: Filter templates by status. Use ALL to return all templates regardless of status. Defaults to ENABLE.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateStatus'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageTemplate'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    results:
                    - templateName: 900025
                      displayName: Template_1
                      status: PENDING_REVIEW
                      createdTime: 2022-12-31T23:59:59.000+0000
                    - templateName: 900026
                      displayName: Template_2
                      status: ENABLE
                      createdTime: 2023-01-01T08:19:59.000+0000
                    paging:
                      page: 0
                      size: 2
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - zalo:message:send
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /zalo/1/sender/{sender}/templates/{templateName}:
    get:
      tags:
      - channels
      summary: Get Zalo template
      description: Returns template's info for given template name.
      operationId: get-zalo-template
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      - name: templateName
        in: path
        description: Name identifying the template. Must be the same as registered template_id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Name identifying the template. Must be the same as registered template_id.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateInfo'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Zalo API error:
                  summary: Zalo API error
                  value:
                    errorCode: ZALO-RSA502
                    description: Zalo API responded with an error.
                    action: Try again later. If the error persists, contact Infobip support.
                    violations: []
                    resources:
                    - name: Get Zalo quota API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-quota
                    - name: Get Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-template
                    - name: Get Zalo templates API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-templates
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - zalo:message:send
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /zalo/2/sender/{sender}/templates:
    put:
      tags:
      - channels
      summary: Edit Zalo template
      description: Edits an existing template that has REJECTED status. The template will be resubmitted for review.
      operationId: edit-zalo-template
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateRequest'
            examples:
              Edit custom template:
                summary: Edit custom template
                value:
                  note: Updated template for shipment notifications
                  templateContent:
                    buttons:
                      items:
                      - content: https://example.com/tracking
                        title: Track Shipment
                        type: GO_TO_COMPANY_PAGE
                    logo:
                      dark:
                        mediaId: dbuzvadgdaaq9jjam8
                        type: IMAGE
                      light:
                        mediaId: dbuzvadgdaaq9jjam8
                        type: IMAGE
                    tag: TRANSACTION
                    title:
                      value: Order Successfully Shipped
                    type: CUSTOM
                  templateId: 900025
              Edit payment request template:
                summary: Edit payment request template
                value:
                  note: Updated payment template
                  templateContent:
                    buttons:
                      items:
                      - content: https://example.com/invoice
                        title: View Invoice
                        type: GO_TO_COMPANY_PAGE
                    logo:
                      dark:
                        mediaId: dbuzvadgdaaq9jjam9
                        type: IMAGE
                      light:
                        mediaId: dbuzvadgdaaq9jjam9
                        type: IMAGE
                    payment:
                      accountName: John Doe
                      amount: '200000'
                      bankAccount: '1234567890'
                      bankCode: '970425'
                      note: Payment received
                    title:
                      value: Payment Confirmation
                    type: PAYMENT_REQUEST
                  templateId: 900026
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateResponse'
              examples:
                Template edited successfully:
                  summary: Template edited successfully
                  value:
                    appId: '1234567890'
                    oaId: '9876543210'
                    previewUrl: https://example.com/preview/template/900025
                    status: PENDING_REVIEW
                    tag: TRANSACTION
                    templateId: '900025'
                    templateName: Order Successfully Shipped
                    templateType: CUSTOM
                    timeout: 86400
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: ZALO-RSA404
                    description: Provided sender not found.
                    action: Please check the sender ID provided as a path parameter.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Zalo API error:
                  summary: Zalo API error
                  value:
                    errorCode: ZALO-RSA502
                    description: Zalo API responded with an error.
                    action: Try again later. If the error persists, contact Infobip support.
                    violations: []
                    resources:
                    - name: Get Zalo quota API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-quota
                    - name: Get Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-template
                    - name: Get Zalo templates API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-templates
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - zalo:message:send
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create Zalo template
      description: Creates a new template for the given sender. The template will be submitted for review and must be approved before it can be used.
      operationId: create-zalo-template
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateRequest'
            examples:
              Custom template with logo and buttons:
                summary: Custom template with logo and buttons
                value:
                  note: Template for order confirmation notifications
                  templateContent:
                    buttons:
                      items:
                      - content: https://example.com/orders
                        title: View Order
                        type: GO_TO_COMPANY_PAGE
                    logo:
                      dark:
                        mediaId: dbuzvadgdaaq9jjam7
                        type: IMAGE
                      light:
                        mediaId: dbuzvadgdaaq9jjam7
                        type: IMAGE
                    tag: TRANSACTION
                    title:
                      value: Your Order Has Been Confirmed
                    type: CUSTOM
                  templateName: Order Confirmation
                  trackingId: tracking-custom-001
              Voucher template:
                summary: Voucher template
                value:
                  note: Promotional voucher template
                  templateContent:
                    buttons:
                      items:
                      - content: https://example.com/redeem
                        title: Redeem Now
                        type: GO_TO_COMPANY_PAGE
                    logo:
                      dark:
                        mediaId: dbuzvadgdaaq9jjam7
                        type: IMAGE
                      light:
                        mediaId: dbuzvadgdaaq9jjam7
                        type: IMAGE
                    tag: PROMOTION
                    title:
                      value: Special Discount For You
                    type: VOUCHER
                    voucher:
                      condition: Valid for orders above $50
                      endDate: '2025-12-31'
                      name: 50% Off Discount
                      startDate: '2025-01-01'
                      voucherCode: SAVE50NOW
                  templateName: Discount Voucher
                  trackingId: tracking-voucher-001
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateResponse'
              examples:
                Template created successfully:
                  summary: Template created successfully
                  value:
                    appId: '1234567890'
                    oaId: '9876543210'
                    previewUrl: https://example.com/preview/template/900027
                    status: PENDING_REVIEW
                    tag: TRANSACTION
                    templateId: '900027'
                    templateName: Order Confirmation
                    templateType: CUSTOM
                    timeout: 86400
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: ZALO-RSA404
                    description: Provided sender not found.
                    action: Please check the sender ID provided as a path parameter.
                    violations: []
                    resources: []
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Template already exists:
                  summary: Template already exists
                  value:
                    errorCode: ZALO-TMP409
                    description: Template with the same name already exists.
                    action: Please use a different template name.
                    violations: []
                    resources:
                    - name: Create Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/create-zalo-template
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Zalo API error:
                  summary: Zalo API error
                  value:
                    errorCode: ZALO-RSA502
                    description: Zalo API responded with an error.
                    action: Try again later. If the error persists, contact Infobip support.
                    violations: []
                    resources:
                    - name: Get Zalo quota API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-quota
                    - name: Get Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-template
                    - name: Get Zalo templates API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-templates
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - zalo:message:send
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /zalo/1/sender/{sender}/media:
    post:
      tags:
      - channels
      summary: Upload Zalo media
      description: Uploads an image file to Zalo and returns the media ID that can be referenced in template content.
      operationId: upload-zalo-media
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                file:
                  type: string
                  format: binary
                  description: Image file to upload.
              required:
              - file
      responses:
        '201':
          description: Media uploaded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MediaUploadResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    mediaId: dbuzvadgdaaq9jjam7
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: ZALO-RSA404
                    description: Provided sender not found.
                    action: Please check the sender ID provided as a path parameter.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Zalo API error:
                  summary: Zalo API error
                  value:
                    errorCode: ZALO-RSA502
                    description: Zalo API responded with an error.
                    action: Try again later. If the error persists, contact Infobip support.
                    violations: []
                    resources:
                    - name: Get Zalo quota API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-quota
                    - name: Get Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-template
                    - name: Get Zalo templates API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-templates
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /zalo/1/sender/{sender}/quota:
    get:
      tags:
      - channels
      summary: Get Zalo quota
      description: Returns the quota (number) of Zalo notifications sent per day.
      operationId: get-zalo-quota
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.QuotaInfo'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
        '502':
          description: Bad Gateway
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Zalo API error:
                  summary: Zalo API error
                  value:
                    errorCode: ZALO-RSA502
                    description: Zalo API responded with an error.
                    action: Try again later. If the error persists, contact Infobip support.
                    violations: []
                    resources:
                    - name: Get Zalo quota API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-quota
                    - name: Get Zalo template API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-template
                    - name: Get Zalo templates API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-templates
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - zalo:message:send
      - zalo:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /zalo/1/sender/{sender}/public-key:
    get:
      tags:
      - channels
      summary: Get Zalo sender public key
      description: Returns previously generated public RSA key. In case you haven't already generated an RSA key, you need to do that using the "Create Zalo sender public key" method. To use the public RSA key, please *Base64 decode* the provided value!
      operationId: get-zalo-public-key
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PublicKeyResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: ZALO-RSA404
                    description: Provided sender not found.
                    action: Please check the sender ID provided as a path parameter.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - zalo:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create Zalo sender public key
      description: The RSA key generation API allows you to generate a key pair consisting of a public key and a private key.<br />Only the public key will be returned by this method. The private key will be stored by Zalo to decrypt the content.<br />In case you've already generated an RSA key, please use the public key get API to get the public key.<br />To use the public RSA key, please *Base64 decode* the provided value!
      operationId: create-zalo-public-key
      parameters:
      - name: sender
        in: path
        description: Sender ID.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
          description: Sender ID.
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PublicKeyResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Sender not found:
                  summary: Sender not found
                  value:
                    errorCode: ZALO-RSA404
                    description: Provided sender not found.
                    action: Please check the sender ID provided as a path parameter.
                    violations: []
                    resources: []
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                RSA key already exists:
                  summary: RSA key already exists
                  value:
                    errorCode: ZALO-RSA409
                    description: RSA key already exists.
                    action: Use the "Get existing RSA key" endpoint to fetch the existing key.
                    violations: []
                    resources:
                    - name: Create a new RSA key API endpoint documentation
                      url: https://www.infobip.com/docs/api/create-zalo-public-key
                    - name: Get existing RSA key API endpoint documentation
                      url: https://www.infobip.com/docs/api/get-zalo-public-key
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - zalo:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/2/message/single:
    post:
      tags:
      - channels
      summary: Send single Push notification
      description: Use this method to send a single Push notification to one or multiple recipients.
      operationId: send-single-push-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequest'
            examples:
              Push Request:
                summary: Push Request
                value:
                  from: d417d38814740a23f50b5c876e226445-0f700564-abbf-4b5b-beae-86a4ef410904
                  to:
                    externalUserId: customer_21234
                  text: This Message was sent by targeting exact externalUserId.
                  validityPeriod: 30
                  validityPeriodTimeUnit: MINUTES
                  customPayload:
                    someData: someData
                    targetUrl: www.someDomain.com
                  notificationOptions:
                    soundEnabled: false
                    badge: 1
                    contentUrl: https://www.example.com/images/image1.jpg
                    category: mm_accept_decline
                    showInApp: true
                    inAppExpirationPeriod: 6
                    inAppExpirationTimeUnit: MINUTES
                    inAppDismissTitle: Close
                    inAppOpenTitle: Show
                    primaryButtonAction:
                      resource: http://someurl.com
                      type: WEB_VIEW_URL
                    inboxTopic: Promotion
                  notifyUrl: https://example.com
                  notifyContentType: application/json
                  callbackData: DLR callback data
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushResponse'
              examples:
                Send push notification response:
                  summary: Send push notification response
                  value:
                    bulks:
                    - to:
                        externalUserId: customer_21234
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery
                      messageCount: 1
                      bulkId: oungulj9xm9b3hixkupu
                    - to:
                        externalUserId: customer_113456
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery
                      messageCount: 1
                      bulkId: gby7cz3x6m244n2e4vzb
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/676955110d1a0dfd70a111f0d54754844fb76cec84585649da79c94c1af5f6bc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mobile-app-messaging:send
      - mobile-app-messaging:manage
  /push/2/message/multi:
    post:
      tags:
      - channels
      summary: Send multiple Push notifications
      description: Use this method when sending a large amount of messages or targeting different user segments with different messages to optimize data traffic and increase performance.
      operationId: send-multiple-push-notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestMulti'
            examples:
              Multiple push request:
                summary: Multiple push request
                value:
                  messages:
                  - from: d417d38814740a23f50b5c876e226445-0f700564-abbf-4b5b-beae-86a4ef410904
                    to:
                      externalUserId: customer_21234
                    text: This message can be one of many in this message collection.
                    validityPeriod: 30
                    validityPeriodTimeUnit: MINUTES
                    customPayload:
                      someData: someData
                      targetUrl: www.someDomain.com
                    notificationOptions:
                      soundEnabled: false
                      badge: 1
                    notifyUrl: https://example.com
                    notifyContentType: application/json
                    callbackData: DLR callback data
                  - from: c297d38814740a23f50b5c876e226445-0f700564-abbf-4b5b-beae-86a4ef410904
                    to:
                      externalUserId: customer_113456
                    text: This is the second message in this collection.
                    notificationOptions:
                      soundName: notification_sound.wav
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushResponse'
              examples:
                Send push notification response:
                  summary: Send push notification response
                  value:
                    bulks:
                    - to:
                        externalUserId: customer_21234
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery
                      messageCount: 1
                      bulkId: oungulj9xm9b3hixkupu
                    - to:
                        externalUserId: customer_113456
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message accepted, pending for delivery
                      messageCount: 1
                      bulkId: gby7cz3x6m244n2e4vzb
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/676955110d1a0dfd70a111f0d54754844fb76cec84585649da79c94c1af5f6bc.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mobile-app-messaging:send
      - mobile-app-messaging:manage
  /push/3/messages:
    post:
      tags:
      - channels
      summary: Send Push notifications
      description: This method allows you to send Push notifications to a recipient or multiple recipients in one request.
      externalDocs:
        description: Learn more about Mobile Push and In-App Messages
        url: https://www.infobip.com/docs/mobile-push
      operationId: send-push-notifications
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationRequest'
            examples:
              External user id as destination:
                summary: External user id as destination
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - externalUserId: external-user-id
                      type: EXTERNAL_USER_ID
                    content:
                      title: Some title
                      text: Some text
                      type: TEXT
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
              Email as destination:
                summary: Email as destination
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - email: johnsmith@example.com
                      type: EMAIL
                    content:
                      title: Some title
                      text: Some text
                      type: TEXT
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
              Phone number as destination:
                summary: Phone number as destination
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - phoneNumber: '441134960001'
                      type: PHONE_NUMBER
                    content:
                      title: Some title
                      text: Some text
                      type: TEXT
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
              Registration as destination:
                summary: Registration as destination
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - pushRegistrationId: DBE0B0B6-668E-491E-8EE8-2A3DB2C71CBE
                      type: REGISTRATION
                    content:
                      title: Some title
                      text: Some text
                      type: TEXT
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
              Multiple destinations:
                summary: Multiple destinations
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - $or:
                      - DeviceType: personal
                      - DeviceType: business
                      $and:
                      - DeviceType: personal
                      - DeviceType: business
                      type: MULTIPLE
                    content:
                      title: Some title
                      text: Some text
                      type: TEXT
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
              Image push notification:
                summary: Image push notification
                value:
                  messages:
                  - sender: F5E6B95AFBEDEC426344318E1BD3D42E
                    destinations:
                    - pushRegistrationId: DBE0B0B6-668E-491E-8EE8-2A3DB2C71CBE
                      type: REGISTRATION
                    content:
                      title: Some title
                      text: Some text
                      url: https://www.example.com/image.jpg
                      type: IMAGE
                    options:
                      soundEnabled: true
                      soundName: default
                      vibrationEnabled: true
                      contentAvailable: true
                      isSilent: false
                      badge: 1
                      category: mm_accept_decline
                      showMirroredPush: false
                      mirroredPushStyle: MODAL
                      mirroredPushExpirationPeriod: 1
                      mirroredPushExpirationTimeUnit: HOURS
                      mirroredPushDismissTitle: Dismiss Title
                      mirroredPushOpenTitle: Open Title
                      onTapButtonAction:
                        resource: resource
                        type: WEB_VIEW_URL
                      inboxTopic: Inbox Topic
                      sendAt: 2026-07-23T12:55:35.086+0000
                      customPayload:
                        custom: payload
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationResponse'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: DBE0B0B6-668E-491E-8EE8-2A3DB2C71CBE
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mobile-app-messaging:send
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /push/1/applications:
    get:
      tags:
      - channels
      summary: Get push applications
      description: The following method allows you to fetch all application profiles configured on a single account.
      operationId: get-push-applications
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    applications:
                    - applicationCode: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                      applicationId: 192CCB67425B90FE8A419EB0F350F0589
                      name: Push Test 1
                      description: PUSH test application 1
                      registrationsCount: 45655
                      apns:
                        enabled: true
                      gcm:
                        enabled: false
                    - applicationCode: 26581d19d889e4867b997e386ea0e222-b8325bdd-3d56-76e1-d104-6a5c48234bc8
                      applicationId: AEB30AF8A61ADEB4D9964A299E8FFC10
                      name: Push Test 2
                      description: PUSH test application 2
                      registrationsCount: 35698
                      apns:
                        enabled: true
                      gcm:
                        enabled: true
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
  /push/1/applications/{applicationCode}:
    get:
      tags:
      - channels
      summary: Get push Application by applicationCode
      description: The following method allows you to fetch information about a specific application profile.
      operationId: get-push-application
      parameters:
      - name: applicationCode
        in: path
        description: Application code.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: useAppCodeAsAppId
        in: query
        description: Set to true to treat application code as application ID.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    applicationCode: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                    applicationId: 192CCB67425B90FE8A419EB0F350F0589
                    name: Push Test 1
                    description: PUSH test application 1
                    registrationsCount: 456655
                    apns:
                      enabled: false
                    gcm:
                      enabled: true
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
  /push/1/statistics:
    get:
      tags:
      - channels
      summary: Get Push statistics
      description: The following method allows you to retrieve statistics for a specific bulk of sent Push messages.
      operationId: get-push-statistics
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/a381f86553e288851808282b347a5f8bd7ba34b9b6feb33f5946feb4892476be.StatisticsResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    totalSent: 31569
                    delivered: 29568
                    seen: 25632
                    errors:
                      registration: 1654
                      expired: 301
                      cloud: 46
                    delivery:
                      rate: 93.66
                      time: 1580727771155
        '400':
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/77db2635bc301813b34d9bf25b46b5eb0b93ccf4142ac82fa2d80980d0455beb.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
  /push/1/reports:
    get:
      tags:
      - channels
      summary: Get Push reports
      description: This method allows you to get one-time delivery reports for sent Push messages. You can only fetch reports that are no older than 48 hours.
      operationId: get-push-reports
      parameters:
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 23568941
      - name: messageId
        in: query
        description: The ID of the individual message for which the report is requested.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: ff4804ef-6ab6-4abd-984d-ab3b1387e852
      - name: limit
        in: query
        description: Maximum number of reports.
        required: false
        style: form
        explode: true
        schema:
          type: integer
        example: 1
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReportsResponse'
              examples:
                Push sent messages response:
                  summary: Push sent messages response
                  value:
                    results:
                    - bulkId: '23568941'
                      messageId: ff4804ef-6ab6-4abd-984d-ab3b1387e852
                      to: '385981178'
                      sentAt: 1970-01-01T00:00:00.000+0000
                      doneAt: 1970-01-01T00:00:01.000+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: PUSH
                Getting detailed reports for bulk message sending:
                  summary: Getting detailed reports for bulk message sending
                  value:
                    results:
                    - bulkId: '3382845430'
                      messageId: 07e03aae-fabc-44ad-b1ce-222e14094d70
                      to: '41793026727'
                      sentAt: 1970-01-01T00:00:00.000+0000
                      doneAt: 1970-01-01T00:00:01.000+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.0104
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: PUSH
                    - bulkId: '3382845430'
                      messageId: 1f21d8d7-f306-4f53-9f6e-eddfce9849ea
                      to: '41793026728'
                      sentAt: 1970-01-01T00:00:00.000+0000
                      doneAt: 1970-01-01T00:00:01.000+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: PUSH
                Getting delivery reports:
                  summary: Getting delivery reports
                  value:
                    results:
                    - bulkId: czztgteet4fath2pclbq
                      messageId: 45653761-3a88-4060-869e-ae372adc7a51
                      to: 3fd5c8a4-ae57-46c1-be7a-31bb8a0a7fba
                      sentAt: 1970-01-01T00:00:00.000+0000
                      doneAt: 1970-01-01T00:00:01.000+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0
                        currency: UNKNOWN
                      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
                      channel: PUSH
                      callbackData: '{"callbackData":"Delivery report callback data","subscriberId":"customer_21234"}'
        '400':
          description: Error reponses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/77db2635bc301813b34d9bf25b46b5eb0b93ccf4142ac82fa2d80980d0455beb.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - mobile-app-messaging:send
      - mobile-app-messaging:manage
  /push/1/inbox/reports:
    get:
      tags:
      - channels
      summary: Receive MO Push messages
      description: Get MO (Mobile Originated) Push messages that have been received by the Infobip platform from your subscribers' devices. These are incoming messages sent from devices to your application, not messages sent from the platform to devices. Each request will return a batch of received messages - only once. The following request will return the next batch of messages.
      operationId: receive-push-messages
      parameters:
      - name: limit
        in: query
        description: Maximum number of received messages to return.
        required: false
        style: form
        explode: true
        schema:
          type: integer
        example: 2
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportsResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      - inbound-message:read
      - mobile-app-messaging:inbound-message:read
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/3/reports:
    get:
      tags:
      - channels
      summary: Get Push delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Mobile Push and In-App Messages
        url: https://www.infobip.com/docs/mobile-push
      operationId: get-outbound-push-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReports'
        '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
      - mobile-app-messaging:send
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2500
        numberOfTimeUnits: 0
        timeUnit: s
  /push/3/logs:
    get:
      tags:
      - channels
      summary: Get Push message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-push-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogResponseLogPushOutboundContent'
        '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:
      - mobile-app-messaging:manage
      - mobile-app-messaging:logs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /push/1/applications/{applicationCode}/configurations:
    get:
      tags:
      - channels
      summary: List all configurations
      description: List all MO (Mobile Originated) message configurations for an application.
      operationId: list-all-configurations
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationsResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create a new configuration
      description: Create a new MO (Mobile Originated) message configuration for an application.
      operationId: create-a-new-configuration
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/1/applications/{applicationCode}/configurations/{configurationKey}:
    get:
      tags:
      - channels
      summary: Get a single configuration
      description: Get a single MO (Mobile Originated) message configuration by key.
      operationId: get-a-single-configuration
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      - name: configurationKey
        in: path
        description: Configuration key identifying the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: config_key
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
                Configuration not found:
                  summary: Configuration not found
                  description: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '6'
                        text: Configuration does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete the configuration
      description: Delete an MO (Mobile Originated) message configuration by key.
      operationId: delete-the-configuration
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      - name: configurationKey
        in: path
        description: Configuration key identifying the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: config_key
      responses:
        '204':
          description: Successful response (no content)
          content: {}
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
                Configuration not found:
                  summary: Configuration not found
                  description: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '6'
                        text: Configuration does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/1/applications/{applicationCode}/configurations/{configurationKey}/actions:
    get:
      tags:
      - channels
      summary: List all actions
      description: List all actions for an MO (Mobile Originated) message configuration.
      operationId: list-all-actions
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      - name: configurationKey
        in: path
        description: Configuration key identifying the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: config_key
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionsResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
                Configuration not found:
                  summary: Configuration not found
                  description: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '6'
                        text: Configuration does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create new action
      description: Create a new action for an MO (Mobile Originated) message configuration. Supported action types are HTTP_FORWARD and PULL.
      operationId: create-new-action
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      - name: configurationKey
        in: path
        description: Configuration key identifying the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: config_key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionRequest'
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Invalid action request:
                  summary: Invalid action request
                  description: Invalid action request
                  value:
                    requestError:
                      serviceException:
                        messageId: '8'
                        text: Invalid action request
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
                Configuration not found:
                  summary: Configuration not found
                  description: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '6'
                        text: Configuration does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/1/applications/{applicationCode}/configurations/{configurationKey}/actions/{actionKey}:
    delete:
      tags:
      - channels
      summary: Delete action
      description: Delete an action from an MO (Mobile Originated) message configuration.
      operationId: delete-action
      parameters:
      - name: applicationCode
        in: path
        description: Application code identifying the application.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: my_app_code
      - name: configurationKey
        in: path
        description: Configuration key identifying the configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: config_key
      - name: actionKey
        in: path
        description: Action key identifying the action to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: action_key
      responses:
        '204':
          description: Successful response (no content)
          content: {}
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException'
              examples:
                Application not found:
                  summary: Application not found
                  description: Application not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '1'
                        text: Application does not exist
                Configuration not found:
                  summary: Configuration not found
                  description: Configuration not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '6'
                        text: Configuration does not exist
                Action not found:
                  summary: Action not found
                  description: Action not found
                  value:
                    requestError:
                      serviceException:
                        messageId: '5'
                        text: Action does not exist
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /push/1/inbox/messages:
    delete:
      tags:
      - channels
      summary: Delete Push Inbox messages
      description: Deletes Push Inbox messages from devices that have a mobile application integrated with the 'Push Inbox'. Beware, this action cannot be undone.
      operationId: delete-push-inbox-messages
      parameters:
      - name: campaignId
        in: query
        description: '`campaignId` of messages that you''d like to delete.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 100004815162342
      - name: bulkId
        in: query
        description: '`bulkId` of messages that you''d like to delete.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: fe40d1aa-b4ec-11ec-b909-0242ac120002
      - name: messageId
        in: query
        description: '`messageId` of the specific message you''d like to delete.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 1738833000000
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1fab3d191d736425211a5879d4b2241fa0e80b8ab68239ab74531b9b6408a7a8.DeletionAcceptedResponse'
              examples:
                Success.:
                  summary: Success.
                  description: Success.
                  value:
                    messageId: '1738833000000'
                    message: Your request has been submitted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a371cd8f3283b37bf4803906b01cdcf51f31ded659ebcfe44c8dbb3c4785a4e.ApiException'
              examples:
                Missing required request parameter.:
                  summary: Missing required request parameter.
                  description: Missing required request parameter.
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: 'Missing required request parameter: campaignId, bulkId or messageId. Please provide one of them.'
                Ambiguous request parameters.:
                  summary: Ambiguous request parameters.
                  description: Ambiguous request parameters.
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: 'Ambiguous request parameters: more than one of campaignId, bulkId, or messageId are specified. Please provide only one of them.'
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2
        numberOfTimeUnits: 0
        timeUnit: m
  /push/1/user/{externalUserId}/inbox/messages:
    delete:
      tags:
      - channels
      summary: Delete Push Inbox message for a specific user
      description: Deletes a single Push Inbox message from a specific user's inbox. Requires specifying either campaignId or bulkId.
      operationId: delete-push-inbox-user-message
      parameters:
      - name: externalUserId
        in: path
        description: External identifier of the user
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: campaignId
        in: query
        description: '`campaignId` of message to delete'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: '`bulkId` of message to delete'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: '`messageId` of the specific message to delete'
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1fab3d191d736425211a5879d4b2241fa0e80b8ab68239ab74531b9b6408a7a8.DeletionAcceptedResponse'
              examples:
                Success with campaignId:
                  summary: Success with campaignId
                  description: Success with campaignId
                  value:
                    campaignId: '100004815162342'
                    message: Your request has been submitted successfully.
                Success with bulkId:
                  summary: Success with bulkId
                  description: Success with bulkId
                  value:
                    bulkId: fe40d1aa-b4ec-11ec-b909-0242ac120002
                    message: Your request has been submitted successfully.
                Success with messageId:
                  summary: Success with messageId
                  description: Success with messageId
                  value:
                    messageId: '1738833000000'
                    message: Your request has been submitted successfully.
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1a371cd8f3283b37bf4803906b01cdcf51f31ded659ebcfe44c8dbb3c4785a4e.ApiException'
              examples:
                Missing required parameter:
                  summary: Missing required parameter
                  description: Missing required parameter
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: 'Missing required request parameter: campaignId, bulkId or messageId. Please provide one of them.'
                Ambiguous parameters:
                  summary: Ambiguous parameters
                  description: Ambiguous parameters
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: 'Ambiguous request parameters: more than one of campaignId, bulkId, or messageId are specified. Please provide only one of them.'
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - mobile-app-messaging:manage
  /rcs/2/messages:
    post:
      tags:
      - channels
      summary: Send RCS messages
      description: Send RCS messages or RCS template messages to multiple recipients. Maximum request size is 10MB. Including some fields will affect [billing type](https://www.infobip.com/docs/rcs/billing-types).
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: send-rcs-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequest'
            examples:
              Basic text message:
                summary: Basic text message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      type: TEXT
              Single text message:
                summary: Single text message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: TEXT
              Text message with SMS failover:
                summary: Text message with SMS failover
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: TEXT
                    options:
                      platform:
                        entityId: Example entity id
                        applicationId: Example application id
                      validityPeriod:
                        amount: 1
                        timeUnit: HOURS
                      deliveryTimeWindow:
                        days:
                        - MONDAY
                        - TUESDAY
                        from:
                          hour: 9
                          minute: 0
                        to:
                          hour: 17
                          minute: 0
                      campaignReferenceId: Example campaign id
                      smsFailover:
                        sender: DemoSender
                        text: Some failover text
                        validityPeriod:
                          amount: 1
                          timeUnit: HOURS
              Text message with MMS failover:
                summary: Text message with MMS failover
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: TEXT
                    options:
                      platform:
                        entityId: Example entity id
                        applicationId: Example application id
                      validityPeriod:
                        amount: 1
                        timeUnit: HOURS
                      deliveryTimeWindow:
                        days:
                        - MONDAY
                        - TUESDAY
                        from:
                          hour: 9
                          minute: 0
                        to:
                          hour: 17
                          minute: 0
                      campaignReferenceId: Example campaign id
                      mmsFailover:
                        sender: DemoSender
                        validityPeriod:
                          amount: 1
                          timeUnit: HOURS
                        content:
                          title: Example failover title
                          messageSegments:
                          - text: Example failover text
                            type: TEXT
              File message:
                summary: File message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      file:
                        url: https://www.example.com/video.mp4
                      thumbnail:
                        url: https://www.example.com/thumbnail.jpg
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: FILE
              Card message:
                summary: Card message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: Some title
                        description: Some description
                        media:
                          file:
                            url: https://www.example.com/video.mp4
                          thumbnail:
                            url: https://www.example.com/thumbnail.jpg
                          height: TALL
                        suggestions:
                        - text: Example text
                          postbackData: Example postback data
                          url: https://www.example.com/
                          application: BROWSER
                          type: OPEN_URL
                        - text: Example text
                          postbackData: Example postback data
                          type: REPLY
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: CARD
              Card message with URL tracking:
                summary: Card message with URL tracking
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: Some title
                        description: Some description
                        media:
                          file:
                            url: https://www.example.com/video.mp4
                          thumbnail:
                            url: https://www.example.com/thumbnail.jpg
                          height: TALL
                        suggestions:
                        - text: Example text
                          postbackData: Example postback data
                          url: https://www.example.com/
                          application: BROWSER
                          type: OPEN_URL
                        - text: Example text
                          postbackData: Example postback data
                          type: REPLY
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: CARD
                  options:
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://www.example.com/tracking-callback-server
                      removeProtocol: false
              Carousel message:
                summary: Carousel message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: Some title
                        description: Some description
                        media:
                          file:
                            url: https://www.example.com/video.mp4
                          thumbnail:
                            url: https://www.example.com/thumbnail.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Example text
                          postbackData: Example postback data
                          url: https://www.example.com/
                          application: BROWSER
                          type: OPEN_URL
                        - text: Example text
                          postbackData: Example postback data
                          type: REPLY
                      - title: Another title
                        description: Another description
                        media:
                          file:
                            url: https://www.sample.com/video_2.mp4
                          thumbnail:
                            url: https://www.sample.com/thumbnail_2.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Another example text
                          postbackData: Another example postback data
                          url: https://www.sample.com/
                          application: WEBVIEW
                          webviewViewMode: FULL
                          type: OPEN_URL
                        - text: Another example text
                          postbackData: Another example postback data
                          type: REPLY
                      suggestions:
                      - text: Example text
                        postbackData: Example postback data
                        type: REPLY
                      type: CAROUSEL
              Provider template message:
                summary: Provider template message
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      templateId: ExampleTemplateId
                      parameters:
                      - name: param1
                        value: paramValue1
                      - name: param2
                        value: paramValue2
                      type: PROVIDER_TEMPLATE
              Text with different types of suggestions:
                summary: Text with different types of suggestions
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Some text
                      suggestions:
                      - text: Example reply
                        postbackData: Example postback data
                        type: REPLY
                      - text: Example open URL
                        postbackData: Example postback data
                        url: https://www.example.com/
                        application: WEBVIEW
                        webviewViewMode: TALL
                        type: OPEN_URL
                      - text: Example dial phone
                        postbackData: Example postback data
                        phoneNumber: '+123456789'
                        type: DIAL_PHONE
                      - text: Example show location
                        postbackData: Example postback data
                        latitude: 44.95303944321183
                        longitude: 13.856468230015984
                        label: Infobip HQ
                        type: SHOW_LOCATION
                      - text: Example request of location
                        postbackData: Example postback data
                        type: REQUEST_LOCATION
                      - text: Example create calendar event
                        postbackData: Example postback data
                        startTime: 2024-06-14T09:00:00.000+0000
                        endTime: 2024-06-14T10:00:00.000+0000
                        title: Example title
                        description: Example description
                        type: CREATE_CALENDAR_EVENT
                      type: TEXT
              Ordered messages with SMS failover:
                summary: Ordered messages with SMS failover
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: First message text
                      type: TEXT
                    options:
                      validityPeriod:
                        amount: 1
                        timeUnit: HOURS
                      campaignReferenceId: Example campaign id
                      smsFailover:
                        sender: DemoSender
                        text: Some failover text
                        validityPeriod:
                          amount: 1
                          timeUnit: HOURS
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Second message text
                      type: TEXT
                    options:
                      validityPeriod:
                        amount: 1
                        timeUnit: HOURS
                      campaignReferenceId: Example campaign id
                  options:
                    messageOrdering:
                      respectOrder: true
                      stopOnFailure: true
              Ordered messages without failover:
                summary: Ordered messages without failover
                value:
                  messages:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: First message text
                      type: TEXT
                    options:
                      validityPeriod:
                        amount: 1
                        timeUnit: HOURS
                      campaignReferenceId: Example campaign id
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Second message text
                      type: TEXT
                    options:
                      validityPeriod:
                        amount: 5
                        timeUnit: MINUTES
                      campaignReferenceId: Example campaign id
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      text: Third message text
                      type: TEXT
                    options:
                      validityPeriod:
                        amount: 5
                        timeUnit: MINUTES
                      campaignReferenceId: Example campaign id
                  options:
                    messageOrdering:
                      respectOrder: true
                      stopOnFailure: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '441134960001'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /ott/rcs/1/message:
    post:
      tags:
      - channels
      summary: Send RCS message
      description: Used for sending single RCS messages
      operationId: send-rcs-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest'
            examples:
              Text:
                summary: Text
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    text: exampleText
                    suggestions:
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REPLY
                    - text: exampleText
                      postbackData: examplePostbackData
                      url: www.example.test
                      type: OPEN_URL
                    - text: exampleText
                      postbackData: examplePostbackData
                      phoneNumber: '385977666618'
                      type: DIAL_PHONE
                    - text: exampleText
                      postbackData: examplePostbackData
                      latitude: 45.793418
                      longitude: 15.946297
                      label: label
                      type: SHOW_LOCATION
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REQUEST_LOCATION
                    type: TEXT
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
              File:
                summary: File
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    file:
                      url: www.example.url
                    thumbnail:
                      url: www.thumbnail.example.url
                    type: FILE
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
              Card:
                summary: Card
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    orientation: HORIZONTAL
                    alignment: LEFT
                    content:
                      title: title,
                      description: description
                      media:
                        file:
                          url: url
                        thumbnail:
                          url: url
                        height: MEDIUM
                    suggestions:
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REPLY
                    - text: exampleText
                      postbackData: examplePostbackData
                      url: www.example.test
                      type: OPEN_URL
                    - text: exampleText
                      postbackData: examplePostbackData
                      phoneNumber: '385977666618'
                      type: DIAL_PHONE
                    - text: exampleText
                      postbackData: examplePostbackData
                      latitude: 45.793418
                      longitude: 15.946297
                      label: label
                      type: SHOW_LOCATION
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REQUEST_LOCATION
                    type: CARD
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
              Carousel:
                summary: Carousel
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    cardWidth: MEDIUM
                    contents:
                    - title: title,
                      description: description
                      media:
                        file:
                          url: url
                        thumbnail:
                          url: url
                        height: MEDIUM
                    suggestions:
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REPLY
                    - text: exampleText
                      postbackData: examplePostbackData
                      url: www.example.test
                      type: OPEN_URL
                    - text: exampleText
                      postbackData: examplePostbackData
                      phoneNumber: '385977666618'
                      type: DIAL_PHONE
                    - text: exampleText
                      postbackData: examplePostbackData
                      latitude: 45.793418
                      longitude: 15.946297
                      label: label
                      type: SHOW_LOCATION
                    - text: exampleText
                      postbackData: examplePostbackData
                      type: REQUEST_LOCATION
                    type: CAROUSEL
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
              SMS failover example:
                summary: SMS failover example
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    text: exampleText
                    type: TEXT
                  smsFailover:
                    from: myInfoSmsSender
                    text: We could not reach you over RCS messaging.
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
              SMS failover regional example:
                summary: SMS failover regional example
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    text: exampleText
                    type: TEXT
                  smsFailover:
                    from: myInfoSmsSender
                    text: We could not reach you over RCS messaging.
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    regional:
                      indiaDlt:
                        contentTemplateId: myContentTemplateId
                        principalEntityId: myPrincipalEntityId
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /ott/rcs/1/message/bulk:
    post:
      tags:
      - channels
      summary: Send bulk RCS message
      description: Used for sending bulk RCS messages
      operationId: send-rcs-bulk-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendRequest'
            examples:
              Text:
                summary: Text
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      text: exampleText
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: TEXT
                    notifyUrl: https://www.example.com/rcs/
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      text: exampleText
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: TEXT
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
              File:
                summary: File
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      file:
                        url: www.example.url
                      thumbnail:
                        url: www.thumbnail.example.url
                      type: FILE
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      file:
                        url: www.example.url
                      thumbnail:
                        url: www.thumbnail.example.url
                      type: FILE
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
              Card:
                summary: Card
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: title,
                        description: description
                        media:
                          file:
                            url: url
                          thumbnail:
                            url: url
                          height: MEDIUM
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: CARD
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: title,
                        description: description
                        media:
                          file:
                            url: url
                          thumbnail:
                            url: url
                          height: MEDIUM
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: CARD
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
              Carousel:
                summary: Carousel
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: title,
                        description: description
                        media:
                          file:
                            url: url
                          thumbnail:
                            url: url
                          height: MEDIUM
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: CAROUSEL
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: title,
                        description: description
                        media:
                          file:
                            url: url
                          thumbnail:
                            url: url
                          height: MEDIUM
                      suggestions:
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REPLY
                      - text: exampleText
                        postbackData: examplePostbackData
                        url: www.example.test
                        type: OPEN_URL
                      - text: exampleText
                        postbackData: examplePostbackData
                        phoneNumber: '385977666618'
                        type: DIAL_PHONE
                      - text: exampleText
                        postbackData: examplePostbackData
                        latitude: 45.793418
                        longitude: 15.946297
                        label: label
                        type: SHOW_LOCATION
                      - text: exampleText
                        postbackData: examplePostbackData
                        type: REQUEST_LOCATION
                      type: CAROUSEL
                    notifyUrl: https://www.example.com/rcs/
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
              SMS failover example:
                summary: SMS failover example
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      text: exampleText
                      type: TEXT
                    smsFailover:
                      from: myInfoSmsSender
                      text: We could not reach you over RCS messaging.
                      validityPeriod: 15
                      validityPeriodTimeUnit: MINUTES
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
              SMS failover regional example:
                summary: SMS failover regional example
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      text: exampleText
                      type: TEXT
                    smsFailover:
                      from: myInfoSmsSender
                      text: We could not reach you over RCS messaging.
                      validityPeriod: 15
                      validityPeriodTimeUnit: MINUTES
                      regional:
                        indiaDlt:
                          contentTemplateId: myContentTemplateId
                          principalEntityId: myPrincipalEntityId
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /ott/rcs/1/message/template:
    post:
      tags:
      - channels
      summary: Send RCS template message
      description: Used for sending single RCS template messages (only for Vodafone Idea Limited, India)
      operationId: send-rcs-template-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest'
            examples:
              Template:
                summary: Template
                value:
                  from: myRcsSender
                  to: '385977666618'
                  validityPeriod: 15
                  validityPeriodTimeUnit: MINUTES
                  content:
                    templateName: myTemplateName
                    templateData:
                      price: '100'
                      promocode: ABC
                  notifyUrl: https://www.example.com/rcs
                  callbackData: Callback data
                  messageId: externalMessageId
                  entityId: entityId
                  applicationId: applicationId
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /ott/rcs/1/message/template/bulk:
    post:
      tags:
      - channels
      summary: Send bulk RCS template message
      description: Used for sending bulk RCS template messages (only for Vodafone Idea Limited, India)
      operationId: send-rcs-bulk-template-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendTemplateRequest'
            examples:
              Bulk Template:
                summary: Bulk Template
                value:
                  messages:
                  - from: myRcsSender
                    to: '385977666618'
                    validityPeriod: 15
                    validityPeriodTimeUnit: MINUTES
                    content:
                      templateName: myTemplateName
                      templateData:
                        price: '100'
                        promocode: ABC
                    notifyUrl: https://www.example.com/rcs
                    callbackData: Callback data
                    messageId: externalMessageId
                    entityId: entityId
                    applicationId: applicationId
        required: true
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /rcs/1/events:
    post:
      tags:
      - channels
      summary: Send RCS events
      description: Send RCS events to multiple recipients. Maximum request size is 10MB.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: send-rcs-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventRequest'
            examples:
              Typing indicator event:
                summary: Typing indicator event
                value:
                  events:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      type: TYPING_INDICATOR
              Seen event:
                summary: Seen event
                value:
                  events:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      type: SEEN
              Event with delivery time window:
                summary: Event with delivery time window
                value:
                  events:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      type: TYPING_INDICATOR
                    options:
                      platform:
                        entityId: Example entity id
                        applicationId: Example application ID
                      deliveryTimeWindow:
                        days:
                        - MONDAY
                        - TUESDAY
                        from:
                          hour: 9
                          minute: 0
                        to:
                          hour: 17
                          minute: 0
              Multiple events:
                summary: Multiple events
                value:
                  events:
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      type: TYPING_INDICATOR
                  - sender: DemoSender
                    destinations:
                    - to: '441134960001'
                    content:
                      messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      type: SEEN
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '441134960001'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/2/reports:
    get:
      tags:
      - channels
      summary: Get RCS delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: get-outbound-rcs-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReports'
              examples:
                RCS message delivered:
                  summary: RCS message delivered
                  value:
                    results:
                    - bulkId: BULK-123456
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No error
                        permanent: false
                      messageId: msg-abc123
                      doneAt: 2026-03-03T14:22:35.000+0100
                      interactionType: BASIC_MESSAGE
                      messageCount: 1
                      sentAt: 2026-03-03T14:22:30.000+0100
                      mccMnc: '21910'
                      callbackData: custom-user-data
                      to: '385911234567'
                      sender: sender
                      platform:
                        entityId: ext-entity-001
                        applicationId: ext-app-001
                      campaignReferenceId: CAMP-2026-Q1
                RCS message failed:
                  summary: RCS message failed
                  value:
                    results:
                    - bulkId: BULK-123456
                      status:
                        groupId: 2
                        groupName: UNDELIVERABLE
                        id: 4
                        name: UNDELIVERABLE_REJECTED_OPERATOR
                        description: Message rejected by operator
                      error:
                        groupId: 1
                        groupName: HANDSET_ERRORS
                        id: 7002
                        name: EC_UNKNOWN_USER
                        description: No matching user found (on platform or on provider)
                        permanent: true
                      messageId: msg-abc123
                      doneAt: 2026-03-03T14:22:35.000+0100
                      interactionType: BASIC_MESSAGE
                      messageCount: 1
                      sentAt: 2026-03-03T14:22:30.000+0100
                      mccMnc: '21910'
                      callbackData: custom-user-data
                      to: '385911234567'
                      sender: sender
                      platform:
                        entityId: ext-entity-001
                        applicationId: ext-app-001
                      campaignReferenceId: CAMP-2026-Q1
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - rcs:message:send
      - rcs:manage
  /rcs/2/logs:
    get:
      tags:
      - channels
      summary: Get RCS message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-rcs-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogResponseLogRcsOutboundMessageContent'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:logs:read
      - rcs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /rcs/2/capability-check/query:
    post:
      tags:
      - channels
      summary: Check RCS capability
      description: 'Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 500 phone numbers in a single request; however, for improved efficiency, performance, and response time, we recommend using smaller batches of 1 to 10 numbers in a single request. This synchronous API is typically used for routing purposes when verifying a number’s RCS capability immediately before sending a message. This API supports up to a 100 requests per second. For bulk database cleanup, we recommend to use the asynchronous Capability Check (CapCheck) API.


        The response will provide the list of capability statuses for each phone number individually. Ensure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If the sender is not launched on the network, the capability check request will always return a negative status for the tested phone numbers.'
      operationId: capability-check-rcs-destinations-query
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest'
            examples:
              RCS capability check request:
                summary: RCS capability check request
                value:
                  sender: DemoSender
                  phoneNumbers:
                  - '441134960001'
                  - '441134960002'
                  options:
                    platform:
                      entityId: Example entity id
                      applicationId: Example application id
          application/xml:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest'
            examples:
              RCS capability check request:
                summary: RCS capability check request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CapabilityCheckSyncRequest>\n  <sender>DemoSender</sender>\n  <phoneNumbers>\n    <phoneNumbers>441134960001</phoneNumbers>\n    <phoneNumbers>441134960002</phoneNumbers>\n  </phoneNumbers>\n  <options>\n    <platform>\n      <entityId>Example entity id</entityId>\n      <applicationId>Example application id</applicationId>\n    </platform>\n  </options>\n</CapabilityCheckSyncRequest>\n"
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse'
              examples:
                RCS capability check successful response:
                  summary: RCS capability check successful response
                  value:
                    capabilityCheckResults:
                    - messageId: d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8
                      phoneNumber: '441134960001'
                      code: ENABLED
                    - messageId: b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3
                      phoneNumber: '441134960002'
                      code: UNREACHABLE
                    options:
                      platform:
                        entityId: Example entity id
                        applicationId: Example application id
            application/xml:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse'
              examples:
                RCS capability check successful response:
                  summary: RCS capability check successful response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CapabilityCheckSyncResponse>\n  <capabilityCheckResults>\n    <capabilityCheckResults>\n      <messageId>d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8</messageId>\n      <phoneNumber>441134960001</phoneNumber>\n      <code>ENABLED</code>\n    </capabilityCheckResults>\n    <capabilityCheckResults>\n      <messageId>b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3</messageId>\n      <phoneNumber>441134960002</phoneNumber>\n      <code>UNREACHABLE</code>\n    </capabilityCheckResults>\n  </capabilityCheckResults>\n  <options>\n    <platform>\n      <entityId>Example entity id</entityId>\n      <applicationId>Example application id</applicationId>\n    </platform>\n  </options>\n</CapabilityCheckSyncResponse>\n"
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/2/capability-check/notify:
    post:
      tags:
      - channels
      summary: Check RCS capability (async)
      description: 'Use this endpoint to verify whether the phone numbers in a given list can receive RCS messages from the specified sender. You can check up to 10,000 phone numbers in a single request. The [Capability Check result](#channels/rcs/receive-capability-check-result) returns asynchronously and provides the capability status for each phone number individually.


        Ensure the sender is configured and launched on the mobile network/carrier that manages the phone numbers being tested for RCS capability. If the sender is not launched on the network, the capability check request will always return a negative status for the tested phone numbers.'
      operationId: capability-check-rcs-destinations-notify
      requestBody:
        description: The request body contains the sender and a list of phone numbers to check for RCS capability.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  sender: DemoSender
                  phoneNumbers:
                  - '441134960001'
                  - '441134960002'
                  notifyUrl: http://example.com/notify
                  notifyContentType: application/json
                  options:
                    platform:
                      entityId: Example entity id
                      applicationId: Example application id
          application/xml:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest'
            examples:
              Request example:
                summary: Request example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CapabilityCheckAsyncRequest>\n    \n  <sender>DemoSender</sender>\n    \n  <phoneNumbers>\n        \n    <phoneNumbers>441134960001</phoneNumbers>\n        \n    <phoneNumbers>441134960002</phoneNumbers>\n      \n  </phoneNumbers>\n    \n  <notifyUrl>https://example.com/notify</notifyUrl>\n    \n  <notifyContentType>application/xml</notifyContentType>\n    \n  <options>\n        \n    <platform>\n            \n      <entityId>Example entity id</entityId>\n            \n      <applicationId>Example application id</applicationId>\n          \n    </platform>\n      \n  </options>\n  \n</CapabilityCheckAsyncRequest>\n"
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse'
              examples:
                RCS capability check (async) successful response:
                  summary: RCS capability check (async) successful response
                  value:
                    bulkId: d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8
                    capabilityCheckRequestStates:
                    - messageId: d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8
                      phoneNumber: '441134960001'
                      status: PENDING_ENROUTE
                    - messageId: b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3
                      phoneNumber: '441134960002'
                      status: PENDING_ENROUTE
            application/xml:
              schema:
                $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse'
              examples:
                RCS capability check (async) successful response:
                  summary: RCS capability check (async) successful response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CapabilityCheckAsyncResponse>\n  <bulkId>d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8</bulkId>\n  <capabilityCheckRequestStates>\n    <capabilityCheckRequestStates>\n      <messageId>d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8</messageId>\n      <phoneNumber>441134960001</phoneNumber>\n      <status>PENDING_ENROUTE</status>\n    </capabilityCheckRequestStates>\n    <capabilityCheckRequestStates>\n      <messageId>b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3</messageId>\n      <phoneNumber>441134960002</phoneNumber>\n      <status>PENDING_ENROUTE</status>\n    </capabilityCheckRequestStates>\n  </capabilityCheckRequestStates>\n</CapabilityCheckAsyncResponse>\n"
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
  /rcs/1/senders:
    get:
      tags:
      - channels
      summary: Get RCS senders
      description: Retrieve list of RCS senders.
      operationId: get-rcs-senders
      parameters:
      - name: page
        in: query
        description: Results page you want to retrieve (0..N). The default value is 0.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 0
      - name: size
        in: query
        description: Number of records per page (1..100). The default value is 20.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 20
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is descending by ''updatedAt''. Sortable Properties: ''updatedAt'', ''senderName''.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: updatedAt,desc
      responses:
        '200':
          description: List of RCS senders
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderPageResponse'
              examples:
                RCS Senders:
                  summary: RCS Senders
                  value:
                    results:
                    - senderName: DemoSender
                      senderStatus: READY_FOR_TESTING
                      billingCategory: NON_CONVERSATIONAL
                      useCase: TRANSACTIONAL
                      hostingRegion: NORTH_AMERICA
                      brand:
                        brandName: SomeCompany
                      googleAgentId: demosender_axdawe0_agent
                      displayName: Demo Sender
                      description: Sender for demo purposes
                      color: '#0B78D0'
                      bannerUrl: https://www.somecompany.com/banner.jpg
                      logoUrl: https://www.somecompany.com/logo.jpg
                      updatedAt: 2025-02-15T16:38:24.000+0000
                    - senderName: InfoSender
                      senderStatus: PENDING_LAUNCH
                      billingCategory: NON_CONVERSATIONAL
                      useCase: MULTI_USE
                      hostingRegion: NORTH_AMERICA
                      brand:
                        brandName: SomeCompany
                      googleAgentId: demosender_axdawe0_agent
                      displayName: Info Sender
                      description: Info service sender
                      color: '#00756A'
                      bannerUrl: https://www.somecompany.com/banner.jpg
                      logoUrl: https://www.somecompany.com/logo.jpg
                      updatedAt: 2025-02-19T12:21:37.000+0000
                    paging:
                      page: 0
                      size: 2
                      totalPages: 5
                      totalResults: 10
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create an RCS sender
      description: 'Create an RCS sender. Created RCS sender can immediately be used to send test messages to test numbers. See [Add RCS test number](#channels/rcs/add-rcs-test-number) operation for more details about adding test numbers for sender. Please note that following limits will apply when creating RCS sender:

        * It is allowed to add up to 10 senders in total.


        Please contact your account manager if you need to add more senders.'
      operationId: create-rcs-sender
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsSenderApiRequest'
            examples:
              Create RCS Sender request:
                summary: Create RCS Sender request
                value:
                  senderName: DemoSender
                  billingCategory: NON_CONVERSATIONAL
                  useCase: TRANSACTIONAL
                  hostingRegion: NORTH_AMERICA
                  brand:
                    brandName: SomeCompany
                  displayName: Demo Sender
                  description: Sender for demo purposes
                  color: '#0B78D0'
                  phones:
                  - phoneNumber: '+441134960002'
                    label: Phone
                  emails:
                  - address: john.smith@somecompany.com
                    label: Email
                  websites:
                  - url: https://www.somecompany.com
                    label: Website
                  bannerUrl: https://www.somecompany.com/banner.jpg
                  logoUrl: https://www.somecompany.com/logo.jpg
                  privacy:
                    url: https://www.somecompany.com/privacy
                    label: Privacy Policy
                  termsOfService:
                    url: https://www.somecompany.com/terms
                    label: Terms and Conditions
                  platform:
                    applicationId: demo-application
                    entityId: demo-entity
        required: true
      responses:
        '202':
          description: Request has been accepted and result of create sender operation will be sent to webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse'
              examples:
                Accepted request:
                  summary: Accepted request
                  value:
                    senderName: DemoSender
                    senderStatus: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Conflict:
                  summary: Conflict
                  value:
                    errorCode: E409
                    description: Request cannot be processed due to conflicts with existing resources
                    action: Check violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}:
    get:
      tags:
      - channels
      summary: Get RCS sender
      description: Get a single RCS sender by sender name.
      operationId: get-rcs-sender
      parameters:
      - name: senderName
        in: path
        description: Sender identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      responses:
        '200':
          description: RCS sender
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSender'
              examples:
                RCS Sender:
                  summary: RCS Sender
                  value:
                    senderName: DemoSender
                    senderStatus: READY_FOR_TESTING
                    billingCategory: NON_CONVERSATIONAL
                    useCase: TRANSACTIONAL
                    hostingRegion: EUROPE
                    brand:
                      brandName: SomeCompany
                    googleAgentId: demosender_axdawe0_agent
                    displayName: Demo Sender
                    description: Sender for demo purposes
                    color: '#0B78D0'
                    phones:
                    - phoneNumber: '+441134960002'
                      label: Phone
                    emails:
                    - address: john.smith@somecompany.com
                      label: Email
                    websites:
                    - url: https://www.somecompany.com
                      label: Website
                    bannerUrl: https://www.somecompany.com/banner.jpg
                    logoUrl: https://www.somecompany.com/logo.jpg
                    privacy:
                      url: https://www.somecompany.com/privacy
                      label: Privacy Policy
                    termsOfService:
                      url: https://www.somecompany.com/terms
                      label: Terms and Conditions
                    platform:
                      applicationId: demo-application
                      entityId: demo-entity
                    updatedAt: 2025-02-15T16:38:24.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Update an RCS sender
      description: Update an RCS sender. Please note that once sender is locked, it's not possible to update sender data anymore.
      operationId: update-rcs-sender
      parameters:
      - name: senderName
        in: path
        description: Sender identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditRcsSenderApiRequest'
            examples:
              Update RCS Sender request:
                summary: Update RCS Sender request
                value:
                  billingCategory: NON_CONVERSATIONAL
                  useCase: MULTI_USE
                  displayName: Updated Demo Sender
                  description: Updated sender for demo purposes
                  color: '#D0180B'
                  phones:
                  - phoneNumber: '+441134960003'
                    label: Phone
                  emails:
                  - address: john.smith@somenewcompany.com
                    label: Email
                  websites:
                  - url: https://www.somenewcompany.com
                    label: Website
                  bannerUrl: https://www.somenewcompany.com/banner.jpg
                  logoUrl: https://www.somenewcompany.com/logo.jpg
                  privacy:
                    url: https://www.somenewcompany.com/privacy
                    label: Privacy Policy
                  termsOfService:
                    url: https://www.somenewcompany.com/terms
                    label: Terms and Conditions
                  platform:
                    applicationId: updated-application
                    entityId: updated-entity
        required: true
      responses:
        '202':
          description: Request has been accepted and result of update sender operation will be sent to webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse'
              examples:
                Accepted request:
                  summary: Accepted request
                  value:
                    senderName: DemoSender
                    senderStatus: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Conflict:
                  summary: Conflict
                  value:
                    errorCode: E409
                    description: Request cannot be processed due to conflicts with existing resources
                    action: Check violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}/platform-parameters:
    patch:
      tags:
      - channels
      summary: Update RCS sender platform parameters
      description: Update platform parameters associated with RCS sender. These parameters can be edited at any point of time.
      operationId: update-rcs-sender-platform-parameters
      parameters:
      - name: senderName
        in: path
        description: Sender identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditPlatformParametersApiRequest'
            examples:
              Update RCS Sender platform parameters request:
                summary: Update RCS Sender platform parameters request
                value:
                  platform:
                    applicationId: demo-application
                    entityId: demo-entity
        required: true
      responses:
        '202':
          description: Request has been accepted and result of update sender operation will be sent to webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse'
              examples:
                Accepted request:
                  summary: Accepted request
                  value:
                    senderName: DemoSender
                    senderStatus: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}/launch-status:
    get:
      tags:
      - channels
      summary: Get RCS sender launch status
      description: Get detailed launch status information for an RCS sender, including coverage details by country and provider. This endpoint provides granular information about the launch progress across different carriers and regions.
      operationId: get-rcs-sender-launch-status
      parameters:
      - name: senderName
        in: path
        description: Sender identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      responses:
        '200':
          description: RCS sender launch status with coverage details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent'
              examples:
                RCS Sender Launch Status:
                  summary: RCS Sender Launch Status
                  value:
                    event: RCS_SENDER_LAUNCH_STATUS_UPDATE
                    senderName: DemoSender
                    senderStatus: LAUNCHED_IN_PROGRESS
                    coverage:
                    - countryCode: US
                      providers:
                      - name: AEGIS_BRAND_VERIFICATION
                        status: COMPLETED
                        updatedAt: 2025-02-15T16:38:24.000+0000
                      - name: VERIZON
                        status: IN_PROGRESS
                        updatedAt: 2025-02-15T16:38:24.000+0000
                      - name: T_MOBILE
                        status: COMPLETED
                        updatedAt: 2025-02-15T16:38:24.000+0000
                      - name: ATT
                        status: REJECTED
                        rejectionReason: 'Request rejected due to missing information: Privacy policy needs opt-out ("Text STOP to opt out"), "Message and data rates may apply" disclaimer, and frequency disclosure. Terms must include "Information will not be sold, rented, or shared" statement.'
                        updatedAt: 2025-02-15T16:38:24.000+0000
                    updatedAt: 2026-07-22T11:45:08.923+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Sender not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                RCS Sender Launch Status:
                  summary: RCS Sender Launch Status
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: senderName
                      violation: sender "DemoSender" does not exist
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/providers:
    get:
      tags:
      - channels
      summary: Get RCS available providers
      description: Retrieve a list of RCS available providers specified by countries.
      operationId: get-rcs-available-providers
      parameters:
      - name: countryCode
        in: query
        description: Country code in two-letter ISO 3166-1 alpha 2 standard. If set, only providers available in the specified country will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: IN
      - name: page
        in: query
        description: Results page you want to retrieve (0..N).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
        example: 0
      - name: pageSize
        in: query
        description: Number of records per page (1..200).
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
        example: 20
      - name: sortDirection
        in: query
        description: 'Sorting order by property ''countryCode''. Sorting orders: ASC, DESC.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          default: ASC
        example: ASC
      responses:
        '200':
          description: List of RCS available providers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsCountryProvidersPageResponse'
              examples:
                RCS providers response filtered by country code:
                  summary: RCS providers response filtered by country code
                  value:
                    results:
                    - countryCode: IN
                      providers:
                      - JIO
                      - VODAFONE
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
                All RCS providers response:
                  summary: All RCS providers response
                  value:
                    results:
                    - countryCode: IN
                      providers:
                      - JIO
                      - VODAFONE
                    - countryCode: US
                      providers:
                      - AT&T
                      - VERIZON
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                RCS no coverage response:
                  summary: RCS no coverage response
                  value:
                    errorCode: E404
                    description: No Carriers/Providers available for a given country.
                    action: Please try again with a different country code.
                    violations:
                    - property: REQUEST
                      violation: No Carriers/Providers available for country with code IN.
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}/test-numbers:
    get:
      tags:
      - channels
      summary: Get RCS test numbers
      description: Get RCS test numbers for given sender. Please note that information about status of test number was correct at the moment when test number was last time updated. If latest status for some test number is needed, [Get RCS test number](#channels/rcs/get-rcs-test-number) operation can be used.
      operationId: get-rcs-test-numbers
      parameters:
      - name: senderName
        in: path
        description: Identifier of a sender for which test number is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      - name: page
        in: query
        description: Results page you want to retrieve (0..N). The default value is 0.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 0
      - name: size
        in: query
        description: Number of records per page (1..100). The default value is 20.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 20
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is descending by ''updatedAt''. Sortable Properties: ''updatedAt''.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: updatedAt,desc
      responses:
        '200':
          description: List of RCS test numbers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberPageResponse'
              examples:
                RCS test numbers:
                  summary: RCS test numbers
                  value:
                    results:
                    - testNumber: '+441134960001'
                      status: WAITING_FOR_TESTER_ACCEPTANCE
                      updatedAt: 2025-02-22T11:13:42.000+0000
                      primary: false
                    - testNumber: '+441134960002'
                      status: APPROVED
                      updatedAt: 2025-02-24T13:18:47.000+0000
                      primary: false
                    paging:
                      page: 0
                      size: 2
                      totalPages: 5
                      totalResults: 10
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Add RCS test number
      description: 'Add test number for given RCS sender. Invitation to become tester will be sent to given number and once user accepts invitation it will be possible to send test traffic to given test number using given sender. Please note that following limits will apply when adding test number for RCS sender:

        * It is allowed to add up to 20 test numbers per sender per day.

        * It is allowed to add up to 200 test number per sender in total.'
      operationId: add-rcs-test-number
      parameters:
      - name: senderName
        in: path
        description: Identifier of a sender for which test number is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTestNumberApiRequest'
            examples:
              Add RCS test number request:
                summary: Add RCS test number request
                value:
                  testNumber: '+441134960001'
                  primary: false
        required: true
      responses:
        '202':
          description: Request has been accepted and result of add test number operation will be sent to webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse'
              examples:
                Accepted request:
                  summary: Accepted request
                  value:
                    senderName: DemoSender
                    testNumber: '+441134960001'
                    status: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Conflict:
                  summary: Conflict
                  value:
                    errorCode: E409
                    description: Request cannot be processed due to conflicts with existing resources
                    action: Check violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}/test-numbers/{testNumber}:
    get:
      tags:
      - channels
      summary: Get RCS test number
      description: Get RCS test number. This operation will check current status of given test number and return most up to date result.
      operationId: get-rcs-test-number
      parameters:
      - name: senderName
        in: path
        description: Identifier of a sender for which test number is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      - name: testNumber
        in: path
        description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '+441134960001'
      responses:
        '200':
          description: RCS test number
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber'
              examples:
                RCS test number:
                  summary: RCS test number
                  value:
                    testNumber: '+441134960001'
                    status: WAITING_FOR_TESTER_ACCEPTANCE
                    updatedAt: 2025-02-22T11:13:42.000+0000
                    primary: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - channels
      summary: Update primary flag of RCS test number
      description: Update primary flag of RCS test number.
      operationId: update-rcs-test-number-primary
      parameters:
      - name: senderName
        in: path
        description: Identifier of a sender for which test number is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      - name: testNumber
        in: path
        description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '+441134960001'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.UpdateRcsTestNumberPrimaryApiRequest'
        required: true
      responses:
        '202':
          description: RCS test number
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{senderName}/test-numbers/{testNumber}/refresh:
    put:
      tags:
      - channels
      summary: Refresh RCS test number
      description: Status of RCS test number is automatically refreshed for 24 hours after it was added. If user does not accept invitation to become a tester in that period, test number will be marked as EXPIRED. Use this endpoint in order to start new 24 hours cycle in which system will periodically check if user has accepted to become a tester.
      operationId: refresh-rcs-test-number
      parameters:
      - name: senderName
        in: path
        description: Identifier of a sender for which test number is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: DemoSender
      - name: testNumber
        in: path
        description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '+441134960001'
      responses:
        '202':
          description: Request has been accepted and result of refresh test number operation will be sent to webhook
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse'
              examples:
                Accepted request:
                  summary: Accepted request
                  value:
                    senderName: DemoSender
                    testNumber: '+441134960001'
                    status: PENDING
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Conflict:
                  summary: Conflict
                  value:
                    errorCode: E409
                    description: Request cannot be processed due to conflicts with existing resources
                    action: Check violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{sender}/templates:
    get:
      tags:
      - channels
      summary: Get RCS templates
      description: Retrieve all RCS templates and their statuses for a specified sender. Available only for senders that support templates.
      operationId: rcs-template-list
      parameters:
      - name: sender
        in: path
        description: The sender whose templates will be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: status
        in: query
        description: The status used to filter and retrieve templates with the specified state. If the status is not specified, all templates are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus'
        example: APPROVED
      responses:
        '200':
          description: List of all templates with status for the given sender.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateListItem'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - name: Text template name
                    type: TEXT
                    status: APPROVED
                    lastUpdate: 2024-07-16T10:30:00.000+0000
                  - name: Text template name2
                    type: TEXT
                    status: APPROVED
                    lastUpdate: 2024-07-16T12:30:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create an RCS template
      description: Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates.
      operationId: rcs-template-create-v2
      parameters:
      - name: sender
        in: path
        description: The sender for whom the template will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTemplateRequest'
            examples:
              A Text message template example with a single parameter in the message text and a Reply suggestion:
                summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                value:
                  templateName: special_offer
                  providers: []
                  content:
                    text: Hello {{username}}! We've got a special offer for you!
                    suggestions:
                    - text: Thanks, I'm good
                      postbackData: decline
                      type: REPLY
                    - text: Shop online
                      postbackData: web
                      url: https://google.com
                      type: OPEN_URL
                    type: TEXT
              A Card message template example with an Open url suggestion:
                summary: A Card message template example with an Open url suggestion
                value:
                  templateName: special_offer_card
                  providers: []
                  content:
                    orientation: VERTICAL
                    alignment: RIGHT
                    content:
                      title: We wish you a happy holiday!
                      description: We've got a special offer for you!
                      media:
                        file:
                          url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                        height: MEDIUM
                      suggestions:
                      - text: Shop online
                        postbackData: web
                        url: https://google.com
                        type: OPEN_URL
                    type: CARD
              A Card message template example with multiple Open url suggestions:
                summary: A Card message template example with multiple Open url suggestions
                value:
                  templateName: special_offer_card
                  providers: []
                  content:
                    orientation: VERTICAL
                    alignment: RIGHT
                    content:
                      title: We wish you a happy holiday!
                      description: We've got a special offer for you!
                      media:
                        file:
                          url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                        height: MEDIUM
                      suggestions:
                      - text: Shop now!
                        postbackData: shop_click
                        url: https://google.com
                        application: BROWSER
                        type: OPEN_URL
                      - text: Get your personal discount for shopping later
                        postbackData: discount_click
                        url: https://google.com
                        application: WEBVIEW
                        webviewViewMode: HALF
                        type: OPEN_URL
                    type: CARD
              A Text message with PDF template example with Reply suggestions:
                summary: A Text message with PDF template example with Reply suggestions
                value:
                  templateName: user_agreement_pdf
                  providers: []
                  content:
                    text: Please read and confirm the User Agreement
                    url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                    messageOrder: TEXT_MESSAGE_AT_TOP
                    suggestions:
                    - text: I confirm
                      postbackData: confirm
                      type: REPLY
                    - text: I decline
                      postbackData: decline
                      type: REPLY
                    type: TEXT_WITH_PDF
              A Carousel message template example with 2 suggestions per each card:
                summary: A Carousel message template example with 2 suggestions per each card
                value:
                  templateName: holiday_booking_abc123
                  providers: []
                  content:
                    cardWidth: MEDIUM
                    contents:
                    - title: Small cabin in the woods
                      description: the perfect place to start your Shinrin-yoku
                      media:
                        file:
                          url: https://dummyimage.com/600x400/57b535/fff.jpg
                        height: MEDIUM
                      suggestions:
                      - text: Pay online
                        postbackData: pay_online_option_1
                        url: https://google.com/?option=1
                        type: OPEN_URL
                      - text: Pay on-site
                        postbackData: pay_onsite_option_1
                        type: REPLY
                    - title: A big house for a big company
                      description: When the whole family is gathered!
                      media:
                        file:
                          url: https://dummyimage.com/600x400/57b535/000.jpg
                        height: MEDIUM
                      suggestions:
                      - text: Pay online
                        postbackData: pay_online_option_2
                        url: https://google.com/?option=1
                        type: OPEN_URL
                      - text: Pay on-site
                        postbackData: pay_onsite_option_2
                        type: REPLY
                    type: CAROUSEL
              'An advanced example: Card message template with parameters in all available fields':
                summary: 'An advanced example: Card message template with parameters in all available fields'
                value:
                  templateName: template_params
                  providers: []
                  content:
                    orientation: HORIZONTAL
                    alignment: LEFT
                    content:
                      title: 'Hello {{username}}! '
                      description: We've got a special discount of {{discount_percent}}% for you!
                      media:
                        file:
                          url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                        height: MEDIUM
                      suggestions:
                      - text: 'Sounds interesting: send me an email to:{{user_email}}'
                        postbackData: '{{userId}}_email'
                        type: REPLY
                      - text: Call {{shop_name}}
                        postbackData: '{{userId}}_call'
                        phoneNumber: '{{shop_number}}'
                        type: DIAL_PHONE
                      - text: For offline shopping find {{shop_name}} here!
                        postbackData: '{{usedId}}_offline'
                        latitude: 72.83359188518756
                        longitude: 19.18467193599901
                        label: We're right here!
                        type: SHOW_LOCATION
                      - text: 'Check if delivery from {{shop_name}} is possible '
                        postbackData: '{{usedId}}_delivery'
                        type: REQUEST_LOCATION
                      - text: Don't forget our next sale on {{next_date}}
                        postbackData: '{{usedId}}_next_opt_in'
                        startTime: 2030-03-03T15:00Z
                        endTime: 2030-03-05T15:00Z
                        title: Best prices from {{shop_name}}!
                        description: It's never too late, {{user_title}}. {{user_lastname}}!
                        type: CREATE_CALENDAR_EVENT
                    type: CARD
        required: true
      responses:
        '200':
          description: RCS template created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate'
              examples:
                A Text message template example with a single parameter in the message text and a Reply suggestion:
                  summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                  value:
                    name: special_offer
                    type: TEXT
                    status: PENDING
                    content:
                      text: Hello {{username}}! We've got a special offer for you!
                      suggestions:
                      - text: Thanks, I'm good
                        postbackData: decline
                        type: REPLY
                      - text: Shop online
                        postbackData: web
                        url: https://google.com
                        type: OPEN_URL
                      type: TEXT
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with an Open url suggestion:
                  summary: A Card message template example with an Open url suggestion
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop online
                          postbackData: web
                          url: https://google.com
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with multiple Open url suggestions:
                  summary: A Card message template example with multiple Open url suggestions
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop now!
                          postbackData: shop_click
                          url: https://google.com
                          application: BROWSER
                          type: OPEN_URL
                        - text: Get your personal discount for shopping later
                          postbackData: discount_click
                          url: https://google.com
                          application: WEBVIEW
                          webviewViewMode: HALF
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Text message with PDF template example with Reply suggestions:
                  summary: A Text message with PDF template example with Reply suggestions
                  value:
                    name: user_agreement_pdf
                    type: TEXT_WITH_PDF
                    status: PENDING
                    content:
                      text: Please read and confirm the User Agreement
                      url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                      messageOrder: TEXT_MESSAGE_AT_TOP
                      suggestions:
                      - text: I confirm
                        postbackData: confirm
                        type: REPLY
                      - text: I decline
                        postbackData: decline
                        type: REPLY
                      type: TEXT_WITH_PDF
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Carousel message template example with 2 suggestions per each card:
                  summary: A Carousel message template example with 2 suggestions per each card
                  value:
                    name: holiday_booking_abc123
                    type: CAROUSEL
                    status: PENDING
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: Small cabin in the woods
                        description: the perfect place to start your Shinrin-yoku
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/fff.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_1
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_1
                          type: REPLY
                      - title: A big house for a big company
                        description: When the whole family is gathered!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/000.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_2
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_2
                          type: REPLY
                      type: CAROUSEL
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                'An advanced example: Card message template with parameters in all available fields':
                  summary: 'An advanced example: Card message template with parameters in all available fields'
                  value:
                    name: template_params
                    type: CARD
                    status: PENDING
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: 'Hello {{username}}! '
                        description: We've got a special discount of {{discount_percent}}% for you!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                          height: MEDIUM
                        suggestions:
                        - text: 'Sounds interesting: send me an email to:{{user_email}}'
                          postbackData: '{{userId}}_email'
                          type: REPLY
                        - text: Call {{shop_name}}
                          postbackData: '{{userId}}_call'
                          phoneNumber: '{{shop_number}}'
                          type: DIAL_PHONE
                        - text: For offline shopping find {{shop_name}} here!
                          postbackData: '{{usedId}}_offline'
                          latitude: 72.83359188518756
                          longitude: 19.18467193599901
                          label: We're right here!
                          type: SHOW_LOCATION
                        - text: 'Check if delivery from {{shop_name}} is possible '
                          postbackData: '{{usedId}}_delivery'
                          type: REQUEST_LOCATION
                        - text: Don't forget our next sale on {{next_date}}
                          postbackData: '{{usedId}}_next_opt_in'
                          startTime: 2030-03-03T15:00Z
                          endTime: 2030-03-05T15:00Z
                          title: Best prices from {{shop_name}}!
                          description: It's never too late, {{user_title}}. {{user_lastname}}!
                          type: CREATE_CALENDAR_EVENT
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{sender}/templates/{templateName}:
    get:
      tags:
      - channels
      summary: Get RCS template
      description: Retrieve a single RCS template with its status for a given sender and template name. Available only for senders that support templates.
      externalDocs:
        description: Learn more about the RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: rcs-template-get
      parameters:
      - name: sender
        in: path
        description: The sender whose specific template will be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template that will be retrieved for the specified sender.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 20
          minLength: 1
        example: demo_template
      responses:
        '200':
          description: Template details for the given sender and template name.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate'
              examples:
                A Text message template example with a single parameter in the message text and a Reply suggestion:
                  summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                  value:
                    name: special_offer
                    type: TEXT
                    status: PENDING
                    content:
                      text: Hello {{username}}! We've got a special offer for you!
                      suggestions:
                      - text: Thanks, I'm good
                        postbackData: decline
                        type: REPLY
                      - text: Shop online
                        postbackData: web
                        url: https://google.com
                        type: OPEN_URL
                      type: TEXT
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with an Open url suggestion:
                  summary: A Card message template example with an Open url suggestion
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop online
                          postbackData: web
                          url: https://google.com
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with multiple Open url suggestions:
                  summary: A Card message template example with multiple Open url suggestions
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop now!
                          postbackData: shop_click
                          url: https://google.com
                          application: BROWSER
                          type: OPEN_URL
                        - text: Get your personal discount for shopping later
                          postbackData: discount_click
                          url: https://google.com
                          application: WEBVIEW
                          webviewViewMode: HALF
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Text message with PDF template example with Reply suggestions:
                  summary: A Text message with PDF template example with Reply suggestions
                  value:
                    name: user_agreement_pdf
                    type: TEXT_WITH_PDF
                    status: PENDING
                    content:
                      text: Please read and confirm the User Agreement
                      url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                      messageOrder: TEXT_MESSAGE_AT_TOP
                      suggestions:
                      - text: I confirm
                        postbackData: confirm
                        type: REPLY
                      - text: I decline
                        postbackData: decline
                        type: REPLY
                      type: TEXT_WITH_PDF
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Carousel message template example with 2 suggestions per each card:
                  summary: A Carousel message template example with 2 suggestions per each card
                  value:
                    name: holiday_booking_abc123
                    type: CAROUSEL
                    status: PENDING
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: Small cabin in the woods
                        description: the perfect place to start your Shinrin-yoku
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/fff.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_1
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_1
                          type: REPLY
                      - title: A big house for a big company
                        description: When the whole family is gathered!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/000.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_2
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_2
                          type: REPLY
                      type: CAROUSEL
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                'An advanced example: Card message template with parameters in all available fields':
                  summary: 'An advanced example: Card message template with parameters in all available fields'
                  value:
                    name: template_params
                    type: CARD
                    status: PENDING
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: 'Hello {{username}}! '
                        description: We've got a special discount of {{discount_percent}}% for you!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                          height: MEDIUM
                        suggestions:
                        - text: 'Sounds interesting: send me an email to:{{user_email}}'
                          postbackData: '{{userId}}_email'
                          type: REPLY
                        - text: Call {{shop_name}}
                          postbackData: '{{userId}}_call'
                          phoneNumber: '{{shop_number}}'
                          type: DIAL_PHONE
                        - text: For offline shopping find {{shop_name}} here!
                          postbackData: '{{usedId}}_offline'
                          latitude: 72.83359188518756
                          longitude: 19.18467193599901
                          label: We're right here!
                          type: SHOW_LOCATION
                        - text: 'Check if delivery from {{shop_name}} is possible '
                          postbackData: '{{usedId}}_delivery'
                          type: REQUEST_LOCATION
                        - text: Don't forget our next sale on {{next_date}}
                          postbackData: '{{usedId}}_next_opt_in'
                          startTime: 2030-03-03T15:00Z
                          endTime: 2030-03-05T15:00Z
                          title: Best prices from {{shop_name}}!
                          description: It's never too late, {{user_title}}. {{user_lastname}}!
                          type: CREATE_CALENDAR_EVENT
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - channels
      summary: Edit an RCS template
      description: Edit an RCS template. Only PENDING, SUSPENDED or REJECTED templates can be edited. APPROVED templates cannot be modified. Available only for senders that support templates..
      operationId: rcs-template-update
      parameters:
      - name: sender
        in: path
        description: The sender whose template will be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template that will be updated for the specified sender.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 20
          minLength: 1
        example: demo_template
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent'
            examples:
              A Text message template example with a single parameter in the message text and a Reply suggestion:
                summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                value:
                  text: Hello {{username}}! We've got a special offer for you!
                  suggestions:
                  - text: Thanks, I'm good
                    postbackData: decline
                    type: REPLY
                  - text: Shop online
                    postbackData: web
                    url: https://google.com
                    type: OPEN_URL
                  type: TEXT
              A Card message template example with an Open url suggestion:
                summary: A Card message template example with an Open url suggestion
                value:
                  orientation: VERTICAL
                  alignment: RIGHT
                  content:
                    title: We wish you a happy holiday!
                    description: We've got a special offer for you!
                    media:
                      file:
                        url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                      height: MEDIUM
                    suggestions:
                    - text: Shop online
                      postbackData: web
                      url: https://google.com
                      type: OPEN_URL
                  type: CARD
              A Card message template example with multiple Open url suggestions:
                summary: A Card message template example with multiple Open url suggestions
                value:
                  orientation: VERTICAL
                  alignment: RIGHT
                  content:
                    title: We wish you a happy holiday!
                    description: We've got a special offer for you!
                    media:
                      file:
                        url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                      height: MEDIUM
                    suggestions:
                    - text: Shop now!
                      postbackData: shop_click
                      url: https://google.com
                      application: BROWSER
                      type: OPEN_URL
                    - text: Get your personal discount for shopping later
                      postbackData: discount_click
                      url: https://google.com
                      application: WEBVIEW
                      webviewViewMode: HALF
                      type: OPEN_URL
                  type: CARD
              A Text message with PDF template example with Reply suggestions:
                summary: A Text message with PDF template example with Reply suggestions
                value:
                  text: Please read and confirm the User Agreement
                  url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                  messageOrder: TEXT_MESSAGE_AT_TOP
                  suggestions:
                  - text: I confirm
                    postbackData: confirm
                    type: REPLY
                  - text: I decline
                    postbackData: decline
                    type: REPLY
                  type: TEXT_WITH_PDF
              A Carousel message template example with 2 suggestions per each card:
                summary: A Carousel message template example with 2 suggestions per each card
                value:
                  cardWidth: MEDIUM
                  contents:
                  - title: Small cabin in the woods
                    description: the perfect place to start your Shinrin-yoku
                    media:
                      file:
                        url: https://dummyimage.com/600x400/57b535/fff.jpg
                      height: MEDIUM
                    suggestions:
                    - text: Pay online
                      postbackData: pay_online_option_1
                      url: https://google.com/?option=1
                      type: OPEN_URL
                    - text: Pay on-site
                      postbackData: pay_onsite_option_1
                      type: REPLY
                  - title: A big house for a big company
                    description: When the whole family is gathered!
                    media:
                      file:
                        url: https://dummyimage.com/600x400/57b535/000.jpg
                      height: MEDIUM
                    suggestions:
                    - text: Pay online
                      postbackData: pay_online_option_2
                      url: https://google.com/?option=1
                      type: OPEN_URL
                    - text: Pay on-site
                      postbackData: pay_onsite_option_2
                      type: REPLY
                  type: CAROUSEL
              'An advanced example: Card message template with parameters in all available fields':
                summary: 'An advanced example: Card message template with parameters in all available fields'
                value:
                  orientation: HORIZONTAL
                  alignment: LEFT
                  content:
                    title: 'Hello {{username}}! '
                    description: We've got a special discount of {{discount_percent}}% for you!
                    media:
                      file:
                        url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                      height: MEDIUM
                    suggestions:
                    - text: 'Sounds interesting: send me an email to:{{user_email}}'
                      postbackData: '{{userId}}_email'
                      type: REPLY
                    - text: Call {{shop_name}}
                      postbackData: '{{userId}}_call'
                      phoneNumber: '{{shop_number}}'
                      type: DIAL_PHONE
                    - text: For offline shopping find {{shop_name}} here!
                      postbackData: '{{usedId}}_offline'
                      latitude: 72.83359188518756
                      longitude: 19.18467193599901
                      label: We're right here!
                      type: SHOW_LOCATION
                    - text: 'Check if delivery from {{shop_name}} is possible '
                      postbackData: '{{usedId}}_delivery'
                      type: REQUEST_LOCATION
                    - text: Don't forget our next sale on {{next_date}}
                      postbackData: '{{usedId}}_next_opt_in'
                      startTime: 2030-03-03T15:00Z
                      endTime: 2030-03-05T15:00Z
                      title: Best prices from {{shop_name}}!
                      description: It's never too late, {{user_title}}. {{user_lastname}}!
                      type: CREATE_CALENDAR_EVENT
                  type: CARD
        required: true
      responses:
        '200':
          description: RCS template edited successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate'
              examples:
                A Text message template example with a single parameter in the message text and a Reply suggestion:
                  summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                  value:
                    name: demo_template
                    type: TEXT
                    status: PENDING
                    content:
                      text: Hello {{username}}! We've got a special offer for you!
                      suggestions:
                      - text: Thanks, I'm good
                        postbackData: decline
                        type: REPLY
                      - text: Shop online
                        postbackData: web
                        url: https://google.com
                        type: OPEN_URL
                      type: TEXT
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with an Open url suggestion:
                  summary: A Card message template example with an Open url suggestion
                  value:
                    name: demo_template
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop online
                          postbackData: web
                          url: https://google.com
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with multiple Open url suggestions:
                  summary: A Card message template example with multiple Open url suggestions
                  value:
                    name: demo_template
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop now!
                          postbackData: shop_click
                          url: https://google.com
                          application: BROWSER
                          type: OPEN_URL
                        - text: Get your personal discount for shopping later
                          postbackData: discount_click
                          url: https://google.com
                          application: WEBVIEW
                          webviewViewMode: HALF
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Text message with PDF template example with Reply suggestions:
                  summary: A Text message with PDF template example with Reply suggestions
                  value:
                    name: demo_template
                    type: TEXT_WITH_PDF
                    status: PENDING
                    content:
                      text: Please read and confirm the User Agreement
                      url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                      messageOrder: TEXT_MESSAGE_AT_TOP
                      suggestions:
                      - text: I confirm
                        postbackData: confirm
                        type: REPLY
                      - text: I decline
                        postbackData: decline
                        type: REPLY
                      type: TEXT_WITH_PDF
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Carousel message template example with 2 suggestions per each card:
                  summary: A Carousel message template example with 2 suggestions per each card
                  value:
                    name: demo_template
                    type: CAROUSEL
                    status: PENDING
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: Small cabin in the woods
                        description: the perfect place to start your Shinrin-yoku
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/fff.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_1
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_1
                          type: REPLY
                      - title: A big house for a big company
                        description: When the whole family is gathered!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/000.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_2
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_2
                          type: REPLY
                      type: CAROUSEL
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                'An advanced example: Card message template with parameters in all available fields':
                  summary: 'An advanced example: Card message template with parameters in all available fields'
                  value:
                    name: demo_template
                    type: CARD
                    status: PENDING
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: 'Hello {{username}}! '
                        description: We've got a special discount of {{discount_percent}}% for you!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                          height: MEDIUM
                        suggestions:
                        - text: 'Sounds interesting: send me an email to:{{user_email}}'
                          postbackData: '{{userId}}_email'
                          type: REPLY
                        - text: Call {{shop_name}}
                          postbackData: '{{userId}}_call'
                          phoneNumber: '{{shop_number}}'
                          type: DIAL_PHONE
                        - text: For offline shopping find {{shop_name}} here!
                          postbackData: '{{usedId}}_offline'
                          latitude: 72.83359188518756
                          longitude: 19.18467193599901
                          label: We're right here!
                          type: SHOW_LOCATION
                        - text: 'Check if delivery from {{shop_name}} is possible '
                          postbackData: '{{usedId}}_delivery'
                          type: REQUEST_LOCATION
                        - text: Don't forget our next sale on {{next_date}}
                          postbackData: '{{usedId}}_next_opt_in'
                          startTime: 2030-03-03T15:00Z
                          endTime: 2030-03-05T15:00Z
                          title: Best prices from {{shop_name}}!
                          description: It's never too late, {{user_title}}. {{user_lastname}}!
                          type: CREATE_CALENDAR_EVENT
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create an RCS template
      description: Create an RCS template for a specified sender. The template will be submitted for review and approval. Once approved, the template can be used for messaging. Available only for senders that support templates. Please note that this endpoint is deprecated and will be removed in future versions.
      operationId: rcs-template-create
      parameters:
      - name: sender
        in: path
        description: The sender for whom the template will be created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template that will be created for the specified sender. Must contain only alphanumeric characters and underscores.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 20
          minLength: 1
        example: demo_template
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent'
            examples:
              A Text message template example with a single parameter in the message text and a Reply suggestion:
                summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                value:
                  text: Hello {{username}}! We've got a special offer for you!
                  suggestions:
                  - text: Thanks, I'm good
                    postbackData: decline
                    type: REPLY
                  - text: Shop online
                    postbackData: web
                    url: https://google.com
                    type: OPEN_URL
                  type: TEXT
              A Card message template example with an Open url suggestion:
                summary: A Card message template example with an Open url suggestion
                value:
                  orientation: VERTICAL
                  alignment: RIGHT
                  content:
                    title: We wish you a happy holiday!
                    description: We've got a special offer for you!
                    media:
                      file:
                        url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                      height: MEDIUM
                    suggestions:
                    - text: Shop online
                      postbackData: web
                      url: https://google.com
                      type: OPEN_URL
                  type: CARD
              A Card message template example with multiple Open url suggestions:
                summary: A Card message template example with multiple Open url suggestions
                value:
                  orientation: VERTICAL
                  alignment: RIGHT
                  content:
                    title: We wish you a happy holiday!
                    description: We've got a special offer for you!
                    media:
                      file:
                        url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                      height: MEDIUM
                    suggestions:
                    - text: Shop now!
                      postbackData: shop_click
                      url: https://google.com
                      application: BROWSER
                      type: OPEN_URL
                    - text: Get your personal discount for shopping later
                      postbackData: discount_click
                      url: https://google.com
                      application: WEBVIEW
                      webviewViewMode: HALF
                      type: OPEN_URL
                  type: CARD
              A Text message with PDF template example with Reply suggestions:
                summary: A Text message with PDF template example with Reply suggestions
                value:
                  text: Please read and confirm the User Agreement
                  url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                  messageOrder: TEXT_MESSAGE_AT_TOP
                  suggestions:
                  - text: I confirm
                    postbackData: confirm
                    type: REPLY
                  - text: I decline
                    postbackData: decline
                    type: REPLY
                  type: TEXT_WITH_PDF
              A Carousel message template example with 2 suggestions per each card:
                summary: A Carousel message template example with 2 suggestions per each card
                value:
                  cardWidth: MEDIUM
                  contents:
                  - title: Small cabin in the woods
                    description: the perfect place to start your Shinrin-yoku
                    media:
                      file:
                        url: https://dummyimage.com/600x400/57b535/fff.jpg
                      height: MEDIUM
                    suggestions:
                    - text: Pay online
                      postbackData: pay_online_option_1
                      url: https://google.com/?option=1
                      type: OPEN_URL
                    - text: Pay on-site
                      postbackData: pay_onsite_option_1
                      type: REPLY
                  - title: A big house for a big company
                    description: When the whole family is gathered!
                    media:
                      file:
                        url: https://dummyimage.com/600x400/57b535/000.jpg
                      height: MEDIUM
                    suggestions:
                    - text: Pay online
                      postbackData: pay_online_option_2
                      url: https://google.com/?option=1
                      type: OPEN_URL
                    - text: Pay on-site
                      postbackData: pay_onsite_option_2
                      type: REPLY
                  type: CAROUSEL
              'An advanced example: Card message template with parameters in all available fields':
                summary: 'An advanced example: Card message template with parameters in all available fields'
                value:
                  orientation: HORIZONTAL
                  alignment: LEFT
                  content:
                    title: 'Hello {{username}}! '
                    description: We've got a special discount of {{discount_percent}}% for you!
                    media:
                      file:
                        url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                      height: MEDIUM
                    suggestions:
                    - text: 'Sounds interesting: send me an email to:{{user_email}}'
                      postbackData: '{{userId}}_email'
                      type: REPLY
                    - text: Call {{shop_name}}
                      postbackData: '{{userId}}_call'
                      phoneNumber: '{{shop_number}}'
                      type: DIAL_PHONE
                    - text: For offline shopping find {{shop_name}} here!
                      postbackData: '{{usedId}}_offline'
                      latitude: 72.83359188518756
                      longitude: 19.18467193599901
                      label: We're right here!
                      type: SHOW_LOCATION
                    - text: 'Check if delivery from {{shop_name}} is possible '
                      postbackData: '{{usedId}}_delivery'
                      type: REQUEST_LOCATION
                    - text: Don't forget our next sale on {{next_date}}
                      postbackData: '{{usedId}}_next_opt_in'
                      startTime: 2030-03-03T15:00Z
                      endTime: 2030-03-05T15:00Z
                      title: Best prices from {{shop_name}}!
                      description: It's never too late, {{user_title}}. {{user_lastname}}!
                      type: CREATE_CALENDAR_EVENT
                  type: CARD
        required: true
      responses:
        '200':
          description: RCS template created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate'
              examples:
                A Text message template example with a single parameter in the message text and a Reply suggestion:
                  summary: A Text message template example with a single parameter in the message text and a Reply suggestion
                  value:
                    name: special_offer
                    type: TEXT
                    status: PENDING
                    content:
                      text: Hello {{username}}! We've got a special offer for you!
                      suggestions:
                      - text: Thanks, I'm good
                        postbackData: decline
                        type: REPLY
                      - text: Shop online
                        postbackData: web
                        url: https://google.com
                        type: OPEN_URL
                      type: TEXT
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with an Open url suggestion:
                  summary: A Card message template example with an Open url suggestion
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop online
                          postbackData: web
                          url: https://google.com
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Card message template example with multiple Open url suggestions:
                  summary: A Card message template example with multiple Open url suggestions
                  value:
                    name: special_offer_card
                    type: CARD
                    status: PENDING
                    content:
                      orientation: VERTICAL
                      alignment: RIGHT
                      content:
                        title: We wish you a happy holiday!
                        description: We've got a special offer for you!
                        media:
                          file:
                            url: https://i.pinimg.com/originals/b9/39/fb/b939fbcb2d4cacfb28b0b171d718539d.png
                          height: MEDIUM
                        suggestions:
                        - text: Shop now!
                          postbackData: shop_click
                          url: https://google.com
                          application: BROWSER
                          type: OPEN_URL
                        - text: Get your personal discount for shopping later
                          postbackData: discount_click
                          url: https://google.com
                          application: WEBVIEW
                          webviewViewMode: HALF
                          type: OPEN_URL
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Text message with PDF template example with Reply suggestions:
                  summary: A Text message with PDF template example with Reply suggestions
                  value:
                    name: user_agreement_pdf
                    type: TEXT_WITH_PDF
                    status: PENDING
                    content:
                      text: Please read and confirm the User Agreement
                      url: https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf
                      messageOrder: TEXT_MESSAGE_AT_TOP
                      suggestions:
                      - text: I confirm
                        postbackData: confirm
                        type: REPLY
                      - text: I decline
                        postbackData: decline
                        type: REPLY
                      type: TEXT_WITH_PDF
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                A Carousel message template example with 2 suggestions per each card:
                  summary: A Carousel message template example with 2 suggestions per each card
                  value:
                    name: holiday_booking_abc123
                    type: CAROUSEL
                    status: PENDING
                    content:
                      cardWidth: MEDIUM
                      contents:
                      - title: Small cabin in the woods
                        description: the perfect place to start your Shinrin-yoku
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/fff.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_1
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_1
                          type: REPLY
                      - title: A big house for a big company
                        description: When the whole family is gathered!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/57b535/000.jpg
                          height: MEDIUM
                        suggestions:
                        - text: Pay online
                          postbackData: pay_online_option_2
                          url: https://google.com/?option=1
                          type: OPEN_URL
                        - text: Pay on-site
                          postbackData: pay_onsite_option_2
                          type: REPLY
                      type: CAROUSEL
                    lastUpdate: 2024-11-05T12:00:00.000+0000
                'An advanced example: Card message template with parameters in all available fields':
                  summary: 'An advanced example: Card message template with parameters in all available fields'
                  value:
                    name: template_params
                    type: CARD
                    status: PENDING
                    content:
                      orientation: HORIZONTAL
                      alignment: LEFT
                      content:
                        title: 'Hello {{username}}! '
                        description: We've got a special discount of {{discount_percent}}% for you!
                        media:
                          file:
                            url: https://dummyimage.com/600x400/{{backgroundColor}}/{{textColor}}.jpg
                          height: MEDIUM
                        suggestions:
                        - text: 'Sounds interesting: send me an email to:{{user_email}}'
                          postbackData: '{{userId}}_email'
                          type: REPLY
                        - text: Call {{shop_name}}
                          postbackData: '{{userId}}_call'
                          phoneNumber: '{{shop_number}}'
                          type: DIAL_PHONE
                        - text: For offline shopping find {{shop_name}} here!
                          postbackData: '{{usedId}}_offline'
                          latitude: 72.83359188518756
                          longitude: 19.18467193599901
                          label: We're right here!
                          type: SHOW_LOCATION
                        - text: 'Check if delivery from {{shop_name}} is possible '
                          postbackData: '{{usedId}}_delivery'
                          type: REQUEST_LOCATION
                        - text: Don't forget our next sale on {{next_date}}
                          postbackData: '{{usedId}}_next_opt_in'
                          startTime: 2030-03-03T15:00Z
                          endTime: 2030-03-05T15:00Z
                          title: Best prices from {{shop_name}}!
                          description: It's never too late, {{user_title}}. {{user_lastname}}!
                          type: CREATE_CALENDAR_EVENT
                      type: CARD
                    lastUpdate: 2024-11-05T12:00:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-deprecationInformation:
        deprecation: 2025-11-12T12:00:00.000+0000
        successorOperationId: rcs-template-create-v2
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - channels
      summary: Delete an RCS template
      description: Delete an RCS template. Any messages sent using a deleted template will be rejected. Available only for senders that support templates.
      operationId: rcs-template-delete
      parameters:
      - name: sender
        in: path
        description: The sender whose template will be deleted.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template that will be deleted for the specified sender.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 20
          minLength: 1
        example: demo_template
      responses:
        '200':
          description: RCS template deleted successfully
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{sender}/templates/{templateName}/status:
    get:
      tags:
      - channels
      summary: Get RCS template status
      description: Retrieve the detailed status of a specified RCS template for a given sender. Available only for senders that support templates.
      operationId: rcs-template-get-status
      parameters:
      - name: sender
        in: path
        description: The sender whose template status will be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template for which the status will be retrieved.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: demo_template
      responses:
        '200':
          description: RCS Template Status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiDetailedStatusResponse'
              examples:
                the status of the requested template:
                  summary: the status of the requested template
                  description: The template with the requested templateName is APPROVED
                  value:
                    status: APPROVED
                    name: demo_template
                    coverage:
                    - countryCode: IN
                      providers:
                      - providerName: INDIA_VI
                        status: APPROVED
                        updatedAt: 2024-11-05T12:00:00.000+0000
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/senders/{sender}/templates/{templateName}/register:
    patch:
      tags:
      - channels
      summary: Register an RCS template
      description: Registers an RCS template with additional providers. Available only for senders that support templates.
      operationId: rcs-template-register
      parameters:
      - name: sender
        in: path
        description: The sender whose template should be registered with additional providers.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: Demo
      - name: templateName
        in: path
        description: The unique name of the template that should be registered with additional providers.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 20
          minLength: 1
        example: demo_template
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsRegisterTemplateRequest'
        required: true
      responses:
        '200':
          description: RCS template registered successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /rcs/1/templates/template-providers:
    get:
      tags:
      - channels
      summary: Get RCS template providers
      description: Get list of available template providers. List can be filtered by sender and country code.
      operationId: rcs-template-providers
      parameters:
      - name: sender
        in: query
        description: The sender for which the list of available template providers should be retrieved.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Demo
      - name: countryCode
        in: query
        description: Country code in two-letter ISO standard. If set, only providers available in the specified country will be returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: IN
      responses:
        '200':
          description: RCS template providers list fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProvidersResponse'
              examples:
                RCS template providers:
                  summary: RCS template providers
                  value:
                    providers:
                    - INDIA_VI
                    - INDONESIA_TELKOMSEL
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - rcs:manage
      - rcs:provision
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /omni/1/scenarios:
    get:
      tags:
      - channels
      summary: List all OMNI failover scenarios
      description: See all failover scenarios that you have created.
      operationId: get-omni-failover-scenarios
      parameters:
      - name: isDefault
        in: query
        description: Get default scenario.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: true
      - name: limit
        in: query
        description: Maximal number of scenarios that will be returned, defaults to __100__.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          minimum: 0
      - name: page
        in: query
        description: Indexed page of scenarios that will be returned, defaults to 0.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse'
              examples:
                Get all scenarios:
                  summary: Get all scenarios
                  value:
                    scenarios:
                    - key: AD9E01A5DC7BEE2C2B828D208182A611
                      name: Test SMS or Viber
                      flow:
                      - from: InfoSMS
                        channel: SMS
                      - from: ViberSender
                        channel: VIBER
                      default: false
                    - key: F9E67B67F89D2FD78611C910D7D40696
                      name: New scenario
                      flow:
                      - from: TestSender
                        channel: SMS
                      - from: '3045'
                        channel: VIBER
                      default: true
            application/xml:
              schema:
                $ref: '#/components/schemas/17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse'
              examples:
                Get all scenarios:
                  summary: Get all scenarios
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenariosResponse>\n  <scenarios>\n    <scenario>\n      <key>AD9E01A5DC7BEE2C2B828D208182A611</key>\n      <name>Test SMS or Viber</name>\n      <flow>\n        <step>\n          <from>InfoSMS</from>\n          <channel>SMS</channel>\n        </step>\n        <step>\n          <from>ViberSender</from>\n          <channel>VIBER</channel>\n        </step>\n      </flow>\n      <default>false</default>\n    </scenario>\n    <scenario>\n      <key>F9E67B67F89D2FD78611C910D7D40696</key>\n      <name>New scenario</name>\n      <flow>\n        <step>\n          <from>TestSender</from>\n          <channel>SMS</channel>\n        </step>\n        <step>\n          <from>3045</from>\n          <channel>VIBER</channel>\n        </step>\n      </flow>\n      <default>true</default>\n    </scenario>\n  </scenarios>\n</scenariosResponse>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '409':
          description: invalid scenario
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - omni-failover:manage
    post:
      tags:
      - channels
      summary: Create new OMNI failover scenario
      description: Define which channels, and in which order, would you like to use in your message failover scenario. If the delivery of the message fails for the first channel, we will use the next channel in your scenario, and so on.
      operationId: create-omni-failover-scenario
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest'
            examples:
              SMS-EMAIL scenario request:
                summary: SMS-EMAIL scenario request
                value:
                  name: SMS with e-mail fallback
                  flow:
                  - from: Travel agency
                    channel: SMS
                  - from: info@travelagency.com
                    channel: EMAIL
                  default: false
              PUSH-SMS scenario request:
                summary: PUSH-SMS scenario request
                value:
                  name: My PUSH-SMS scenario
                  flow:
                  - from: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                    channel: PUSH
                  - from: InfoSMS
                    channel: SMS
                  default: true
              VIBER-SMS scenario request:
                summary: VIBER-SMS scenario request
                value:
                  name: My VIBER-SMS scenario
                  flow:
                  - from: ViberSender
                    channel: VIBER
                  - from: InfoSMS
                    channel: SMS
                  default: true
              VK-SMS scenario request:
                summary: VK-SMS scenario request
                value:
                  name: My VK-SMS scenario
                  flow:
                  - from: InfoVK
                    channel: VKONTAKTE
                  - from: InfoSMS
                    channel: SMS
                  default: true
              LINE-SMS scenario request:
                summary: LINE-SMS scenario request
                value:
                  name: My LINE-SMS scenario
                  flow:
                  - from: InfoLine
                    channel: LINE
                  - from: InfoSMS
                    channel: SMS
                  default: true
              WHATSAPP-SMS scenario request:
                summary: WHATSAPP-SMS scenario request
                value:
                  name: My WHATSAPP-SMS scenario
                  flow:
                  - from: WhatsAppSender
                    channel: WHATSAPP
                  - from: InfoSMS
                    channel: SMS
                  default: true
          application/xml:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest'
            examples:
              SMS-EMAIL scenario request:
                summary: SMS-EMAIL scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>SMS with e-mail fallback</name>\n  <flow>\n    <step>\n      <from>Travel agency</from>\n      <channel>SMS</channel>\n    </step>\n    <step>\n      <from>info@travelagency.com</from>\n      <channel>EMAIL</channel>\n    </step>\n  </flow>\n  <default>false</default>\n</scenario>\n"
              PUSH-SMS scenario request:
                summary: PUSH-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My PUSH-SMS scenario</name>\n  <flow>\n    <step>\n      <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n      <channel>PUSH</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              VIBER-SMS scenario request:
                summary: VIBER-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VIBER-SMS scenario</name>\n  <flow>\n    <step>\n      <from>ViberSender</from>\n      <channel>VIBER</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              VK-SMS scenario request:
                summary: VK-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VK-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoVK</from>\n      <channel>VKONTAKTE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              LINE-SMS scenario request:
                summary: LINE-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My LINE-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoLine</from>\n      <channel>LINE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              WHATSAPP-SMS scenario request:
                summary: WHATSAPP-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My WHATSAPP-SMS scenario</name>\n  <flow>\n    <step>\n      <from>WhatsAppSender</from>\n      <channel>WHATSAPP</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
        required: true
      responses:
        '201':
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario request:
                  summary: SMS-EMAIL scenario request
                  value:
                    name: SMS with e-mail fallback
                    flow:
                    - from: Travel agency
                      channel: SMS
                    - from: info@travelagency.com
                      channel: EMAIL
                    default: false
                PUSH-SMS scenario request:
                  summary: PUSH-SMS scenario request
                  value:
                    name: My PUSH-SMS scenario
                    flow:
                    - from: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                      channel: PUSH
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VIBER-SMS scenario request:
                  summary: VIBER-SMS scenario request
                  value:
                    name: My VIBER-SMS scenario
                    flow:
                    - from: ViberSender
                      channel: VIBER
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VK-SMS scenario request:
                  summary: VK-SMS scenario request
                  value:
                    name: My VK-SMS scenario
                    flow:
                    - from: InfoVK
                      channel: VKONTAKTE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                LINE-SMS scenario request:
                  summary: LINE-SMS scenario request
                  value:
                    name: My LINE-SMS scenario
                    flow:
                    - from: InfoLine
                      channel: LINE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                WHATSAPP-SMS scenario request:
                  summary: WHATSAPP-SMS scenario request
                  value:
                    name: My WHATSAPP-SMS scenario
                    flow:
                    - from: WhatsAppSender
                      channel: WHATSAPP
                    - from: InfoSMS
                      channel: SMS
                    default: true
            application/xml:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario request:
                  summary: SMS-EMAIL scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>SMS with e-mail fallback</name>\n  <flow>\n    <step>\n      <from>Travel agency</from>\n      <channel>SMS</channel>\n    </step>\n    <step>\n      <from>info@travelagency.com</from>\n      <channel>EMAIL</channel>\n    </step>\n  </flow>\n  <default>false</default>\n</scenario>\n"
                PUSH-SMS scenario request:
                  summary: PUSH-SMS scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My PUSH-SMS scenario</name>\n  <flow>\n    <step>\n      <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n      <channel>PUSH</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VIBER-SMS scenario request:
                  summary: VIBER-SMS scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VIBER-SMS scenario</name>\n  <flow>\n    <step>\n      <from>ViberSender</from>\n      <channel>VIBER</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VK-SMS scenario request:
                  summary: VK-SMS scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VK-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoVK</from>\n      <channel>VKONTAKTE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                LINE-SMS scenario request:
                  summary: LINE-SMS scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My LINE-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoLine</from>\n      <channel>LINE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                WHATSAPP-SMS scenario request:
                  summary: WHATSAPP-SMS scenario request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My WHATSAPP-SMS scenario</name>\n  <flow>\n    <step>\n      <from>WhatsAppSender</from>\n      <channel>WHATSAPP</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
        '400':
          description: invalid scenario
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '409':
          description: creating scenario is forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - omni-failover:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 10
        timeUnit: m
  /omni/1/scenarios/{scenarioKey}:
    get:
      tags:
      - channels
      summary: Get specific OMNI failover scenario
      description: See configuration of a specific failover scenario.
      operationId: get-omni-failover-scenario
      parameters:
      - name: scenarioKey
        in: path
        description: Key used to uniquely identify OMNI scenario.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: AD9E01A5DC7BEE2C2B828D208182A611
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario response:
                  summary: SMS-EMAIL scenario response
                  value:
                    key: AD9E01A5DC7BEE2C2B828D208182A611
                    name: SMS with e-mail fallback
                    flow:
                    - from: Travel agency
                      channel: SMS
                    - from: info@travelagency.com
                      channel: EMAIL
                    default: false
                PUSH-SMS scenario response:
                  summary: PUSH-SMS scenario response
                  value:
                    key: F9E67B67F89D2FD78611C910D7D40696
                    name: My PUSH-SMS scenario
                    flow:
                    - from: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                      channel: PUSH
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VIBER-SMS scenario response:
                  summary: VIBER-SMS scenario response
                  value:
                    key: E6829A141B902776020F736D3FBE16A5
                    name: My VIBER-SMS scenario
                    flow:
                    - from: ViberSender
                      channel: VIBER
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VK-SMS scenario response:
                  summary: VK-SMS scenario response
                  value:
                    key: B1D326FE92D0AAA074C512B3C5A71A67
                    name: My VK-SMS scenario
                    flow:
                    - from: InfoVK
                      channel: VKONTAKTE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                LINE-SMS scenario response:
                  summary: LINE-SMS scenario response
                  value:
                    key: 92B7C75248434CAB0977D08990A324A1
                    name: My LINE-SMS scenario
                    flow:
                    - from: InfoLine
                      channel: LINE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                WHATSAPP-SMS scenario response:
                  summary: WHATSAPP-SMS scenario response
                  value:
                    key: 48F081B992190D591A44B54F7AE2D843
                    name: My WHATSAPP-SMS scenario
                    flow:
                    - from: WhatsAppSender
                      channel: WHATSAPP
                    - from: InfoSMS
                      channel: SMS
                    default: true
            application/xml:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario response:
                  summary: SMS-EMAIL scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>AD9E01A5DC7BEE2C2B828D208182A611</key>\n  <name>SMS with e-mail fallback</name>\n  <flow>\n    <step>\n      <from>Travel agency</from>\n      <channel>SMS</channel>\n    </step>\n    <step>\n      <from>info@travelagency.com</from>\n      <channel>EMAIL</channel>\n    </step>\n  </flow>\n  <default>false</default>\n</scenario>\n"
                PUSH-SMS scenario response:
                  summary: PUSH-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>F9E67B67F89D2FD78611C910D7D40696</key>\n  <name>My PUSH-SMS scenario</name>\n  <flow>\n    <step>\n      <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n      <channel>PUSH</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VIBER-SMS scenario response:
                  summary: VIBER-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>E6829A141B902776020F736D3FBE16A5</key>\n  <name>My VIBER-SMS scenario</name>\n  <flow>\n    <step>\n      <from>ViberSender</from>\n      <channel>VIBER</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VK-SMS scenario response:
                  summary: VK-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>B1D326FE92D0AAA074C512B3C5A71A67</key>\n  <name>My VK-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoVK</from>\n      <channel>VKONTAKTE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                LINE-SMS scenario response:
                  summary: LINE-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>92B7C75248434CAB0977D08990A324A1</key>\n  <name>My LINE-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoLine</from>\n      <channel>LINE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                WHATSAPP-SMS scenario response:
                  summary: WHATSAPP-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>48F081B992190D591A44B54F7AE2D843</key>\n  <name>My WHATSAPP-SMS scenario</name>\n  <flow>\n    <step>\n      <from>WhatsAppSender</from>\n      <channel>WHATSAPP</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: scenario not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '409':
          description: invalid scenario
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - omni-failover:manage
    put:
      tags:
      - channels
      summary: Update OMNI failover scenario
      description: Change configuration of a specific failover scenario.
      operationId: update-omni-failover-scenario
      parameters:
      - name: scenarioKey
        in: path
        description: Key used to uniquely identify OMNI scenario.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: CD265875E3A6EA43478D5F37A635BE4A
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest'
            examples:
              SMS-EMAIL scenario request:
                summary: SMS-EMAIL scenario request
                value:
                  name: SMS with e-mail fallback
                  flow:
                  - from: Travel agency
                    channel: SMS
                  - from: info@travelagency.com
                    channel: EMAIL
                  default: false
              PUSH-SMS scenario request:
                summary: PUSH-SMS scenario request
                value:
                  name: My PUSH-SMS scenario
                  flow:
                  - from: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                    channel: PUSH
                  - from: InfoSMS
                    channel: SMS
                  default: true
              VIBER-SMS scenario request:
                summary: VIBER-SMS scenario request
                value:
                  name: My VIBER-SMS scenario
                  flow:
                  - from: ViberSender
                    channel: VIBER
                  - from: InfoSMS
                    channel: SMS
                  default: true
              VK-SMS scenario request:
                summary: VK-SMS scenario request
                value:
                  name: My VK-SMS scenario
                  flow:
                  - from: InfoVK
                    channel: VKONTAKTE
                  - from: InfoSMS
                    channel: SMS
                  default: true
              LINE-SMS scenario request:
                summary: LINE-SMS scenario request
                value:
                  name: My LINE-SMS scenario
                  flow:
                  - from: InfoLine
                    channel: LINE
                  - from: InfoSMS
                    channel: SMS
                  default: true
              WHATSAPP-SMS scenario request:
                summary: WHATSAPP-SMS scenario request
                value:
                  name: My WHATSAPP-SMS scenario
                  flow:
                  - from: WhatsAppSender
                    channel: WHATSAPP
                  - from: InfoSMS
                    channel: SMS
                  default: true
          application/xml:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest'
            examples:
              SMS-EMAIL scenario request:
                summary: SMS-EMAIL scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>SMS with e-mail fallback</name>\n  <flow>\n    <step>\n      <from>Travel agency</from>\n      <channel>SMS</channel>\n    </step>\n    <step>\n      <from>info@travelagency.com</from>\n      <channel>EMAIL</channel>\n    </step>\n  </flow>\n  <default>false</default>\n</scenario>\n"
              PUSH-SMS scenario request:
                summary: PUSH-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My PUSH-SMS scenario</name>\n  <flow>\n    <step>\n      <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n      <channel>PUSH</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              VIBER-SMS scenario request:
                summary: VIBER-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VIBER-SMS scenario</name>\n  <flow>\n    <step>\n      <from>ViberSender</from>\n      <channel>VIBER</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              VK-SMS scenario request:
                summary: VK-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My VK-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoVK</from>\n      <channel>VKONTAKTE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              LINE-SMS scenario request:
                summary: LINE-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My LINE-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoLine</from>\n      <channel>LINE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
              WHATSAPP-SMS scenario request:
                summary: WHATSAPP-SMS scenario request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <name>My WHATSAPP-SMS scenario</name>\n  <flow>\n    <step>\n      <from>WhatsAppSender</from>\n      <channel>WHATSAPP</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario response:
                  summary: SMS-EMAIL scenario response
                  value:
                    key: AD9E01A5DC7BEE2C2B828D208182A611
                    name: SMS with e-mail fallback
                    flow:
                    - from: Travel agency
                      channel: SMS
                    - from: info@travelagency.com
                      channel: EMAIL
                    default: false
                PUSH-SMS scenario response:
                  summary: PUSH-SMS scenario response
                  value:
                    key: F9E67B67F89D2FD78611C910D7D40696
                    name: My PUSH-SMS scenario
                    flow:
                    - from: 233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53
                      channel: PUSH
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VIBER-SMS scenario response:
                  summary: VIBER-SMS scenario response
                  value:
                    key: E6829A141B902776020F736D3FBE16A5
                    name: My VIBER-SMS scenario
                    flow:
                    - from: ViberSender
                      channel: VIBER
                    - from: InfoSMS
                      channel: SMS
                    default: true
                VK-SMS scenario response:
                  summary: VK-SMS scenario response
                  value:
                    key: B1D326FE92D0AAA074C512B3C5A71A67
                    name: My VK-SMS scenario
                    flow:
                    - from: InfoVK
                      channel: VKONTAKTE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                LINE-SMS scenario response:
                  summary: LINE-SMS scenario response
                  value:
                    key: 92B7C75248434CAB0977D08990A324A1
                    name: My LINE-SMS scenario
                    flow:
                    - from: InfoLine
                      channel: LINE
                    - from: InfoSMS
                      channel: SMS
                    default: true
                WHATSAPP-SMS scenario response:
                  summary: WHATSAPP-SMS scenario response
                  value:
                    key: 48F081B992190D591A44B54F7AE2D843
                    name: My WHATSAPP-SMS scenario
                    flow:
                    - from: WhatsAppSender
                      channel: WHATSAPP
                    - from: InfoSMS
                      channel: SMS
                    default: true
            application/xml:
              schema:
                $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
              examples:
                SMS-EMAIL scenario response:
                  summary: SMS-EMAIL scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>AD9E01A5DC7BEE2C2B828D208182A611</key>\n  <name>SMS with e-mail fallback</name>\n  <flow>\n    <step>\n      <from>Travel agency</from>\n      <channel>SMS</channel>\n    </step>\n    <step>\n      <from>info@travelagency.com</from>\n      <channel>EMAIL</channel>\n    </step>\n  </flow>\n  <default>false</default>\n</scenario>\n"
                PUSH-SMS scenario response:
                  summary: PUSH-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>F9E67B67F89D2FD78611C910D7D40696</key>\n  <name>My PUSH-SMS scenario</name>\n  <flow>\n    <step>\n      <from>233623e3c860b49ec69a464834343481-8bj4el4a-256d-23fd-56ad-b5bc3d568b53</from>\n      <channel>PUSH</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VIBER-SMS scenario response:
                  summary: VIBER-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>E6829A141B902776020F736D3FBE16A5</key>\n  <name>My VIBER-SMS scenario</name>\n  <flow>\n    <step>\n      <from>ViberSender</from>\n      <channel>VIBER</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                VK-SMS scenario response:
                  summary: VK-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>B1D326FE92D0AAA074C512B3C5A71A67</key>\n  <name>My VK-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoVK</from>\n      <channel>VKONTAKTE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                LINE-SMS scenario response:
                  summary: LINE-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>92B7C75248434CAB0977D08990A324A1</key>\n  <name>My LINE-SMS scenario</name>\n  <flow>\n    <step>\n      <from>InfoLine</from>\n      <channel>LINE</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
                WHATSAPP-SMS scenario response:
                  summary: WHATSAPP-SMS scenario response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><scenario>\n  <key>48F081B992190D591A44B54F7AE2D843</key>\n  <name>My WHATSAPP-SMS scenario</name>\n  <flow>\n    <step>\n      <from>WhatsAppSender</from>\n      <channel>WHATSAPP</channel>\n    </step>\n    <step>\n      <from>InfoSMS</from>\n      <channel>SMS</channel>\n    </step>\n  </flow>\n  <default>true</default>\n</scenario>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: scenario not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '409':
          description: invalid scenario
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - omni-failover:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 10
        timeUnit: m
  /omni/1/advanced:
    post:
      tags:
      - channels
      summary: Send OMNI failover message
      description: Send one or multiple messages over WhatsApp, Viber, Voice, VKontakte, Line, SMS or Push, with automatic failover to another channel according to the specific scenario.
      operationId: send-omni-failover-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest'
            examples:
              Send OMNI advanced message:
                summary: Send OMNI advanced message
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  bulkId: BULK-ID-123-xyz
                  destinations:
                  - messageId: MESSAGE-ID-123-xyz
                    to:
                      phoneNumber: '41793026727'
                      emailAddress: email@example.com
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.
                    transliteration: TURKISH
                    language:
                      languageCode: TR
                  viber:
                    text: Or to have fun with Viber text.
                  voice:
                    text: Or make a call and read this text
                  email:
                    text: Finally, send an email.
                    subject: Email subject
              Send a scheduled OMNI message with a custom Validity period:
                summary: Send a scheduled OMNI message with a custom Validity period
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  destinations:
                  - messageId: MESSAGE-ID-123-xyz
                    to:
                      phoneNumber: '41793026727'
                      emailAddress: email@example.com
                  sms:
                    text: After one minute I'm trying to reach the user on SMS
                    validityPeriod: 90
                    validityPeriodTimeUnit: SECONDS
                  viber:
                    text: Viber message is going first.
                    validityPeriod: 1
                  email:
                    text: Two and a half minutes (1 minute + 90 seconds) after the initial message I'm trying to reach the user on email for the next two hours.
                    validityPeriod: 2
                    validityPeriodTimeUnit: HOURS
                    subject: Hey - turn on your mobile phone!
                  sendAt: 2021-05-24T10:45:38.000+0000
              Send OMNI PUSH-SMS message:
                summary: Send OMNI PUSH-SMS message
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  push:
                    text: This PUSH message will pop up on your mobile device.
              Send OMNI PUSH message with a custom payload:
                summary: Send OMNI PUSH message with a custom payload
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  push:
                    text: This PUSH message will pop up on your mobile device.
                    customPayload:
                      contentUrl: https://someurl.com/content
                      deepLink: myApp://some/link
              Send OMNI PUSH message with notification options:
                summary: Send OMNI PUSH message with notification options
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  push:
                    text: This PUSH message will pop up on your mobile device.
                    customPayload:
                      contentUrl: https://someurl.com/content
                      deepLink: myApp://some/link
                    notificationOptions:
                      vibrationEnabled: true
                      soundEnabled: true
                      soundName: sound.wav
                      badge: 1
                      contentUrl: http://www.mydomain.com/images/image1.jpg
                      category: mm_accept_decline
                      inAppStyle: MODAL
                      title: This is some title
                      webViewUrl: http://someurl.com
                    targetOnlyPrimaryDevices: true
                    includeNotificationsDisabledDevices: true
                    personSubscriptions:
                    - receiveMarketingInfo
                    deviceSubscriptions:
                    - transactionFinished
              Send OMNI SMS-EMAIL message:
                summary: Send OMNI SMS-EMAIL message
                value:
                  scenarioKey: AD9E01A5DC7BEE2C2B828D208182A611
                  destinations:
                  - to:
                      phoneNumber: '385974241491'
                      emailAddress: john.smith@gmail.com
                  - to:
                      phoneNumber: '38597213556611111'
                      emailAddress: jane.smith@gmail.com
                  sms:
                    text: Hello, we are happy to confirm your reservation for the safari trip.
                    validityPeriod: 1
                  email:
                    text: Hello, we are happy to confirm your reservation for the safari trip.
                    subject: Reservation confirmed!
              Send OMNI VIBER-SMS message:
                summary: Send OMNI VIBER-SMS message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  viber:
                    text: This Viber message will be delivered to Viber application on the user device.
              Send Rich Viber message:
                summary: Send Rich Viber message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received via SMS if Viber message is not delivered.
                    validityPeriod: 1
                  viber:
                    text: This Viber message will be delivered to Viber application on the user device.
                    validityPeriod: 1
                    imageURL: http://www.infobip.com/infobip-logo.png
                    buttonText: More information
                    buttonURL: http://www.infobip.com/
                    isPromotional: false
              Send OMNI WHATSAPP-SMS message:
                summary: Send OMNI WHATSAPP-SMS message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  whatsApp:
                    text: This Whatsapp message will be delivered to WhatsApp application on the user device.
              Send WhatsApp template message:
                summary: Send WhatsApp template message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    templateName: template_name
                    templateData:
                    - Jennifer
                    - $2543.56
                    language: en
              Send WhatsApp media template message:
                summary: Send WhatsApp media template message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    templateName: media_template_name
                    mediaTemplateData:
                      header:
                        imageUrl: https://www.example.com/image.png
                      body:
                        placeholders:
                        - Jennifer
                        - $2543.56
                    language: en
              Send WhatsApp media template message with quick reply buttons:
                summary: Send WhatsApp media template message with quick reply buttons
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    templateName: media_template_name
                    mediaTemplateData:
                      header:
                        imageUrl: https://www.infobip.com/infobip-logo.png
                      body:
                        placeholders:
                        - Jennifer
                        - $2543.56
                      buttons:
                      - quickReplyPayload: button1
                      - quickReplyPayload: button2
                      - quickReplyPayload: button3
                    language: en
              Send WhatsApp media template message with action button:
                summary: Send WhatsApp media template message with action button
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    templateName: media_template_name
                    mediaTemplateData:
                      header:
                        imageUrl: https://www.infobip.com/infobip-logo.png
                      body:
                        placeholders:
                        - Jennifer
                        - $2543.56
                      buttons:
                      - urlPlaceholder: example1.pdf
                    language: en
              Send WhatsApp text free form message:
                summary: Send WhatsApp text free form message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    text: This WhatsApp message will be delivered to WhatsApp application on the user device.
              Send WhatsApp Image message:
                summary: Send WhatsApp Image message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    text: Get your message across!
                    imageUrl: https://www.example.com/image.png
              Send WhatsApp Audio message:
                summary: Send WhatsApp Audio message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    audioUrl: https://www.example.com/audio.ogg
              Send WhatsApp Video message:
                summary: Send WhatsApp Video message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    text: Get your message across!
                    videoUrl: https://www.example.com/video.mp4
              Send WhatsApp Document message:
                summary: Send WhatsApp Document message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    text: File caption
                    fileUrl: https://www.example.com/document.pdf
              Send WhatsApp Location message:
                summary: Send WhatsApp Location message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    locationName: Name of the location
                    address: Address name
                    longitude: 15.946519
                    latitude: 45.793337
              Send WhatsApp Contact message:
                summary: Send WhatsApp Contact message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  whatsApp:
                    contacts:
                    - addresses:
                      - street: Zadarska
                        city: Zagreb
                        zip: '1111'
                        country: Croatia
                        countryCode: '1111'
                        type: WORK
                      birthday: '2016-01-01'
                      emails:
                      - email: infobip@infobip.com
                        type: WORK
                      name:
                        firstName: First Name
                        lastName: Last Name
                        formattedName: Formatted Name
                      org:
                        company: Infobip
                      phones:
                      - phone: '41793026727'
                        type: WORK
                        waId: '1111'
                      urls:
                      - url: https://dev.infobip.com/omni-channel/omni-whatsapp-example
                        type: WORK
              Send OMNI LINE-SMS message:
                summary: Send OMNI LINE-SMS message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Line communication channel message is not delivered.
                  line:
                    text: This Line message will be delivered to Line application on the user device.
                    type: TEXT
              Send Line Image message:
                summary: Send Line Image message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Line communication channel message is not delivered.
                  line:
                    type: IMAGE
                    url: http://www.infobip.com/infobip-logo.png
                    thumbnailUrl: http://www.infobip.com/infobip-logo.png
              Send Line Audio message:
                summary: Send Line Audio message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Line communication channel message is not delivered.
                  line:
                    type: AUDIO
                    url: https://www.audioUrl.com
                    duration: 4000
              Send Line Video message:
                summary: Send Line Video message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Line communication channel message is not delivered.
                  line:
                    type: VIDEO
                    url: https://www.videoUrl.com
                    thumbnailUrl: https://www.thumbnailUrl.com
              Send Line Sticker message:
                summary: Send Line Sticker message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Line communication channel message is not delivered.
                  line:
                    type: STICKER
                    packageId: '1'
                    stickerId: '1'
              Send Kakao AlimTalk text message:
                summary: Send Kakao AlimTalk text message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Kakao AlimTalk communication channel message is not delivered.
                  kakaoAlim:
                    text: Get your message across!
                    templateCode: templateCode
                    title: Optional title of the message
              Send Kakao AlimTalk buttons message:
                summary: Send Kakao AlimTalk buttons message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Kakao AlimTalk communication channel message is not delivered.
                  kakaoAlim:
                    text: Get your message across!
                    templateCode: templateCode
                    buttons:
                    - buttonText: URL Button
                      buttonUrlMobile: https://www.infobip.com
                      buttonUrlPc: https://www.infobip.com
                      type: URL
                    - buttonText: App Link Button
                      androidScheme: androidApp://open
                      iosScheme: iosApp://open
                      buttonUrlMobile: https://www.infobip.com
                      buttonUrlPc: https://www.infobip.com
                      type: APP_LINK
              Send Kakao ChinguTalk text message:
                summary: Send Kakao ChinguTalk text message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Kakao ChinguTalk communication channel message is not delivered.
                  kakaoChingu:
                    text: Get your message across!
              Send Kakao ChinguTalk image message:
                summary: Send Kakao ChinguTalk image message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Kakao ChinguTalk communication channel message is not delivered.
                  kakaoChingu:
                    text: Get your message across!
                    imageUrl: https://www.example.com/image.png
              Send Kakao ChinguTalk buttons message:
                summary: Send Kakao ChinguTalk buttons message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This text will be received if Kakao ChinguTalk communication channel message is not delivered.
                  kakaoChingu:
                    text: Get your message across!
                    buttons:
                    - buttonText: URL Button
                      buttonUrl: https://www.infobip.com
                      type: URL
                    - buttonText: App Link Button
                      androidScheme: androidApp://open
                      iosScheme: iosApp://open
                      type: APP_LINK
                    - buttonText: Message Delivery Button
                      type: MESSAGE_DELIVERY
                    - buttonText: Bot Keyword Button
                      type: BOT_KEYWORD
              Send OMNI VKONTAKTE-SMS message:
                summary: Send OMNI VKONTAKTE-SMS message
                value:
                  scenarioKey: CC9F01A5DC7BEE2C2B829D203482A654
                  destinations:
                  - to:
                      phoneNumber: '41793026731'
                  sms:
                    text: This is the SMS failover message
                  vKontakte:
                    templateName: InfoVK_template
                    templateData:
                      parameter1: param1Value
                      parameter2: param2Value
          application/xml:
            schema:
              $ref: '#/components/schemas/04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest'
            examples:
              Send OMNI advanced message:
                summary: Send OMNI advanced message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <bulkId>BULK-ID-123-xyz</bulkId>\n  <destinations>\n    <destinations>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>\n        <phoneNumber>41793026727</phoneNumber>\n        <emailAddress>email@example.com</emailAddress>\n      </to>\n    </destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>Artık Ulusal Dil Tanımlayıcısı ile Türkçe karakterli smslerinizi rahatlıkla iletebilirsiniz.</text>\n    <transliteration>TURKISH</transliteration>\n    <language>\n      <languageCode>TR</languageCode>\n    </language>\n  </sms>\n  <viber>\n    <text>Or to have fun with Viber text.</text>\n  </viber>\n  <voice>\n    <text>Or make a call and read this text</text>\n  </voice>\n  <email>\n    <text>Finally, send an email.</text>\n    <subject>Email subject</subject>\n  </email>\n</OmniAdvancedRequest>\n"
              Send a scheduled OMNI message with a custom Validity period:
                summary: Send a scheduled OMNI message with a custom Validity period
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <destinations>\n    <destinations>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>\n        <phoneNumber>41793026727</phoneNumber>\n        <emailAddress>email@example.com</emailAddress>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>After one minute I'm trying to reach the user on SMS</text>\n    <validityPeriod>90</validityPeriod>\n    <validityPeriodTimeUnit>SECONDS</validityPeriodTimeUnit>\n  </sms>\n  <viber>\n    <text>Viber message is going first.</text>\n    <validityPeriod>1</validityPeriod>\n  </viber>\n  <email>\n    <text>Two and a half minutes (1 minute + 90 seconds) after the initial message I'm trying to reach the user on email for the next two hours.</text>\n    <validityPeriod>2</validityPeriod>\n    <validityPeriodTimeUnit>HOURS</validityPeriodTimeUnit>\n    <subject>Hey - turn on your mobile phone!</subject>\n  </email>\n  <sendAt>2021-05-24T10:45:38.000+0000</sendAt>\n</OmniAdvancedRequest>\n"
              Send OMNI PUSH-SMS message:
                summary: Send OMNI PUSH-SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <push>\n    <text>This PUSH message will pop up on your mobile device.</text>\n  </push>\n</OmniAdvancedRequest>\n"
              Send OMNI PUSH message with a custom payload:
                summary: Send OMNI PUSH message with a custom payload
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <push>\n    <text>This PUSH message will pop up on your mobile device.</text>\n    <customPayload>\n      <contentUrl>https://someurl.com/content</contentUrl>\n      <deepLink>myApp://some/link</deepLink>\n    </customPayload>\n  </push>\n</OmniAdvancedRequest>\n"
              Send OMNI PUSH message with notification options:
                summary: Send OMNI PUSH message with notification options
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <push>\n    <text>This PUSH message will pop up on your mobile device.</text>\n    <customPayload>\n      <contentUrl>https://someurl.com/content</contentUrl>\n      <deepLink>myApp://some/link</deepLink>\n    </customPayload>\n    <notificationOptions>\n      <vibrationEnabled>true</vibrationEnabled>\n      <soundEnabled>true</soundEnabled>\n      <soundName>sound.wav</soundName>\n      <badge>1</badge>\n      <contentUrl>http://www.mydomain.com/images/image1.jpg</contentUrl>\n      <category>mm_accept_decline</category>\n      <inAppStyle>MODAL</inAppStyle>\n      <title>This is some title</title>\n      <webViewUrl>http://someurl.com</webViewUrl>\n    </notificationOptions>\n    <targetOnlyPrimaryDevices>true</targetOnlyPrimaryDevices>\n    <includeNotificationsDisabledDevices>true</includeNotificationsDisabledDevices>\n    <personSubscriptions>\n      <personSubscriptions>receiveMarketingInfo</personSubscriptions>\n    </personSubscriptions>\n    <deviceSubscriptions>\n      <deviceSubscriptions>transactionFinished</deviceSubscriptions>\n    </deviceSubscriptions>\n  </push>\n</OmniAdvancedRequest>\n"
              Send OMNI SMS-EMAIL message:
                summary: Send OMNI SMS-EMAIL message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>AD9E01A5DC7BEE2C2B828D208182A611</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>385974241491</phoneNumber>\n        <emailAddress>john.smith@gmail.com</emailAddress>\n      </to>\n    </destinations>\n    <destinations>\n      <to>\n        <phoneNumber>38597213556611111</phoneNumber>\n        <emailAddress>jane.smith@gmail.com</emailAddress>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>Hello, we are happy to confirm your reservation for the safari trip.</text>\n    <validityPeriod>1</validityPeriod>\n  </sms>\n  <email>\n    <text>Hello, we are happy to confirm your reservation for the safari trip.</text>\n    <subject>Reservation confirmed!</subject>\n  </email>\n</OmniAdvancedRequest>\n"
              Send OMNI VIBER-SMS message:
                summary: Send OMNI VIBER-SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <viber>\n    <text>This Viber message will be delivered to Viber application on the user device.</text>\n  </viber>\n</OmniAdvancedRequest>\n"
              Send Rich Viber message:
                summary: Send Rich Viber message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received via SMS if Viber message is not delivered.</text>\n    <validityPeriod>1</validityPeriod>\n  </sms>\n  <viber>\n    <text>This Viber message will be delivered to Viber application on the user device.</text>\n    <validityPeriod>1</validityPeriod>\n    <imageURL>http://www.infobip.com/infobip-logo.png</imageURL>\n    <buttonText>More information</buttonText>\n    <buttonURL>http://www.infobip.com/</buttonURL>\n    <isPromotional>false</isPromotional>\n  </viber>\n</OmniAdvancedRequest>\n"
              Send OMNI WHATSAPP-SMS message:
                summary: Send OMNI WHATSAPP-SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <whatsApp>\n    <text>This Whatsapp message will be delivered to WhatsApp application on the user device.</text>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp template message:
                summary: Send WhatsApp template message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <templateName>template_name</templateName>\n    <templateData>\n      <templateData>Jennifer</templateData>\n      <templateData>$2543.56</templateData>\n    </templateData>\n    <language>en</language>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp media template message:
                summary: Send WhatsApp media template message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <templateName>media_template_name</templateName>\n    <mediaTemplateData>\n      <header>\n        <imageUrl>https://www.example.com/image.png</imageUrl>\n      </header>\n      <body>\n        <placeholders>\n          <placeholders>Jennifer</placeholders>\n          <placeholders>$2543.56</placeholders>\n        </placeholders>\n      </body>\n    </mediaTemplateData>\n    <language>en</language>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp media template message with quick reply buttons:
                summary: Send WhatsApp media template message with quick reply buttons
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <templateName>media_template_name</templateName>\n    <mediaTemplateData>\n      <header>\n        <imageUrl>https://www.infobip.com/infobip-logo.png</imageUrl>\n      </header>\n      <body>\n        <placeholders>\n          <placeholders>Jennifer</placeholders>\n          <placeholders>$2543.56</placeholders>\n        </placeholders>\n      </body>\n      <buttons>\n        <buttons>\n          <quickReplyPayload>button1</quickReplyPayload>\n        </buttons>\n        <buttons>\n          <quickReplyPayload>button2</quickReplyPayload>\n        </buttons>\n        <buttons>\n          <quickReplyPayload>button3</quickReplyPayload>\n        </buttons>\n      </buttons>\n    </mediaTemplateData>\n    <language>en</language>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp media template message with action button:
                summary: Send WhatsApp media template message with action button
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <templateName>media_template_name</templateName>\n    <mediaTemplateData>\n      <header>\n        <imageUrl>https://www.infobip.com/infobip-logo.png</imageUrl>\n      </header>\n      <body>\n        <placeholders>\n          <placeholders>Jennifer</placeholders>\n          <placeholders>$2543.56</placeholders>\n        </placeholders>\n      </body>\n      <buttons>\n        <buttons>\n          <urlPlaceholder>example1.pdf</urlPlaceholder>\n        </buttons>\n      </buttons>\n    </mediaTemplateData>\n    <language>en</language>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp text free form message:
                summary: Send WhatsApp text free form message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <text>This WhatsApp message will be delivered to WhatsApp application on the user device.</text>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Image message:
                summary: Send WhatsApp Image message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <text>Get your message across!</text>\n    <imageUrl>https://www.example.com/image.png</imageUrl>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Audio message:
                summary: Send WhatsApp Audio message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <audioUrl>https://www.example.com/audio.ogg</audioUrl>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Video message:
                summary: Send WhatsApp Video message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <text>Get your message across!</text>\n    <videoUrl>https://www.example.com/video.mp4</videoUrl>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Document message:
                summary: Send WhatsApp Document message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <text>File caption</text>\n    <fileUrl>https://www.example.com/document.pdf</fileUrl>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Location message:
                summary: Send WhatsApp Location message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <locationName>Name of the location</locationName>\n    <address>Address name</address>\n    <longitude>15.946519</longitude>\n    <latitude>45.793337</latitude>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send WhatsApp Contact message:
                summary: Send WhatsApp Contact message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <whatsApp>\n    <contacts>\n      <contacts>\n        <addresses>\n          <addresses>\n            <street>Zadarska</street>\n            <city>Zagreb</city>\n            <zip>1111</zip>\n            <country>Croatia</country>\n            <countryCode>1111</countryCode>\n            <type>WORK</type>\n          </addresses>\n        </addresses>\n        <birthday>2016-01-01</birthday>\n        <emails>\n          <emails>\n            <email>infobip@infobip.com</email>\n            <type>WORK</type>\n          </emails>\n        </emails>\n        <name>\n          <firstName>First Name</firstName>\n          <lastName>Last Name</lastName>\n          <formattedName>Formatted Name</formattedName>\n        </name>\n        <org>\n          <company>Infobip</company>\n        </org>\n        <phones>\n          <phones>\n            <phone>41793026727</phone>\n            <type>WORK</type>\n            <waId>1111</waId>\n          </phones>\n        </phones>\n        <urls>\n          <urls>\n            <url>https://dev.infobip.com/omni-channel/omni-whatsapp-example</url>\n            <type>WORK</type>\n          </urls>\n        </urls>\n      </contacts>\n    </contacts>\n  </whatsApp>\n</OmniAdvancedRequest>\n"
              Send OMNI LINE-SMS message:
                summary: Send OMNI LINE-SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Line communication channel message is not delivered.</text>\n  </sms>\n  <line>\n    <text>This Line message will be delivered to Line application on the user device.</text>\n    <type>TEXT</type>\n  </line>\n</OmniAdvancedRequest>\n"
              Send Line Image message:
                summary: Send Line Image message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Line communication channel message is not delivered.</text>\n  </sms>\n  <line>\n    <type>IMAGE</type>\n    <url>http://www.infobip.com/infobip-logo.png</url>\n    <thumbnailUrl>http://www.infobip.com/infobip-logo.png</thumbnailUrl>\n  </line>\n</OmniAdvancedRequest>\n"
              Send Line Audio message:
                summary: Send Line Audio message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Line communication channel message is not delivered.</text>\n  </sms>\n  <line>\n    <type>AUDIO</type>\n    <url>https://www.audioUrl.com</url>\n    <duration>4000</duration>\n  </line>\n</OmniAdvancedRequest>\n"
              Send Line Video message:
                summary: Send Line Video message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Line communication channel message is not delivered.</text>\n  </sms>\n  <line>\n    <type>VIDEO</type>\n    <url>https://www.videoUrl.com</url>\n    <thumbnailUrl>https://www.thumbnailUrl.com</thumbnailUrl>\n  </line>\n</OmniAdvancedRequest>\n"
              Send Line Sticker message:
                summary: Send Line Sticker message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Line communication channel message is not delivered.</text>\n  </sms>\n  <line>\n    <type>STICKER</type>\n    <packageId>1</packageId>\n    <stickerId>1</stickerId>\n  </line>\n</OmniAdvancedRequest>\n"
              Send Kakao AlimTalk text message:
                summary: Send Kakao AlimTalk text message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Kakao AlimTalk communication channel message is not delivered.</text>\n  </sms>\n  <kakaoAlim>\n    <text>Get your message across!</text>\n    <templateCode>templateCode</templateCode>\n    <title>Optional title of the message</title>\n  </kakaoAlim>\n</OmniAdvancedRequest>\n"
              Send Kakao AlimTalk buttons message:
                summary: Send Kakao AlimTalk buttons message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Kakao AlimTalk communication channel message is not delivered.</text>\n  </sms>\n  <kakaoAlim>\n    <text>Get your message across!</text>\n    <templateCode>templateCode</templateCode>\n    <buttons>\n      <buttons>\n        <buttonText>URL Button</buttonText>\n        <buttonUrlMobile>https://www.infobip.com</buttonUrlMobile>\n        <buttonUrlPc>https://www.infobip.com</buttonUrlPc>\n      </buttons>\n      <buttons>\n        <buttonText>App Link Button</buttonText>\n        <androidScheme>androidApp://open</androidScheme>\n        <iosScheme>iosApp://open</iosScheme>\n        <buttonUrlMobile>https://www.infobip.com</buttonUrlMobile>\n        <buttonUrlPc>https://www.infobip.com</buttonUrlPc>\n      </buttons>\n    </buttons>\n  </kakaoAlim>\n</OmniAdvancedRequest>\n"
              Send Kakao ChinguTalk text message:
                summary: Send Kakao ChinguTalk text message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Kakao ChinguTalk communication channel message is not delivered.</text>\n  </sms>\n  <kakaoChingu>\n    <text>Get your message across!</text>\n  </kakaoChingu>\n</OmniAdvancedRequest>\n"
              Send Kakao ChinguTalk image message:
                summary: Send Kakao ChinguTalk image message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Kakao ChinguTalk communication channel message is not delivered.</text>\n  </sms>\n  <kakaoChingu>\n    <text>Get your message across!</text>\n    <imageUrl>https://www.example.com/image.png</imageUrl>\n  </kakaoChingu>\n</OmniAdvancedRequest>\n"
              Send Kakao ChinguTalk buttons message:
                summary: Send Kakao ChinguTalk buttons message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This text will be received if Kakao ChinguTalk communication channel message is not delivered.</text>\n  </sms>\n  <kakaoChingu>\n    <text>Get your message across!</text>\n    <buttons>\n      <buttons>\n        <buttonText>URL Button</buttonText>\n        <buttonUrl>https://www.infobip.com</buttonUrl>\n      </buttons>\n      <buttons>\n        <buttonText>App Link Button</buttonText>\n        <androidScheme>androidApp://open</androidScheme>\n        <iosScheme>iosApp://open</iosScheme>\n      </buttons>\n      <buttons>\n        <buttonText>Message Delivery Button</buttonText>\n      </buttons>\n      <buttons>\n        <buttonText>Bot Keyword Button</buttonText>\n      </buttons>\n    </buttons>\n  </kakaoChingu>\n</OmniAdvancedRequest>\n"
              Send OMNI VKONTAKTE-SMS message:
                summary: Send OMNI VKONTAKTE-SMS message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><OmniAdvancedRequest>\n  <scenarioKey>CC9F01A5DC7BEE2C2B829D203482A654</scenarioKey>\n  <destinations>\n    <destinations>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n    </destinations>\n  </destinations>\n  <sms>\n    <text>This is the SMS failover message</text>\n  </sms>\n  <vKontakte>\n    <templateName>InfoVK_template</templateName>\n    <templateData>\n      <parameter2>param2Value</parameter2>\n      <parameter1>param1Value</parameter1>\n    </templateData>\n  </vKontakte>\n</OmniAdvancedRequest>\n"
        required: true
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse'
              examples:
                Response example for one destination:
                  summary: Response example for one destination
                  value:
                    messages:
                    - to:
                        phoneNumber: '41793026727'
                        emailAddress: email@example.com
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      messageId: efcd006b-af37-40e1-9984-09735bf45f17
                Response example for multiple destinations:
                  summary: Response example for multiple destinations
                  value:
                    bulkId: Bulk-ID-12xyz
                    messages:
                    - to:
                        phoneNumber: '41793026727'
                        emailAddress: email@example.com
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      messageId: MESSAGE-ID-123-xyz
                    - to:
                        phoneNumber: '41793026731'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      messageId: 4adbe74a-a600-47b3-9f2e-e410d3224843
            application/xml:
              schema:
                $ref: '#/components/schemas/8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse'
              examples:
                Response example for one destination:
                  summary: Response example for one destination
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniResponse>\n  <messages>\n    <message>\n      <to>\n        <phoneNumber>41793026727</phoneNumber>\n        <emailAddress>email@example.com</emailAddress>\n      </to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>7</id>\n        <name>PENDING_ENROUTE</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>efcd006b-af37-40e1-9984-09735bf45f17</messageId>\n    </message>\n  </messages>\n</omniResponse>\n"
                Response example for multiple destinations:
                  summary: Response example for multiple destinations
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniResponse>\n  <bulkId>Bulk-ID-12xyz</bulkId>\n  <messages>\n    <message>\n      <to>\n        <phoneNumber>41793026727</phoneNumber>\n        <emailAddress>email@example.com</emailAddress>\n      </to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>7</id>\n        <name>PENDING_ENROUTE</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n    </message>\n    <message>\n      <to>\n        <phoneNumber>41793026731</phoneNumber>\n      </to>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>7</id>\n        <name>PENDING_ENROUTE</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <messageId>4adbe74a-a600-47b3-9f2e-e410d3224843</messageId>\n    </message>\n  </messages>\n</omniResponse>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - omni-failover:message:send
      - omni-failover:manage
  /omni/1/reports:
    get:
      tags:
      - channels
      summary: Get OMNI failover delivery reports
      description: Get one-time delivery reports to see which channel was used to deliver the failover message.
      operationId: get-omni-failover-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximal number of messages in returned reports. Default value is __50__ and maximal value is __1000__.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: channel
        in: query
        description: Channel that was used for message delivering.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel'
        example: PUSH
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports'
              examples:
                Getting reports without any query parameter:
                  summary: Getting reports without any query parameter
                  value:
                    results:
                    - bulkId: bafdeb3d-719b-4cce-8762-54d47b40f3c5
                      messageId: 07e03aae-fabc-44ad-b1ce-222e14094d70
                      to: '41793026727'
                      sentAt: 2015-02-23T16:41:11.833+0000
                      doneAt: 2015-02-23T16:41:11.843+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.0104
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: VIBER
                    - bulkId: 06479ba3-5977-47f6-9346-fee0369bc76b
                      messageId: 1f21d8d7-f306-4f53-9f6e-eddfce9849ea
                      to: '41793026727'
                      sentAt: 2015-02-23T16:40:31.773+0000
                      doneAt: 2015-02-23T16:40:31.787+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: SMS
                Getting reports with PUSH channel as filter:
                  summary: Getting reports with PUSH channel as filter
                  value:
                    results:
                    - bulkId: bafdeb3d-719b-4cce-8762-54d47b40f3c5
                      messageId: 07e03aae-fabc-44ad-b1ce-222e14094d70
                      to: '41793026727'
                      sentAt: 2015-02-23T16:41:11.833+0000
                      doneAt: 2015-02-23T16:41:11.843+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: PUSH
                    - bulkId: 1dece649-6c8f-404e-8c6e-c7e073be509a
                      messageId: faa48fe6-fe2c-4f36-a43b-a070e2906ecb
                      to: '41793026727'
                      sentAt: 2015-02-23T15:22:37.413+0000
                      doneAt: 2015-02-23T15:22:37.437+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0
                        currency: EUR
                      status:
                        groupId: 2
                        groupName: UNDELIVERABLE
                        id: 9
                        name: UNDELIVERABLE_NOT_DELIVERED
                        description: Message sent not delivered
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      channel: PUSH
            application/xml:
              schema:
                $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports'
              examples:
                Getting reports without any query parameter:
                  summary: Getting reports without any query parameter
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniReportsResponse>\n  <results>\n    <result>\n      <bulkId>bafdeb3d-719b-4cce-8762-54d47b40f3c5</bulkId>\n      <messageId>07e03aae-fabc-44ad-b1ce-222e14094d70</messageId>\n      <to>41793026727</to>\n      <sentAt>2015-02-23T16:41:11.833+0000</sentAt>\n      <doneAt>2015-02-23T16:41:11.843+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.0104</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <channel>VIBER</channel>\n    </result>\n    <result>\n      <bulkId>06479ba3-5977-47f6-9346-fee0369bc76b</bulkId>\n      <messageId>1f21d8d7-f306-4f53-9f6e-eddfce9849ea</messageId>\n      <to>41793026727</to>\n      <sentAt>2015-02-23T16:40:31.773+0000</sentAt>\n      <doneAt>2015-02-23T16:40:31.787+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <channel>SMS</channel>\n    </result>\n  </results>\n</omniReportsResponse>\n"
                Getting reports with PUSH channel as filter:
                  summary: Getting reports with PUSH channel as filter
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniReportsResponse>\n  <results>\n    <result>\n      <bulkId>bafdeb3d-719b-4cce-8762-54d47b40f3c5</bulkId>\n      <messageId>07e03aae-fabc-44ad-b1ce-222e14094d70</messageId>\n      <to>41793026727</to>\n      <sentAt>2015-02-23T16:41:11.833+0000</sentAt>\n      <doneAt>2015-02-23T16:41:11.843+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <channel>PUSH</channel>\n    </result>\n    <result>\n      <bulkId>1dece649-6c8f-404e-8c6e-c7e073be509a</bulkId>\n      <messageId>faa48fe6-fe2c-4f36-a43b-a070e2906ecb</messageId>\n      <to>41793026727</to>\n      <sentAt>2015-02-23T15:22:37.413+0000</sentAt>\n      <doneAt>2015-02-23T15:22:37.437+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>2</groupId>\n        <groupName>UNDELIVERABLE</groupName>\n        <id>9</id>\n        <name>UNDELIVERABLE_NOT_DELIVERED</name>\n        <description>Message sent not delivered</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <channel>PUSH</channel>\n    </result>\n  </results>\n</omniReportsResponse>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - omni-failover:message:send
      - omni-failover:manage
  /omni/1/logs:
    get:
      tags:
      - channels
      summary: Get OMNI failover message logs
      description: If you need to show message logs in some GUI use this method. For message delivery status use [OMNI failover delivery reports](#programmable-communications/omni-failover/get-omni-failover-delivery-reports).
      operationId: get-omni-failover-message-logs
      parameters:
      - name: from
        in: query
        description: Sender that can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: DemoViberApp
      - name: to
        in: query
        description: The message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: 41793026727
      - 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: array
          items:
            type: string
        example: 1dece649-6c8f-404e-8c6e-c7e073be509a,bafdeb3d-719b-4cce-8762-54d47b40f3c5
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: 1,2,3
      - name: generalStatus
        in: query
        description: Sent message status group. Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IpCoreGeneralStatus'
      - name: channel
        in: query
        description: Channel that was used for message delivering.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel'
        example: PUSH
      - name: sentSince
        in: query
        description: Lower limit on date and time of sending messages.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2015-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: Upper limit on date and time of sending messages.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2015-02-22T17:44:05.390+01:00'
      - name: limit
        in: query
        description: Maximal number of messages in returned logs. Default value is __50__. Maximum value is __1000__.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: mcc
        in: query
        description: Mobile country code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: mnc
        in: query
        description: Mobile network code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse'
              examples:
                Getting logs without any query parameter:
                  summary: Getting logs without any query parameter
                  description: This request will return the last 50 message logs from the last 48h by default.
                  value:
                    results:
                    - bulkId: bafdeb3d-719b-4cce-8762-54d47b40f3c5
                      messageId: 07e03aae-fabc-44ad-b1ce-222e14094d70
                      to: '41793026727'
                      from: InfoSMS
                      text: Test SMS.
                      sentAt: 2015-02-23T16:41:11.833+0000
                      doneAt: 2015-02-23T16:41:11.843+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      channel: SMS
                    - bulkId: 06479ba3-5977-47f6-9346-fee0369bc76b
                      messageId: 1f21d8d7-f306-4f53-9f6e-eddfce9849ea
                      to: '41793026727'
                      from: Demo PUSH Application
                      text: Test PUSH message.
                      sentAt: 2015-02-23T16:40:31.773+0000
                      doneAt: 2015-02-23T16:40:31.787+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      channel: PUSH
                Getting logs with from, to and limit as filters:
                  summary: Getting logs with from, to and limit as filters
                  description: This request will filter last messages by the rule - all messages sent from `from`, return last `limit` messages with destinations `to`.
                  value:
                    results:
                    - bulkId: bafdeb3d-719b-4cce-8762-54d47b40f3c5
                      messageId: 07e03aae-fabc-44ad-b1ce-222e14094d70
                      to: '41793026727'
                      from: InfoSMS
                      text: Test SMS.
                      sentAt: 2015-02-23T16:41:11.833+0000
                      doneAt: 2015-02-23T16:41:11.843+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      channel: SMS
                    - bulkId: 06479ba3-5977-47f6-9346-fee0369bc76b
                      messageId: 1f21d8d7-f306-4f53-9f6e-eddfce9849ea
                      to: '41793026727'
                      from: Demo PUSH Application
                      text: Test PUSH message.
                      sentAt: 2015-02-23T16:40:31.773+0000
                      doneAt: 2015-02-23T16:40:31.787+0000
                      messageCount: 1
                      mccMnc: '22801'
                      price:
                        pricePerMessage: 0
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      channel: PUSH
            application/xml:
              schema:
                $ref: '#/components/schemas/1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse'
              examples:
                Getting logs without any query parameter:
                  summary: Getting logs without any query parameter
                  description: This request will return the last 50 message logs from the last 48h by default.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniLogsResponse>\n  <results>\n    <result>\n      <bulkId>bafdeb3d-719b-4cce-8762-54d47b40f3c5</bulkId>\n      <messageId>07e03aae-fabc-44ad-b1ce-222e14094d70</messageId>\n      <to>41793026727</to>\n      <from>InfoSMS</from>\n      <text>Test SMS.</text>\n      <sentAt>2015-02-23T16:41:11.833+0000</sentAt>\n      <doneAt>2015-02-23T16:41:11.843+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <channel>SMS</channel>\n    </result>\n    <result>\n      <bulkId>06479ba3-5977-47f6-9346-fee0369bc76b</bulkId>\n      <messageId>1f21d8d7-f306-4f53-9f6e-eddfce9849ea</messageId>\n      <to>41793026727</to>\n      <from>Demo PUSH Application</from>\n      <text>Test PUSH message.</text>\n      <sentAt>2015-02-23T16:40:31.773+0000</sentAt>\n      <doneAt>2015-02-23T16:40:31.787+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <channel>PUSH</channel>\n    </result>\n  </results>\n</omniLogsResponse>\n"
                Getting logs with from, to and limit as filters:
                  summary: Getting logs with from, to and limit as filters
                  description: This request will filter last messages by the rule - all messages sent from `from`, return last `limit` messages with destinations `to`.
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><omniLogsResponse>\n  <results>\n    <result>\n      <bulkId>bafdeb3d-719b-4cce-8762-54d47b40f3c5</bulkId>\n      <messageId>07e03aae-fabc-44ad-b1ce-222e14094d70</messageId>\n      <to>41793026727</to>\n      <from>InfoSMS</from>\n      <text>Test SMS.</text>\n      <sentAt>2015-02-23T16:41:11.833+0000</sentAt>\n      <doneAt>2015-02-23T16:41:11.843+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <channel>SMS</channel>\n    </result>\n    <result>\n      <bulkId>06479ba3-5977-47f6-9346-fee0369bc76b</bulkId>\n      <messageId>1f21d8d7-f306-4f53-9f6e-eddfce9849ea</messageId>\n      <to>41793026727</to>\n      <from>Demo PUSH Application</from>\n      <text>Test PUSH message.</text>\n      <sentAt>2015-02-23T16:40:31.773+0000</sentAt>\n      <doneAt>2015-02-23T16:40:31.787+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <channel>PUSH</channel>\n    </result>\n  </results>\n</omniLogsResponse>\n"
        '400':
          description: bad request responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              schema:
                $ref: '#/components/schemas/bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException'
              examples:
                Bad request:
                  summary: Bad request
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - omni-failover:logs:read
      - omni-failover:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /livechat/1/widgets/{widgetId}/sessions/{sessionId}:
    delete:
      tags:
      - channels
      summary: Invalidate customer session
      description: "This method enables you to invalidate an [authenticated Live Chat web session](https://www.infobip.com/docs/live-chat/users-and-authentication#web-authentication).\n      Session invalidation is performed whenever you wish to explicitly terminate an authenticated session, for example on user log out or due to security concerns."
      operationId: invalidate-customer-session
      parameters:
      - name: widgetId
        in: path
        description: Unique identifier of your widget. You can obtain the identifier from the [widget configuration page](https://portal.infobip.com/apps/livechat) or from the widget installation snippet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
      - name: sessionId
        in: path
        description: Unique identifier of user session to be invalidated. For more information on session identifiers, see the **SID** parameter in [personalization token](https://www.infobip.com/docs/live-chat/users-and-authentication#generate-the-personalization-token-web-authentication) documentation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - live-chat:manage
  /apple-mfb/1/messages:
    post:
      tags:
      - channels
      summary: Send Apple Messages for Business
      description: Send one or more messages to multiple recipients.
      externalDocs:
        description: Learn more about Apple Messages for Business channel and use cases
        url: https://www.infobip.com/docs/apple-messages-for-business
      operationId: send-apple-mfb-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest'
            examples:
              Text message example:
                summary: Text message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      text: Some text
                      type: TEXT
              Image message example:
                summary: Image message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: https://api.infobip.com/ott/1/media/testImage
                      type: IMAGE
              Image message with header and caption example:
                summary: Image message with header and caption example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: https://api.infobip.com/ott/1/media/testImage
                      header: Header
                      caption: Caption
                      type: IMAGE
              Video message example:
                summary: Video message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: http://my.domain/video.mp4
                      type: VIDEO
              Video message with header and caption example:
                summary: Video message with header and caption example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: http://my.domain/video.mp4
                      header: header
                      caption: caption
                      type: VIDEO
              Document message example:
                summary: Document message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: https://api.infobip.com/ott/1/media/testPdf
                      type: DOCUMENT
              Media message example:
                summary: Media message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      urls:
                      - https://api.infobip.com/ott/1/media/testImage
                      - http://my.domain/video.mp4
                      type: MEDIA
              Document message with header and caption example:
                summary: Document message with header and caption example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: https://api.infobip.com/ott/1/media/testPdf
                      header: header
                      caption: caption
                      type: DOCUMENT
              Text message with SMS failover:
                summary: Text message with SMS failover
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      text: Some text
                      type: TEXT
                    options:
                      smsFailover:
                        sender: InfoSMS
                        text: This is a failover message.
                        destinationMatching:
                        - initial: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                          failover: '41793026727'
              Rich link message example:
                summary: Rich link message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      linkUrl: http://my.domain/image.png
                      linkTitle: Sample Title
                      imageUrl: https://api.infobip.com/ott/1/media/testImage
                      videoUrl: http://my.domain/video.mp4
                      type: RICH_LINK
              App Clip message example:
                summary: App Clip message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      url: https://appclip.apple.com/id?=com.example.Clip&promotion=WWDC23
                      storeRegion: US
                      type: APP_CLIP
              Quick reply message example:
                summary: Quick reply message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      summaryText: Summary Text
                      items:
                      - identifier: identifier_1
                        title: Title 1
                      - identifier: identifier_2
                        title: Title 2
                      requestIdentifier: 1234-5678
                      type: QUICK_REPLY
              Form message example:
                summary: Form message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      data:
                        pages:
                        - items:
                          - identifier: id-a
                            title: Apples
                            value: apples
                          - identifier: id-o
                            title: Oranges
                            value: oranges
                          pageIdentifier: '0'
                          subtitle: Select what fruit you like
                          nextPageIdentifier: '1'
                          title: Food
                          submitForm: false
                          multipleSelection: true
                          type: SELECT
                        - pageIdentifier: '1'
                          subtitle: When were you born?
                          title: Birthday
                          submitForm: true
                          options:
                            dateFormat: MM/DD/YYYY
                            startDate: '2025-01-05'
                            maximumDate: '2025-01-10'
                            minimumDate: '2025-01-01'
                            labelText: Choose the date
                          type: DATE_PICKER
                        startPageIdentifier: '0'
                        private: true
                        showSummary: true
                      images:
                      - imageUrl: https://api.infobip.com/ott/1/media/testImage
                        identifier: imgIdScreen
                      requestIdentifier: requestId
                      receivedMessage:
                        style: ICON
                        title: Please fill out this form
                        subtitle: We really need this data
                        imageIdentifier: imgIdScreen
                      replyMessage:
                        style: ICON
                        title: Thank you!
                        subtitle: This will help improve our services
                        imageIdentifier: imgIdScreen
                      type: FORM
              Authentication request message example:
                summary: Authentication request message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    content:
                      images:
                      - imageUrl: https://api.infobip.com/ott/1/media/testImage
                        identifier: img1
                      requestIdentifier: 1234-5678
                      receivedMessage:
                        style: ICON
                        title: Please log in
                        subtitle: using LinkedIn
                        imageIdentifier: img1
                      replyMessage:
                        style: ICON
                        title: Successful login
                        subtitle: using LinkedIn
                        imageIdentifier: img1
                      scopes:
                      - r_liteprofile
                      type: AUTHENTICATION_REQUEST
              Invitation message example:
                summary: Invitation message example
                value:
                  messages:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: '48123456789'
                    content:
                      requestIdentifier: 1234-5678
                      templateId: binaryChoice.engage.noImage
                      locale: en-us
                      referenceId: 1009273616-A
                      placeholders:
                        brandName: testBrand
                      type: INVITATION
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: '1688025180464000013'
                    messages:
                    - messageId: '1688025180464000014'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
        '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
      - apple-mfb:message:send
      - apple-mfb:manage
  /apple-mfb/1/events:
    post:
      tags:
      - channels
      summary: Send Apple Events
      description: Send one or more events to multiple recipients.
      externalDocs:
        description: Learn more about Apple Messages for Business channel and use cases
        url: https://www.infobip.com/docs/apple-messages-for-business
      operationId: send-apple-mfb-event
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest'
            examples:
              Typing indicator event example:
                summary: Typing indicator event example
                value:
                  events:
                  - content:
                      typingIndicatorType: TYPING_START
                      type: TYPING_INDICATOR
                    sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    destinations:
                    - to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: '1688025180464000013'
                    messages:
                    - messageId: '1688025180464000014'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
        '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
      - apple-mfb:message:send
      - apple-mfb:manage
  /apple-mfb/1/reports:
    get:
      tags:
      - channels
      summary: Get Apple Messages for Business delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Apple Messages for Business channel and use cases
        url: https://www.infobip.com/docs/apple-messages-for-business
      operationId: get-outbound-apple-mfb-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports'
              examples:
                Delivery report:
                  summary: Delivery report
                  value:
                    results:
                    - bulkId: '1688025180464000013'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: '1688025180464000014'
                      to: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                      sender: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - apple-mfb:message:send
      - apple-mfb:manage
  /apple-mfb/1/logs:
    get:
      tags:
      - channels
      summary: Get message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-apple-mfb-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogResponseLogAppleMfbOutboundContent'
              examples:
                Log result:
                  summary: Log result
                  value:
                    results:
                    - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                      destination: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                      bulkId: '1688025180464000013'
                      messageId: '1688025180464000014'
                      sentAt: 2023-02-01T23:00:00.000+0000
                      doneAt: 2023-02-03T00:01:01.000+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Some text
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - apple-mfb:logs:read
      - apple-mfb:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /instagram/1/messages:
    post:
      tags:
      - channels
      summary: Send a Instagram message
      description: Send one or more messages to multiple recipients.
      externalDocs:
        description: Learn more about Instagram channel and use cases
        url: https://www.infobip.com/docs/instagram
      operationId: send-instagram-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c9f96abfad3f4dcf2c0a97ec8d627a73c6fe4ecaf776deaddf2ab2888baddbf.InstagramDmRequest'
            examples:
              Send an Instagram DM message:
                summary: Send an Instagram DM message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Hello!
                      type: TEXT
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ResponseEnvelopeMessageResponseMessageResponseDetails'
        '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
      - instagram:message:send
      - instagram:manage
      x-is-early-access: true
  /instagram/1/reports:
    get:
      tags:
      - channels
      summary: Get Instagram delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Instagram channel and use cases
        url: https://www.infobip.com/docs/instagram
      operationId: get-outbound-instagram-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '2034072219640523072'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      to: '66855538125'
                      sender: '44113496000'
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - instagram:message:send
      - instagram:manage
      x-is-early-access: true
  /instagram/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound Instagram message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-instagram-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogResponseLogInstagramDmOutboundContent'
              examples:
                Log results:
                  summary: Log results
                  value:
                    results:
                    - sender: '44113496000'
                      destination: '66855538125'
                      bulkId: '2034072219640523072'
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      sentAt: 2023-02-01T23:15:03.379+0000
                      doneAt: 2023-02-01T23:16:34.582+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Sent text
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - instagram:logs:read
      - instagram:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /messenger/1/messages:
    post:
      tags:
      - channels
      summary: Send a Messenger message
      description: Send one or more messages to multiple recipients. <br/> Marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will fail with an error.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: send-messenger-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookRequest'
            examples:
              Send a Messenger message:
                summary: Send a Messenger message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Hello!
                      type: TEXT
              Send a Messenger marketing message:
                summary: Send a Messenger marketing message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      campaignId: '120213234151570'
                      content:
                        payload:
                          text: Hello! Check out our latest offers.
                        type: TEXT
                      type: MARKETING_MESSAGE
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Messenger message response:
                  summary: Messenger message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messenger:message:send
      - messenger:manage
      x-is-early-access: true
  /messenger/1/reports:
    get:
      tags:
      - channels
      summary: Get Messenger delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: get-outbound-messenger-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '1688025180464000013'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: '1688025180464000014'
                      to: '66855538125'
                      sender: '44113496000'
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messenger:message:send
      - messenger:manage
      x-is-early-access: true
  /messenger/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound Messenger message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-messenger-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogResponseLogFacebookOutboundContent'
              examples:
                Log result:
                  summary: Log result
                  value:
                    results:
                    - sender: '44113496000'
                      destination: '66855538125'
                      bulkId: '1688025180464000013'
                      messageId: '1688025180464000014'
                      sentAt: 2023-02-01T23:15:03.379+0000
                      doneAt: 2023-02-01T23:16:34.582+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Sent text
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:logs:read
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /messenger/1/pages/{pageId}/subscriptions:
    get:
      tags:
      - channels
      summary: Get marketing subscriptions
      description: Get all messenger marketing subscriptions for single page. <br/> Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: get-messenger-marketing-subscriptions
      parameters:
      - name: pageId
        in: path
        description: Page ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 263213833541399
      responses:
        '200':
          description: List Of Marketing Subscriptions For Page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.PageMarketingSubscriptionResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Page Does Not Exist
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/campaigns:
    get:
      tags:
      - channels
      summary: Get campaigns
      description: Returns all Facebook Messenger marketing campaigns for the authenticated account.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: get-messenger-campaigns
      responses:
        '200':
          description: List of campaigns.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignsResponse'
              examples:
                Get campaigns:
                  summary: Get campaigns
                  value:
                    campaigns:
                    - id: '6938008105758'
                      name: Summer Sale Campaign
                      dailyBudget: 0
                      lifetimeBudget: 3000
                      adAccountId: '3339405976215927'
                      pageId: '975663645629834'
                      startTime: 2026-04-20T01:08:10-0700
                      endTime: 2026-05-20T01:08:09-0700
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create campaign
      description: Create a new Facebook Messenger marketing campaign to send marketing messages to opted-in users. The campaign is associated with your ad account and Facebook page.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: create-messenger-campaign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignRequest'
            examples:
              Create campaign:
                summary: Create campaign
                value:
                  name: Summer Sale Campaign
                  dailyBudget: 10000
                  adAccountId: ACT_123456789
                  pageId: '111111111111111'
        required: true
      responses:
        '201':
          description: Campaign created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/campaigns/{campaignId}:
    delete:
      tags:
      - channels
      summary: Delete campaign
      description: Delete an existing Facebook Messenger marketing campaign.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: delete-messenger-campaign
      parameters:
      - name: campaignId
        in: path
        description: Campaign ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 120213234151570
      responses:
        '204':
          description: Campaign deleted successfully.
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Campaign not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Campaign not found.
                    action: Please contact support
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/ad-accounts:
    get:
      tags:
      - channels
      summary: Get ad accounts
      description: Returns all Facebook ad accounts associated with the authenticated marketing account.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: get-messenger-ad-accounts
      responses:
        '200':
          description: List of ad accounts.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAdAccountsResponse'
              examples:
                Get ad accounts:
                  summary: Get ad accounts
                  value:
                    adAccounts:
                    - id: act_3339405976215927
                      status: ACTIVE
                      currency: USD
                      totalSpent: 186
                    - id: act_24785101717804792
                      status: ACTIVE
                      currency: INR
                      totalSpent: 38295
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/audiences:
    get:
      tags:
      - channels
      summary: Get audiences
      description: Retrieve all custom audiences for the given ad account.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: get-messenger-audiences
      parameters:
      - name: adAccountId
        in: query
        description: Facebook ad account ID.
        required: true
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: Audiences retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudiencesResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - channels
      summary: Create custom audience
      description: Create a new custom audience for marketing messages. Users can be uploaded to this audience to grow the marketing messages subscriber base.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: create-messenger-audience
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceRequest'
        required: true
      responses:
        '201':
          description: Audience created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/audiences/{audienceId}:
    delete:
      tags:
      - channels
      summary: Delete audience
      description: Delete a custom audience. This permanently removes the audience from Meta and stops any campaigns using it.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: delete-messenger-audience
      parameters:
      - name: audienceId
        in: path
        description: Meta custom audience ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: Audience deleted successfully.
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Audience not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Audience not found.
                    action: Please contact support
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/audiences/{audienceId}/users:
    post:
      tags:
      - channels
      summary: Upload users to audience
      description: Upload hashed user data (SHA-256) to a custom audience. Meta matches this data against its user database to grow your marketing messages subscriber base. Maximum 10,000 users per request.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: upload-messenger-audience-users
      parameters:
      - name: audienceId
        in: path
        description: Meta custom audience ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersRequest'
        required: true
      responses:
        '200':
          description: Users uploaded successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersResponse'
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Audience not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Audience not found.
                    action: Please contact support
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messenger/1/audiences/{audienceId}/users/{hashedPhoneNumber}:
    delete:
      tags:
      - channels
      summary: Remove user from audience
      description: Remove a single hashed phone number from a custom audience.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: remove-messenger-audience-user
      parameters:
      - name: audienceId
        in: path
        description: Meta custom audience ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: hashedPhoneNumber
        in: path
        description: SHA-256 hashed phone number to remove.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '204':
          description: User removed successfully.
        '400':
          description: Bad Request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Audience not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Audience not found.
                    action: Please contact support
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - messenger:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /kakao-alim/1/messages:
    post:
      tags:
      - channels
      summary: Send a Kakao Alim message
      description: Send one or more messages to multiple recipients.
      externalDocs:
        description: Learn more about Kakao Alim channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#alim-talk
      operationId: send-kakao-alim-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimRequest'
            examples:
              Send a Kakao Alim message:
                summary: Send a Kakao Alim message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      templateCode: '123'
                      text: Hello!
                      type: TEMPLATE
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Kakao Alim message response:
                  summary: Kakao Alim message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-alim/1/reports:
    get:
      tags:
      - channels
      summary: Get Kakao Alim delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Kakao Alim channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#alim-talk
      operationId: get-outbound-kakao-alim-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '2034072219640523072'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      to: '66855538125'
                      sender: '44113496000'
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-alim/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound Kakao Alim message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-kakao-alim-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogResponseLogKakaoAlimOutboundContent'
              examples:
                Log result:
                  summary: Log result
                  value:
                    results:
                    - sender: '44113496000'
                      destination: '66855538125'
                      bulkId: '2034072219640523072'
                      messageId: '105060206592105229'
                      sentAt: 2023-02-01T23:15:03.379+0000
                      doneAt: 2023-02-01T23:16:34.582+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        templateCode: '123'
                        text: Hello!
                        type: TEMPLATE
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:logs:read
      - kakao:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /kakao-sangdam/1/messages:
    post:
      tags:
      - channels
      summary: Send a Kakao Sangdam message
      description: Send one or more messages to multiple recipients.
      externalDocs:
        description: Learn more about Kakao Sangdam channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk
      operationId: send-kakao-sangdam-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamRequest'
            examples:
              Send a KAKAO SANGDAM message:
                summary: Send a KAKAO SANGDAM message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Hello!
                      type: TEXT
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                KAKAO SANGDAM message response:
                  summary: KAKAO SANGDAM message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-sangdam/1/reports:
    get:
      tags:
      - channels
      summary: Get Kakao Sangdam delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about Kakao Sangdam channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk
      operationId: get-outbound-kakao-sangdam-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: '1688025180464000013'
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: '1688025180464000014'
                      to: '66855538125'
                      sender: OFFICIAL-ACCOUNT-ID-123
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      mccMnc: '22801'
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-sangdam/1/logs:
    get:
      tags:
      - channels
      summary: Get outbound Kakao Sangdam message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-kakao-sangdam-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogResponseLogKakaoSangdamOutboundContent'
              examples:
                Log result:
                  summary: Log result
                  value:
                    results:
                    - sender: '44113496000'
                      destination: '66855538125'
                      bulkId: '2034072219640523072'
                      messageId: '105060206592105229'
                      sentAt: 2023-02-01T23:15:03.379+0000
                      doneAt: 2023-02-01T23:16:34.582+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.15
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Hello!
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:logs:read
      - kakao:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /kakao-chingu/1/messages:
    post:
      tags:
      - channels
      summary: Send a brand message
      description: 'Send one or more messages to multiple recipients.

        Kakao Chingu will be deprecated on January 1, 2026, and Brand Messaging will replace it. Make sure to adjust your API connection to use only new content types that include _FREE_FORM or _VARIABLE in the content type name.'
      externalDocs:
        description: Learn more about Kakao Chingu channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: send-kakao-chingu-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguRequest'
            examples:
              Send a free form text brand message:
                summary: Send a free form text brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Check out our latest offers!
                      buttons:
                      - name: Visit
                        urlPc: https://www.example.com
                        urlMobile: https://m.example.com
                        target: OUT
                        type: URL
                      - name: Open App
                        schemeAndroid: myapp://action
                        schemeIos: myapp://action
                        urlMobile: https://m.example.com
                        urlPc: https://www.example.com
                        type: APP_LINK
                      type: TEXT_FREE_FORM
              Send a free form image brand message:
                summary: Send a free form image brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Check out our new product!
                      image:
                        url: https://www.example.com/image.jpg
                      buttons:
                      - name: Shop Now
                        urlPc: https://www.example.com/shop
                        urlMobile: https://m.example.com/shop
                        target: OUT
                        type: URL
                      - name: Open App
                        schemeAndroid: myapp://product/123
                        schemeIos: myapp://product/123
                        urlMobile: https://m.example.com/product/123
                        urlPc: https://www.example.com/product/123
                        type: APP_LINK
                      type: IMAGE_FREE_FORM
              Send a free form wide image brand message:
                summary: Send a free form wide image brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      text: Discover our exclusive collection!
                      image:
                        url: https://www.example.com/wide-image.jpg
                      buttons:
                      - name: View
                        urlPc: https://www.example.com/collection
                        urlMobile: https://m.example.com/collection
                        target: OUT
                        type: URL
                      type: IMAGE_WIDE_FREE_FORM
              Send a free form item list brand message:
                summary: Send a free form item list brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      header: Top Products This Week
                      buttons:
                      - name: Shop All
                        urlPc: https://www.example.com/shop
                        urlMobile: https://m.example.com/shop
                        target: OUT
                        type: URL
                      itemList:
                      - title: Premium Coffee Beans
                        url: https://www.example.com/coffee.jpg
                        urlMobile: https://m.example.com/coffee
                        urlPC: https://www.example.com/coffee
                      - title: Organic Green Tea
                        url: https://www.example.com/tea.jpg
                        urlMobile: https://m.example.com/tea
                        urlPC: https://www.example.com/tea
                      - title: Artisan Chocolate
                        url: https://www.example.com/chocolate.jpg
                        urlMobile: https://m.example.com/chocolate
                        urlPC: https://www.example.com/chocolate
                      type: ITEM_LIST_FREE_FORM
                    options:
                      targeting: ALL_CONSENT
              Send a commerce free form brand message:
                summary: Send a commerce free form brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      commerce:
                        title: Premium Wireless Headphones
                        regularPrice: 199000
                        discountPrice: 159000
                        discountFixed: 40000
                        discountRate: 20
                      buttons:
                      - name: Buy Now
                        urlPc: https://www.example.com/buy/headphones
                        urlMobile: https://m.example.com/buy/headphones
                        target: OUT
                        type: URL
                      image:
                        url: https://www.example.com/headphones.jpg
                        link: https://www.example.com/product/headphones
                      additionalContent: Free shipping on orders over $50
                      coupon:
                        title:
                          couponTitleParameter: 30
                          type: PERCENTAGE_DISCOUNT_COUPON
                        description: Summer Sale
                        urlMobile: https://m.example.com/coupon/summer
                        urlPC: https://www.example.com/coupon/summer
                      type: COMMERCE_FREE_FORM
                    options:
                      targeting: ALL_CONSENT
              Send a carousel free form brand message:
                summary: Send a carousel free form brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      head:
                        header: Latest Updates
                        content: Discover our newest features and products
                        image:
                          url: https://www.example.com/carousel-intro.jpg
                        urlMobile: https://m.example.com/updates
                        urlPc: https://www.example.com/updates
                      elements:
                      - header: Summer Collection
                        message: Explore our vibrant summer styles with up to 30% off on selected items. Limited time offer!
                        attachment:
                          image:
                            url: https://www.example.com/summer.jpg
                          buttons:
                          - name: Shop Now
                            urlPc: https://www.example.com/summer
                            urlMobile: https://m.example.com/summer
                            target: OUT
                            type: URL
                          coupon:
                            title:
                              couponTitleParameter: 30
                              type: PERCENTAGE_DISCOUNT_COUPON
                            description: Summer Sale
                            urlMobile: https://m.example.com/coupon/summer
                            urlPC: https://www.example.com/coupon/summer
                      - header: Winter Preview
                        message: Get ready for the cold season with our cozy winter collection. Pre-order now for early bird discounts!
                        attachment:
                          image:
                            url: https://www.example.com/winter.jpg
                          buttons:
                          - name: Pre-order
                            urlPc: https://www.example.com/winter
                            urlMobile: https://m.example.com/winter
                            target: OUT
                            type: URL
                      tail:
                        schemeAndroid: See More
                        urlMobile: https://m.example.com/all-products
                        urlPc: https://www.example.com/all-products
                      type: CAROUSEL_FREE_FORM
                    options:
                      targeting: ALL_CONSENT
              Send a carousel commerce free form brand message:
                summary: Send a carousel commerce free form brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      head:
                        header: Special Offers
                        content: Check out our best deals today!
                        imageUrl: https://www.example.com/carousel-header.jpg
                        urlMobile: https://m.example.com/shop
                      elements:
                      - attachment:
                          image:
                            url: https://www.example.com/headphones.jpg
                            link: https://www.example.com/product/headphones
                          buttons:
                          - name: Buy Now
                            urlPc: https://www.example.com/buy/headphones
                            urlMobile: https://m.example.com/buy/headphones
                            target: OUT
                            type: URL
                          commerce:
                            title: Premium Wireless Headphones
                            regularPrice: 199000
                            discountPrice: 159000
                            discountFixed: 20
                          coupon:
                            title:
                              couponTitleParameter: 20
                              type: PERCENTAGE_DISCOUNT_COUPON
                            description: Save 20%
                            urlMobile: https://m.example.com/coupon
                            urlPC: https://www.example.com/coupon
                        additionalContent: Limited time offer - Free shipping
                      - attachment:
                          image:
                            url: https://www.example.com/smartwatch.jpg
                            link: https://www.example.com/product/smartwatch
                          buttons:
                          - name: View Now
                            urlPc: https://www.example.com/buy/smartwatch
                            urlMobile: https://m.example.com/buy/smartwatch
                            target: OUT
                            type: URL
                          commerce:
                            title: Smart Watch Series X
                            regularPrice: 350000
                            discountPrice: 280000
                            discountFixed: 20
                        additionalContent: Best seller - Extended warranty
                      tail:
                        urlMobile: https://m.example.com/shop/all
                      type: CAROUSEL_COMMERCE_FREE_FORM
                    options:
                      targeting: ALL_CONSENT
              Send a premium video free form brand message:
                summary: Send a premium video free form brand message
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      header: Sample header
                      content: Sample content
                      video:
                        videoUrl: https://www.example.com/premium-video.mp4
                        thumbnailUrl: https://www.example.com/video-thumbnail.jpg
                      button:
                        name: Watch
                        urlPc: https://www.example.com/watch
                        urlMobile: https://m.example.com/watch
                        target: OUT
                        type: URL
                      coupon:
                        title:
                          couponTitleParameter: 30
                          type: PERCENTAGE_DISCOUNT_COUPON
                        description: Summer Sale
                        urlMobile: https://m.example.com/coupon/summer
                        urlPC: https://www.example.com/coupon/summer
                      type: PREMIUM_VIDEO_FREE_FORM
                    options:
                      targeting: ALL_CONSENT
              Send a brand message text variable template:
                summary: Send a brand message text variable template
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      templateCode: templateCode123
                      messageData:
                        var1: name
                        var2: surname
                      buttonData:
                        buttonVar: www.example.com
                      couponData:
                        couponVar: Big discount
                      type: TEXT_VARIABLE
                    options:
                      targeting: TARGETED_FRIENDS
              Send a brand message item list variable template:
                summary: Send a brand message item list variable template
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      templateCode: templateCode123
                      messageData:
                        var1: Header text
                        var2: Item 1
                        var3: Item 2
                        var4: Item 3
                      buttonData:
                        var5: Button title
                        var6: https://button.url
                      couponData:
                        var7: Coupon description
                      imageData:
                      - img_url: https://www.example.com/sample.jpg
                      - img_url: https://www.example.com/sample.jpg
                      type: ITEM_LIST_VARIABLE
                    options:
                      targeting: TARGETED_FRIENDS
              Send a brand message image variable template:
                summary: Send a brand message image variable template
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      templateCode: templateCode123
                      messageData:
                        var1: name
                        var2: surname
                      buttonData:
                        buttonVar: www.example.com
                      couponData:
                        couponVar: Big discount
                      imageData:
                      - img_url: https://www.example.com/sample.jpg
                      type: IMAGE_VARIABLE
                    options:
                      targeting: TARGETED_FRIENDS
              Send a brand message wide image variable template:
                summary: Send a brand message wide image variable template
                value:
                  messages:
                  - sender: OFFICIAL-ACCOUNT-ID-123
                    destinations:
                    - to: '66855538125'
                    content:
                      templateCode: templateCode123
                      messageData:
                        var1: name
                        var2: surname
                      buttonData:
                        buttonVar: www.example.com
                      couponData:
                        couponVar: Big discount
                      imageData:
                      - img_url: https://www.example.com/sample.jpg
                      type: IMAGE_WIDE_VARIABLE
                    options:
                      targeting: TARGETED_FRIENDS
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Brand message response:
                  summary: Brand message response
                  value:
                    bulkId: '2034072219640523072'
                    messages:
                    - messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: '66855538125'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-chingu/1/reports:
    get:
      tags:
      - channels
      summary: Get brand message delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. Please note they will be returned only once.
      externalDocs:
        description: Learn more about brand message and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: get-outbound-kakao-chingu-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - kakao:message:send
      - kakao:manage
      x-is-early-access: true
  /kakao-chingu/1/logs:
    get:
      tags:
      - channels
      summary: Get message logs
      description: Use this method for displaying logs for example in the user interface. Available are the logs for the last 48 hours.
      operationId: get-outbound-kakao-chingu-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogResponseLogKakaoChinguOutboundContent'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:logs:read
      - kakao:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
  /kakao-brand-messages/1/templates:
    get:
      tags:
      - channels
      summary: Get Brand Message templates
      description: Get Brand Message templates with an optional time range filter to include only those modified within that period.
      externalDocs:
        description: Learn more about Kakao Chingu channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: get-brand-message-templates
      parameters:
      - name: senderKey
        in: query
        description: Sender profile key.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 40
          minLength: 0
        example: 123456789
      - name: senderGroupKey
        in: query
        description: Sender group profile key.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 40
          minLength: 0
      - name: since
        in: query
        description: Start date in format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Defaults to 1 hour before the time of the request.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: 2025-09-26T14:52:14.000+0200
      - name: page
        in: query
        description: Current page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 1
        example: 5
      - name: size
        in: query
        description: Number of items per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 100
          minimum: 1
        example: 10
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ModifiedTemplateResponse'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    results:
                    - templateCode: code_001
                    - templateCode: code_002
                    - templateCode: code_003
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:manage
      x-is-early-access: true
    post:
      tags:
      - channels
      summary: Create Brand Message template
      description: Create Brand Message template.
      externalDocs:
        description: Learn more about Kakao Chingu channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: create-brand-message-template
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest'
            examples:
              Text template with URL button:
                summary: Text template with URL button
                value:
                  sender: SENDER123
                  name: Sample name
                  isAdult: false
                  templateContent:
                    text: Sample text
                    buttons:
                    - name: ExName
                      urlMobile: https://m.example.com/deals
                      urlPc: https://example.com/deals
                      type: URL
                    type: TEXT
                x-label:
                  template type:
                  - TEXT
              Text template with multiple buttons:
                summary: Text template with multiple buttons
                value:
                  sender: SENDER123
                  name: Sample name
                  templateContent:
                    text: Sample text
                    buttons:
                    - name: Sample name
                      urlMobile: https://m.example.com
                      urlPc: https://example.com
                      type: URL
                    - name: sample name
                      schemeAndroid: myapp://home
                      schemeIos: myapp://home
                      urlMobile: https://m.example.com
                      urlPc: https://example.com
                      type: APP_LINK
                    - name: sample name
                      type: BOT_KEYWORD
                    - name: Sample name
                      type: MESSAGE_DELIVERY
                    type: TEXT
                x-label:
                  template type:
                  - TEXT
              Text template with coupon:
                summary: Text template with coupon
                value:
                  sender: SENDER123
                  name: Sample name
                  templateContent:
                    text: Sample coupon
                    coupon:
                      title:
                        couponTitle: Sample
                        type: FREE_COUPON
                      description: Sample
                      urlMobile: https://m.example.com/coupon
                      urlPc: https://example.com/coupon
                      schemeIos: myapp://coupon
                      schemeAndroid: myapp://coupon
                    type: TEXT
                x-label:
                  template type:
                  - TEXT
              Image template with button:
                summary: Image template with button
                value:
                  sender: SENDER123
                  name: Sample name
                  templateContent:
                    text: Sample text
                    image:
                      url: https://example.com/images/product.jpg
                    buttons:
                    - name: Sample name
                      urlMobile: https://m.shop.example.com/product/123
                      urlPc: https://shop.example.com/product/123
                      type: URL
                    type: IMAGE
                x-label:
                  template type:
                  - IMAGE
              Image template with multiple buttons:
                summary: Image template with multiple buttons
                value:
                  sender: SENDER123
                  name: Sample name
                  templateContent:
                    text: Sample text
                    image:
                      url: https://example.com/product.jpg
                    buttons:
                    - name: Ex Name
                      urlMobile: https://m.shop.example.com/new
                      urlPc: https://shop.example.com/new
                      type: URL
                    - name: Ex Name
                      type: BOT_KEYWORD
                    type: IMAGE
                x-label:
                  template type:
                  - IMAGE
              Image wide template:
                summary: Image wide template
                value:
                  sender: SENDER123
                  name: Wide Image Template
                  templateContent:
                    text: Sample text
                    image:
                      url: https://example.com/images/wide-banner.jpg
                    buttons:
                    - name: Sample name
                      urlMobile: https://m.example.com/info
                      urlPc: https://example.com/info
                      type: URL
                    type: IMAGE_WIDE
                x-label:
                  template type:
                  - IMAGE_WIDE
              Item list template:
                summary: Item list template
                value:
                  sender: SENDER123
                  name: Sample name
                  templateContent:
                    header: Sample item list header text
                    wide:
                      title: Main Element
                      imageUrl: https://example.com/image.jpg
                      urlMobile: https://example.com/main-product
                    wideList:
                    - title: Sub element 1
                      imageUrl: https://example.com/image.jpg
                      urlMobile: https://example.com/product1
                    - title: Sub element 2
                      imageUrl: https://example.com/image.jpg
                      urlMobile: https://example.com/product2
                    buttons:
                    - name: Sample btn
                      urlMobile: https://m.example.com/catalog
                      urlPc: https://example.com/catalog
                      type: URL
                    type: ITEM_LIST
                x-label:
                  template type:
                  - ITEM_LIST
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateResponse'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    templateCode: abcdh1234efgh5678
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: m
  /kakao-brand-messages/1/templates/single:
    get:
      tags:
      - channels
      summary: Get Brand Message template
      description: Get Brand Message template
      externalDocs:
        description: Learn more about Kakao Chingu channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: get-brand-message-template
      parameters:
      - name: sender
        in: query
        description: Must be provided if senderGroup is not provided.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 40
          minLength: 1
        example: 123456789
      - name: senderGroup
        in: query
        description: Must be provided if sender is not provided.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 40
          minLength: 1
      - name: templateCode
        in: query
        description: Template code.
        required: true
        style: form
        explode: true
        schema:
          type: string
          maxLength: 50
          minLength: 1
        example: abc123dfg345
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GetTemplateResponse'
              examples:
                Text template response:
                  summary: Text template response
                  value:
                    name: Sample name
                    templateContent:
                      text: Sample text
                      buttons:
                      - name: ExName
                        urlMobile: https://example.com/deals
                        urlPc: https://example.com/deals
                        type: URL
                      coupon:
                        title:
                          couponTitle: Sample
                          type: FREE_COUPON
                        description: Sample
                        urlMobile: https://m.example.com/coupon
                        urlPc: https://example.com/coupon
                        schemeIos: myapp://coupon
                        schemeAndroid: myapp://coupon
                      type: TEXT
                Image template response:
                  summary: Image template response
                  value:
                    name: Sample name
                    templateContent:
                      text: Sample text
                      image:
                        url: https://example.com/images/product.jpg
                      buttons:
                      - name: ExName
                        urlMobile: https://m.example.com/deals
                        urlPc: https://example.com/deals
                        type: URL
                      coupon:
                        title:
                          couponTitle: Sample
                          type: FREE_COUPON
                        description: Sample
                        urlMobile: https://m.example.com/coupon
                        urlPc: https://example.com/coupon
                        schemeIos: myapp://coupon
                        schemeAndroid: myapp://coupon
                      type: IMAGE
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: templateCode
                      violation: Template with provided ID does not exist.
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/kakao/chingu/kakao-brand-template-management
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:manage
      x-is-early-access: true
  /kakao-brand-messages/1/templates/{templateCode}:
    put:
      tags:
      - channels
      summary: Update Brand Message template
      description: Update an existing Brand Message template by template code.
      externalDocs:
        description: Learn more about Kakao Chingu channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: update-brand-message-template
      parameters:
      - name: templateCode
        in: path
        description: Template code to update.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: TEMPLATE_001
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest'
            examples:
              Update text template with URL button:
                summary: Update text template with URL button
                value:
                  sender: SENDER123
                  name: Updated template name
                  isAdult: false
                  templateContent:
                    text: Updated template text content
                    buttons:
                    - name: ExName
                      urlMobile: https://example.com/deals
                      urlPc: https://example.com/deals
                      type: URL
                    type: TEXT
              Update text template with coupon:
                summary: Update text template with coupon
                value:
                  sender: SENDER123
                  name: Updated coupon template
                  templateContent:
                    text: Updated coupon offer
                    coupon:
                      title:
                        couponTitle: Updated Coupon
                        type: FREE_COUPON
                      description: Updated coupon description
                      urlMobile: https://m.example.com/updated-coupon
                      urlPc: https://example.com/updated-coupon
                      schemeIos: myapp://updated-coupon
                      schemeAndroid: myapp://updated-coupon
                    type: TEXT
              Update image template with button:
                summary: Update image template with button
                value:
                  sender: SENDER123
                  name: Updated image template
                  templateContent:
                    text: Updated image template text
                    image:
                      url: https://example.com/images/updated-product.jpg
                    buttons:
                    - name: Sample name
                      urlMobile: https://shop.example.com/product/123
                      urlPc: https://shop.example.com/product/123
                      type: URL
                    type: IMAGE
              Update image wide template:
                summary: Update image wide template
                value:
                  sender: SENDER123
                  name: Updated Wide Image Template
                  templateContent:
                    text: Updated wide template text
                    image:
                      url: https://example.com/images/updated-wide-banner.jpg
                    buttons:
                    - name: Sample name
                      urlMobile: https://example.com/info
                      urlPc: https://example.com/info
                      type: URL
                    type: IMAGE_WIDE
              Update item list template:
                summary: Update item list template
                value:
                  sender: SENDER123
                  name: Updated item list template
                  templateContent:
                    header: Updated item list header text
                    wide:
                      title: Updated Main Element
                      imageUrl: https://example.com/updated-image.jpg
                      urlMobile: https://example.com/updated-main-product
                    wideList:
                    - title: Updated sub element 1
                      imageUrl: https://example.com/updated-image1.jpg
                      urlMobile: https://example.com/updated-product1
                    - title: Updated sub element 2
                      imageUrl: https://example.com/updated-image2.jpg
                      urlMobile: https://example.com/updated-product2
                    buttons:
                    - name: Sample name
                      urlMobile: https://example.com/info
                      urlPc: https://example.com/info
                      type: URL
                    type: ITEM_LIST
              Update text template with multiple buttons:
                summary: Update text template with multiple buttons
                value:
                  sender: SENDER123
                  name: Updated multi-button template
                  templateContent:
                    text: Updated template with multiple buttons
                    buttons:
                    - name: Sample name
                      urlMobile: https://example.com
                      urlPc: https://example.com
                      type: URL
                    - name: sample name
                      schemeAndroid: myapp://home
                      schemeIos: myapp://home
                      urlMobile: https://m.example.com
                      urlPc: https://example.com
                      type: APP_LINK
                    - name: Updated keyword
                      type: BOT_KEYWORD
                    - name: Updated message
                      type: MESSAGE_DELIVERY
                    type: TEXT
              Update image template with multiple buttons:
                summary: Update image template with multiple buttons
                value:
                  sender: SENDER123
                  name: Updated image with buttons
                  templateContent:
                    text: Updated image template text
                    image:
                      url: https://example.com/updated-product.jpg
                    buttons:
                    - name: Ex Name
                      urlMobile: https://shop.example.com/new
                      urlPc: https://shop.example.com/new
                      type: URL
                    - name: Updated Info
                      type: BOT_KEYWORD
                    type: IMAGE
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Template not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Response example:
                  summary: Response example
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: templateCode
                      violation: Template with provided ID does not exist.
                    resources:
                    - name: API documentation
                      url: https://www.infobip.com/docs/api/channels/kakao/chingu/kakao-brand-template-management
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - kakao:manage
      x-is-early-access: true
  /open-channel/1/messages/inbound:
    post:
      tags:
      - channels
      summary: Send Open Channel inbound message
      description: Sends a message to Open Channel destination registered on Infobip platform.
      operationId: send-open-channel-inbound-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponse'
              examples:
                Successful response:
                  summary: Successful response
                  description: Successful response
                  value:
                    status: MESSAGE_ACCEPTED
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Invalid sender:
                  summary: Invalid sender
                  description: Invalid sender
                  value:
                    errorCode: E404
                    description: Not found - request URL doesn't exist on the API server or resource is not found.
                    action: Check the resources and adjust your request.
                    violations:
                    - property: ''
                      violation: Destination sender ownership not found for account
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      x-is-early-access: true
  /tiktok/1/messages:
    post:
      tags:
      - channels
      summary: Send TikTok messages
      description: Send one or more text, image, or share-post messages to TikTok users in active conversations with your TikTok Business Account. You can send messages only after the user has messaged your Business Account first.
      externalDocs:
        description: Learn more about the TikTok channel and its use cases
        url: https://www.infobip.com/docs/tiktok
      operationId: send-tiktok-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokRequest'
            examples:
              Image message:
                summary: Image message
                value:
                  messages:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      mediaUrl: http://example.com/image.png
                      type: IMAGE
              Text message:
                summary: Text message
                value:
                  messages:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      text: sample text
                      type: TEXT
              Text message with reply:
                summary: Text message with reply
                value:
                  messages:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      text: sample reply text
                      replyToMessageId: '7199695882537746695'
                      type: TEXT
              Share post message:
                summary: Share post message
                value:
                  messages:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      postId: id123456789
                      type: SHARE_POST
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 7
                        name: PENDING_ENROUTE
                        description: Message sent to next instance
                      destination: u5NkbnslAgxpOelvH01Y+rs7Uw=
        '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
      - tiktok:message:send
      - tiktok:manage
      x-is-early-access: true
  /tiktok/1/events:
    post:
      tags:
      - channels
      summary: Send TikTok events
      description: Send typing indicator or mark-as-read events to TikTok users in active conversations with your TikTok Business Account.
      externalDocs:
        description: Learn more about the TikTok channel and its use cases
        url: https://www.infobip.com/docs/tiktok
      operationId: send-tiktok-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventRequest'
            examples:
              Typing indicator:
                summary: Typing indicator
                value:
                  events:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      type: TYPING_INDICATOR
              Mark as read:
                summary: Mark as read
                value:
                  events:
                  - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    destinations:
                    - to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    content:
                      type: MARK_AS_READ
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Success:
                  summary: Success
                  value:
                    bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    messages:
                    - messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: PENDING_ACCEPTED
                        description: Message sent to next instance
                      destination: u5NkbnslAgxpOelvH01Y+rs7Uw=
        '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
      - tiktok:message:send
      - tiktok:manage
      x-is-early-access: true
  /tiktok/1/reports:
    get:
      tags:
      - channels
      summary: Get TikTok delivery reports
      description: Use this endpoint to pull delivery reports when your endpoint does not receive real-time delivery reports. Each request returns the latest batch of delivery reports from the last 48 hours. Each report is returned only once.
      externalDocs:
        description: Learn more about the TikTok channel and its use cases
        url: https://www.infobip.com/docs/tiktok
      operationId: get-outbound-tiktok-message-delivery-reports
      parameters:
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports'
              examples:
                Delivery reports:
                  summary: Delivery reports
                  value:
                    results:
                    - bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                      sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - tiktok:message:send
      - tiktok:manage
      x-is-early-access: true
  /tiktok/1/logs:
    get:
      tags:
      - channels
      summary: Get TikTok message logs
      description: Use this endpoint to retrieve outbound TikTok message logs for display in a user interface. Logs are available for the last 48 hours.
      operationId: get-outbound-tiktok-message-logs
      parameters:
      - name: sender
        in: query
        description: The sender ID which can be alphanumeric or numeric.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: destination
        in: query
        description: Message destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: bulkId
        in: query
        description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: BULK-ID-123-xyz
      - name: messageId
        in: query
        description: Unique message ID for which a log is requested. May contain multiple comma-separated values. Maximum length 2048 characters.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: MESSAGE-ID-123-xyz,MESSAGE-ID-124-xyz
      - name: generalStatus
        in: query
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageGeneralStatus'
      - name: sentSince
        in: query
        description: 'The logs will only include messages sent after this date. Use it alongside sentUntil to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
        example: '2020-02-22T17:42:05.390+01:00'
      - name: sentUntil
        in: query
        description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          description: 'The logs will only include messages sent before this date. Use it alongside sentSince to specify a time range for the logs, but only up to the maximum limit of 1000 logs per call. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2020-02-23T17:42:05.39+01:00'
        example: '2020-02-23T17:42:05.390+01:00'
      - name: limit
        in: query
        description: Maximum number of messages to include in logs. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access logs for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message. May contain multiple comma-separated values.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: summersale
      - name: useCursor
        in: query
        description: Flag used to enable cursor-based pagination. When set to true, the system will use the cursor to fetch the next set of logs.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: cursor
        in: query
        description: Value which represents the current position in the data set. For the first request, this field shouldn't be defined. In subsequent requests, use the `nextCursor` value returned from the previous response to continue fetching data.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogResponseLogTikTokOutboundMessageContent'
              examples:
                Log result:
                  summary: Log result
                  value:
                    results:
                    - sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                      destination: u5NkbnslAgxpOelvH01Y+rs7Uw=
                      bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                      messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                      sentAt: 2023-09-26T10:52:15.457+0000
                      doneAt: 2023-09-26T10:52:15.799+0000
                      messageCount: 1
                      price:
                        pricePerMessage: 0.01
                        currency: EUR
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: promotional-traffic-entity
                        applicationId: marketing-automation-application
                      content:
                        text: Hello!
                        type: TEXT
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - tiktok:logs:read
      - tiktok:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 120
        numberOfTimeUnits: 0
        timeUnit: m
webhooks:
  receive-inbound-sms-messages:
    post:
      tags:
      - channels
      summary: Receive inbound SMS messages
      description: Receive SMS messages from your subscribers and have them delivered to you in real-time. To use this method, you’d need to:<ol><li><a href="https://www.infobip.com/docs/api/platform/numbers/phone-numbers/purchase-number">Buy a number</a> capable of receiving SMS traffic.</li><li>Specify a forwarding endpoint for the number and optionally configure other <a href="https://www.infobip.com/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration">inbound settings</a>.</li></ol>We will then send inbound messages to you as soon as they are delivered to us by a mobile network operator.<br>The name of a default format or renderer for the inbound SMS messages is `MO_JSON_2`, and is documented in this section.
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: receive-inbound-sms-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse'
            examples:
              Successful response:
                summary: Successful response
                description: Received SMS
                value:
                  results:
                  - messageId: '817790313235066447'
                    from: '385916242493'
                    to: '385921004026'
                    text: QUIZ Correct answer is Paris
                    cleanText: Correct answer is Paris
                    keyword: QUIZ
                    receivedAt: 2019-11-09T16:00:00.000+0000
                    smsCount: 1
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    callbackData: callbackData
                  messageCount: 1
                  pendingMessageCount: 1
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-sms-message-reports-v3:
    post:
      tags:
      - channels
      summary: Receive outbound SMS message reports
      description: 'For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint URL using the webhooks > delivery > url parameter. Alternatively, you can set the endpoint URL through the [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com. Please note that the default number of delivery reports in a single request is 100. You can customize this value by defining "maxBucketSize" using the [Subscription Management API](https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription).\

        You''ll receive this type of payload for messages sent using [Send SMS message](#channels/sms/send-sms-messages).'
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: receive-outbound-sms-message-report-v3
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value:
                  results:
                  - bulkId: BULK-ID-123-xyz
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: MESSAGE-ID-123-xyz
                    to: '41793026727'
                    sender: InfoSMS
                    sentAt: 2019-11-09T16:00:00.000+0100
                    doneAt: 2019-11-09T16:00:00.000+0100
                    messageCount: 1
                    callbackData: callbackData
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
                  - bulkId: BULK-ID-123-xyz
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                    to: '41793026834'
                    sender: InfoSMS
                    sentAt: 2019-11-09T17:00:00.000+0100
                    doneAt: 2019-11-09T17:00:00.000+0100
                    messageCount: 1
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>MESSAGE-ID-123-xyz</messageId>\n      <to>41793026727</to>\n      <sender>InfoSMS</sender>\n      <sentAt>2019-11-09T16:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <callbackData>callbackData</callbackData>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n    <result>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <to>41793026834</to>\n      <sender>InfoSMS</sender>\n      <sentAt>2019-11-09T17:00:00.000+0100</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-sms-tracking-notification:
    post:
      tags:
      - channels
      summary: Receive SMS tracking notifications
      description: For every message you send, we offer the option to send you clicked events. To enable this feature, you need to specify your endpoint URL either in the [tracking](https://www.infobip.com/docs/api/channels/sms/outbound-sms/send-sms-messages) or [urlOptions](https://www.infobip.com/docs/api/channels/sms/outbound-sms/send-sms-message) parameters when sending the SMS, or alternatively, configure it through [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com.<br/>Use this data to monitor user engagement, analyze campaign performance, and trigger automated workflows based on user interactions. For more details, visit our dedicated pages on [URL shortening](https://www.infobip.com/docs/url-shortening) and [tracking options](https://www.infobip.com/docs/url-shortening/tracking).
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: receive-sms-tracking-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlTrackingWebhook'
            examples:
              UrlTrackingWebhook:
                summary: UrlTrackingWebhook
                value:
                  notificationType: CLICKED
                  recipient: '41793026727'
                  url: https://www.google.com
                  sendDateTime: 1704106800000
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  bulkId: '17575032561857950495083'
                  callbackData: Callback data
                  recipientInfo:
                    deviceType: Phone
                    os: iOS 12
                    deviceName: Apple
                  geoLocationInfo:
                    countryName: United States
                    city: Los Angeles
                  applicationId: traffic-application
                  entityId: traffic-entity
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-sms-message-reports:
    post:
      tags:
      - channels
      summary: Receive outbound SMS message report
      description: 'For every message you send, we offer the option to receive a delivery report. To use this feature, you should set up an endpoint to receive these reports. You can specify the endpoint [when sending SMS](#programmable-communications/sms/send-sms-message). Alternatively, you can set the endpoint URL through the [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com. Please note that the default number of delivery reports in a single request is 100. You can customize this value by defining "maxBucketSize" using the [Subscription Management API](https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription).\

        You''ll receive this type of payload for messages sent using [Send SMS message](#channels/sms/send-sms-message) and [Send binary SMS message](#channels/sms/send-binary-sms-message).'
      externalDocs:
        description: Learn more about the SMS channel and its use cases
        url: https://www.infobip.com/docs/sms
      operationId: receive-outbound-sms-message-report
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: BULK-ID-123-xyz
                    messageId: MESSAGE-ID-123-xyz
                    to: '41793026727'
                    sentAt: 2019-11-09T16:00:00.000+0000
                    doneAt: 2019-11-09T16:00:00.000+0000
                    smsCount: 1
                    callbackData: callbackData
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: Ok
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    entityId: promotional-traffic-entity
                    applicationId: marketing-automation-application
                  - bulkId: BULK-ID-123-xyz
                    messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                    to: '41793026834'
                    sentAt: 2019-11-09T17:00:00.000+0000
                    doneAt: 2019-11-09T17:00:00.000+0000
                    smsCount: 1
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: Ok
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    applicationId: default
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      deprecated: true
  receive-inbound-mms-messages:
    post:
      tags:
      - channels
      summary: Receive inbound MMS messages
      description: If you want to receive MMS messages from your subscribers we can have them delivered to you in real time. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by specifying your endpoint and we will send inbound messages to you as soon as they are delivered to us by a mobile network operator.<br/>Name of the default format or renderer for the inbound MMS messages is `MO_MMS_2`, and is documented in this section.
      externalDocs:
        description: Learn more about the MMS channel and its use cases
        url: https://www.infobip.com/docs/mms
      operationId: receive-inbound-mms-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoWebhookRequest'
            examples:
              Received MMS (single):
                summary: Received MMS (single)
                value:
                  results:
                  - from: '41793026727'
                    to: '25256'
                    receivedAt: 2016-10-06T09:28:39.220+0000
                    messageId: '817790313235066447'
                    callbackData: Some custom data
                    userAgent: iPhone_12_Pro_Max_A2342
                    message:
                    - contentType: image/jpeg
                      url: https://examplelink.com/123456
                    - contentType: text/plain
                      value: This is message text
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received MMS (part of a group):
                summary: Received MMS (part of a group)
                value:
                  results:
                  - from: '41793026727'
                    to: '25256'
                    receivedAt: 2016-10-06T09:28:39.220+0000
                    messageId: '817790313235066447'
                    callbackData: Some custom data
                    userAgent: iPhone_12_Pro_Max_A2342
                    message:
                    - contentType: image/jpeg
                      url: https://examplelink.com/123456
                    - contentType: text/plain
                      value: This is message text
                    group:
                    - to: '25256'
                    - cc: '41793026888'
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-mms-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive MMS delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help. You'll receive this type of payload for messages sent using [Send MMS messages](https://www.infobip.com/docs/api/channels/mms/send-mms-messages) endpoint.
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: receive-outbound-mms-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '3746923784'
                    price:
                      pricePerMessage: 1
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    messageId: 43u2ih-6453jbh-897kfs90u2nj
                    sender: '441134960000'
                    sentAt: 2026-07-07T06:32:15.101+0000
                    doneAt: 2026-07-07T06:32:15.101+0000
                    messageCount: 3
          application/xml:
            schema:
              $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>3746923784</bulkId>\n      <price>\n        <pricePerMessage>1</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <messageId>43u2ih-6453jbh-897kfs90u2nj</messageId>\n      <sender>441134960000</sender>\n      <sentAt>2026-07-07T06:32:15.101+0000</sentAt>\n      <doneAt>2026-07-07T06:32:15.101+0000</doneAt>\n      <messageCount>3</messageCount>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-mms-message-reports:
    post:
      tags:
      - channels
      summary: Receive outbound MMS message report
      description: For each MMS that you send out, we can send you a message delivery report. All you need to do is specify your endpoint [when sending MMS](#programmable-communications/mms/send-sms-message) and we will deliver a [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes) report to you in real time. You'll receive this type of payload for messages sent using [Send single MMS message](https://www.infobip.com/docs/api/channels/mms/send-mms-single-message) or [Send MMS message](https://www.infobip.com/docs/api/channels/mms/send-mms-message) endpoints.
      externalDocs:
        description: Learn more about the MMS channel and its use cases
        url: https://www.infobip.com/docs/mms
      operationId: receive-outbound-mms-message-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/243664b2993460e9e9a3aa6c63ab422a58e22db15efe4cb007ed315aff543dd9.MmsReportRequest'
            examples:
              Received report:
                summary: Received report
                value:
                  results:
                  - bulkId: BULK-ID-123-xyz
                    messageId: 45db39c3-7822-4e72-a3ec-c87442c0ffz9
                    to: '41793026727'
                    sentAt: 2019-11-09T16:00:00.000+0000
                    doneAt: 2019-11-09T16:00:00.000+0000
                    smsCount: 1
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    entityId: my-entity-id
                    applicationId: my-application-id
                  - bulkId: BULK-ID-123-xyz
                    messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                    to: '41793026834'
                    sentAt: 2019-11-09T17:00:00.000+0000
                    doneAt: 2019-11-09T17:00:00.000+0000
                    smsCount: 1
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    entityId: my-entity-id
                    applicationId: my-application-id
          application/xml:
            schema:
              $ref: '#/components/schemas/243664b2993460e9e9a3aa6c63ab422a58e22db15efe4cb007ed315aff543dd9.MmsReportRequest'
            examples:
              Received report:
                summary: Received report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MmsReportRequest>\n  <results>\n    <results>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>45db39c3-7822-4e72-a3ec-c87442c0ffz9</messageId>\n      <to>41793026727</to>\n      <sentAt>2019-11-09T16:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <price>\n        <pricePerMessage>0.01000000000000000020816681711721685132943093776702880859375</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <entityId>my-entity-id</entityId>\n      <applicationId>my-application-id</applicationId>\n    </results>\n    <results>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <to>41793026834</to>\n      <sentAt>2019-11-09T17:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0000</doneAt>\n      <smsCount>1</smsCount>\n      <price>\n        <pricePerMessage>0.01000000000000000020816681711721685132943093776702880859375</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <entityId>my-entity-id</entityId>\n      <applicationId>my-application-id</applicationId>\n    </results>\n  </results>\n</MmsReportRequest>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      deprecated: true
  receive-mms-tracking-notification:
    post:
      tags:
      - channels
      summary: Receive MMS tracking notifications
      description: For every message you send, we offer the option to send you clicked events. To enable this feature, you need to specify your endpoint URL in [tracking](https://www.infobip.com/docs/api/channels/mms/send-mms-messages) parameters when sending the MMS, or alternatively, configure it through [Subscriptions management](https://www.infobip.com/docs/cpaas-x/subscriptions-management). If you need assistance with this process, please contact support@infobip.com.<br/>Use this data to monitor user engagement, analyze campaign performance, and trigger automated workflows based on user interactions. For more details, visit our dedicated pages on [URL shortening](https://www.infobip.com/docs/url-shortening) and [tracking options](https://www.infobip.com/docs/url-shortening/tracking).
      externalDocs:
        description: Learn more about MMS channel and use cases
        url: https://www.infobip.com/docs/mms
      operationId: receive-mms-tracking-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlTrackingWebhook'
            examples:
              UrlTrackingWebhook:
                summary: UrlTrackingWebhook
                value:
                  notificationType: CLICKED
                  recipient: '41793026727'
                  url: https://www.google.com
                  sendDateTime: 1704106800000
                  messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                  bulkId: '17575032561857950495083'
                  callbackData: Callback data
                  recipientInfo:
                    deviceType: Phone
                    os: iOS 12
                    deviceName: Apple
                  geoLocationInfo:
                    countryName: United States
                    city: Los Angeles
                  applicationId: traffic-application
                  entityId: traffic-entity
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  calls-event-webhook:
    post:
      tags:
      - channels
      summary: Event Webhook
      description: Webhook triggered when there is any new event on platform that your application should handle.
      operationId: calls-event-webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-markup-language-instructions:
    post:
      tags:
      - channels
      summary: Markup callback API
      description: "Upon receiving a call to the Calls Markup Language, the Infobip platform generates a request to the **markupUrl** you set up \nin the Markup Language configuration. This request will contain Markup Language instructions which dictates call flow."
      operationId: markup-language-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  receive-markup-language-error:
    post:
      tags:
      - channels
      summary: Error callback API
      description: "When the Infobip platform fails to retrieve or execute Markup Language instructions, it generates a request to the \n**errorUrl** you set up in the Markup Language configuration. The request carries the call context together with the \nerror code and details that describe the failure."
      operationId: markup-language-error-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.ErrorCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  receive-markup-language-record:
    post:
      tags:
      - channels
      summary: Record callback API
      description: "When the Infobip platform stops a call recording produced by a Record instruction, \nit generates a request to the callback URL configured on that Record instruction. The request carries the call context \ntogether with the recorded file identifier and the current recording status."
      operationId: markup-language-record-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  receive-markup-language-capture-dtmf:
    post:
      tags:
      - channels
      summary: Capture DTMF callback API
      description: "When the Infobip platform finishes collecting DTMF input requested by a CaptureDtmf instruction, it generates a request \nto the callback URL configured on that CaptureDtmf instruction. The request carries the call context together with the \ncaptured DTMF sequence."
      operationId: markup-language-capture-dtmf-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.CaptureDtmfCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  fetch-markup-language:
    post:
      tags:
      - channels
      summary: Fetch callback API
      description: "When the Infobip platform executes a Fetch instruction, it generates a request to the **url** you set up in the \nFetch instruction. The request carries the call context together with the fetch instruction details."
      operationId: markup-language-fetch-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  send-machine-detection-callback:
    post:
      tags:
      - channels
      summary: Machine detection callback API
      description: "When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the \nmachine detection result."
      operationId: markup-language-machine-detection-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  dial-callback:
    post:
      tags:
      - channels
      summary: Dial callback API
      description: "When the Infobip platform finishes processing a dial endpoint requested by a Dial instruction, it generates a request \nto the callback URL configured on that Dial instruction. The request carries the call context together with the \ndial endpoint result."
      operationId: markup-language-dial-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.DialCallbackRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse'
  send-machine-detection-async-callback:
    post:
      tags:
      - channels
      summary: Machine detection async callback API
      description: "When the Infobip platform finishes machine detection requested by a MachineDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl). The request carries the call context together with the \nmachine detection result."
      operationId: markup-language-machine-detection-async-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  send-machine-message-detection-async-callback:
    post:
      tags:
      - channels
      summary: Machine message detection callback API
      description: "When the Infobip platform finishes machine message detection requested by a MachineMessageDetection instruction, it generates a request \nto the callback URL configured on Markup Language configuration (markupUrl) The request carries the call context together with the \nmachine message detection result."
      operationId: markup-language-machine-message-detection-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineMessageDetectionCallbackRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  send-recording-status-callback:
    post:
      tags:
      - channels
      summary: Recording status callback API
      description: "When the Infobip platform finishes processing a recording requested by a Record instruction, it generates a request \nto the callback URL configured on Record or StartRecording instruction. The request carries the call context together with the \nrecording status."
      operationId: markup-language-recording-status-callback
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordingStatusCallbackRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-voice-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Voice Delivery Reports
      description: We can send you delivery reports for Voice messages, outbound IVR, Click-to-call or Markup Language in real time. All you need to do is specify notifyUrl in your endpoint when using some of these features and we will deliver a [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes) report to your platform.
      operationId: receive-voice-delivery-reports
      requestBody:
        content:
          text/plain:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
            examples:
              Report example:
                summary: Report example
                value:
                  results:
                  - bulkId: 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb
                    messageId: ff4804ef-6ab6-4abd-984d-ab3b1387e852
                    from: '385333444'
                    to: '385981178'
                    sentAt: 2018-06-25T13:38:14.730+0000
                    mccMnc: '21901'
                    callbackData: DLR callback data
                    voiceCall:
                      feature: Voice-message
                      startTime: 2018-06-25T13:38:15.000+0000
                      answerTime: 2018-06-25T13:38:25.000+0000
                      endTime: 2018-06-25T13:38:28.316+0000
                      duration: 10
                      chargedDuration: 30
                      fileDuration: 19.3
                      dtmfCodes: '1'
                      ivr:
                        scenarioId: '333'
                        scenarioName: Scenario name
                        collectedDtmfs: '{"myFirstVar":"3","mySecondVar":"8"}'
                    price:
                      pricePerSecond: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 5000
                      name: VOICE_ANSWERED
                      description: Call answered by human
                      permanent: true
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
            examples:
              Report example:
                summary: Report example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n  <results>\n    <results>\n      <bulkId>8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb</bulkId>\n      <messageId>ff4804ef-6ab6-4abd-984d-ab3b1387e852</messageId>\n      <from>385333444</from>\n      <to>385981178</to>\n      <sentAt>2018-06-25T13:38:14.730+0000</sentAt>\n      <mccMnc>21901</mccMnc>\n      <callbackData>DLR callback data</callbackData>\n      <voiceCall>\n        <feature>Voice-message</feature>\n        <startTime>2018-06-25T13:38:15.000+0000</startTime>\n        <answerTime>2018-06-25T13:38:25.000+0000</answerTime>\n        <endTime>2018-06-25T13:38:28.316+0000</endTime>\n        <duration>10</duration>\n        <chargedDuration>30</chargedDuration>\n        <fileDuration>19.3</fileDuration>\n        <dtmfCodes>1</dtmfCodes>\n        <ivr>\n          <scenarioId>333</scenarioId>\n          <scenarioName>Scenario name</scenarioName>\n          <collectedDtmfs>{\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}</collectedDtmfs>\n        </ivr>\n      </voiceCall>\n      <price>\n        <pricePerSecond>0.01</pricePerSecond>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>5000</id>\n        <name>VOICE_ANSWERED</name>\n        <description>Call answered by human</description>\n        <permanent>true</permanent>\n      </error>\n    </results>\n  </results>\n</reportResponse>\n"
          text/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
          text/csv:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  deprecated-receive-voice-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Voice Delivery Reports
      description: This version is deprecated as of July 1st 2020, meaning no fixes/updates will be provided and no new parameters will be added.<br/><br/>We strongly advise you to update to new [delivery report method](#programmable-communications/voice/receive-voice-delivery-reports).
      operationId: receive-voice-delivery-reports-deprecated
      requestBody:
        content:
          text/plain:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
            examples:
              Report example:
                summary: Report example
                value:
                  results:
                  - bulkId: 8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb
                    messageId: ff4804ef-6ab6-4abd-984d-ab3b1387e852
                    to: '385981178'
                    sentAt: 2020-04-22T02:18:30.205+0000
                    doneAt: 2020-04-22T02:19:02.355+0000
                    startTime: 1587521910000
                    endTime: 1587521932224
                    answerTime: 1587521917000
                    duration: 14
                    fileDuration: 19.3
                    mccMnc: '21901'
                    callbackData: DLR callback data
                    dtmfCodes: '1'
                    dtmfCodesAsJson: '{"myFirstVar":"3","mySecondVar":"8"}'
                    transcribedAudioFileUrl: /tts/3/transcriptions/message-id/38761333444
                    scenarioId: '333'
                    scenarioName: Scenario name
                    price:
                      pricePerSecond: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 5000
                      name: VOICE_ANSWERED
                      description: Call answered by human
                      permanent: true
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
            examples:
              Report example:
                summary: Report example
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><reportResponse>\n  <results>\n    <results>\n      <bulkId>8c20f086-d82b-48cc-b2b3-3ca5f7aca9fb</bulkId>\n      <messageId>ff4804ef-6ab6-4abd-984d-ab3b1387e852</messageId>\n      <to>385981178</to>\n      <sentAt>2018-06-25T13:38:14.730+0000</sentAt>\n      <sentAt>2018-06-25T13:38:14.830+0000</sentAt>\n      <startTime>2018-06-25T13:38:15.000+0000</startTime>\n      <answerTime>2018-06-25T13:38:25.000+0000</answerTime>\n      <endTime>2018-06-25T13:38:28.316+0000</endTime>\n      <duration>10</duration>\n      <fileDuration>19.3</fileDuration>\n      <mccMnc>21901</mccMnc>\n      <callbackData>DLRcallbackdata</callbackData>\n      <dtmfCodes>1</dtmfCodes>\n      <dtmfCodesAsJson>{\"myFirstVar\":\"3\",\"mySecondVar\":\"8\"}</dtmfCodesAsJson>\n      <transcribedAudioFileUrl>/tts/3/transcriptions/message-id/38761333444</transcribedAudioFileUrl>\n      <scenarioId>333</scenarioId>\n      <scenarioName>Scenarioname</scenarioName>\n      <price>\n        <pricePerSecond>0.01</pricePerSecond>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Messagedeliveredtohandset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>5000</id>\n        <name>VOICE_ANSWERED</name>\n        <description>Callansweredbyhuman</description>\n        <permanent>true</permanent>\n      </error>\n    </results>\n  </results>\n</reportResponse>\n"
          text/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
          text/csv:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
          application/x-www-form-urlencoded:
            schema:
              allOf:
              - $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse'
      responses:
        '200':
          description: Your server returns this code, if it accepts the callback.
      deprecated: true
  receive-number-masking-target:
    post:
      tags:
      - channels
      summary: Number Masking callback API
      description: "Upon receiving a call to the Number Masking number, Infobip platform generates a request to the **callbackUrl** you set up \nin the NM configuration. This request will contain the callee number and the Voice number that's called. We also provide \n**correlationID** and **nmCorrelationID** to be used as identifiers for this call request.\n\nIn return from your platform, Infobip platform expects to receive the phone number needed to forward the call to and caller ID  \nthat should be presented. Caller ID representation depends on the voice connection capabilities in a particular region. Instead of the number, \nyou could also send a parameter **audio** so we would play an audio file that was previously uploaded to our platform \n[(Audio file upload)](#customer-engagement/anonymize/upload-audio-files) or hosted on your server. Also, you can send a \nparameter **captureDtmf** to play audio file and start capturing DTMF input that will be sent as `from` field in the new callback request.\n"
      operationId: provide-number-masking-target
      parameters:
      - name: Authorization
        in: header
        description: For more details check [Secure your communication](https://www.infobip.com/docs/voice-and-video/number-masking).
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: 'Authorization: <token>'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/59ad711434aad6c39708ffc0bab084b409f8c1de0ab1fd0cfa66aa965f740ee4.CallbackRequest'
            examples:
              Callback request:
                summary: Callback request
                value:
                  from: '41793026727'
                  to: '41793026731'
                  correlationId: 0f754338-1aff-4e09-a933-7d205ca7aed4
                  nmCorrelationId: 7cb72e4b-cf9f-40b6-9fc4-79588d18a666
              Callback request after captureDtmf command:
                summary: Callback request after captureDtmf command
                value:
                  from: '41228755825'
                  to: '41793026731'
                  correlationId: 0f754338-1aff-4e09-a933-7d205ca7aed4
                  nmCorrelationId: 7cb72e4b-cf9f-40b6-9fc4-79588d18a666
                  dtmfCaptured: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse'
              examples:
                Audio command response:
                  summary: Audio command response
                  value:
                    fileUrl: http://www.audioFileUrl.mp3
                Dial command response:
                  summary: Dial command response
                  value:
                    phoneNumber: '41792212112121'
                    callerId: '41793026731'
                    announcements:
                      caller:
                        fileUrl: http://www.audioFileUrl.mp3
                      callee:
                        fileId: f9850667-86c8-48d3-a9b2-9a6a372f5d00
                    recording:
                      enabled: true
                      recordCalleeAnnouncement: true
                    machineDetection:
                      enabled: true
                      detectionTime: 0.0
                      hangupOnMachineDetection: true
                    clientReferenceId: 7e8d64c0-6c72-4922-aa96-48728753c660
                Capture dtmf command response:
                  summary: Capture dtmf command response
                  value:
                    fileUrl: http://www.audioFileUrl.mp3
                    timeout: 5000
  receive-masked-call-report:
    post:
      tags:
      - channels
      summary: Number Masking status API
      description: "After a received call to the Number Masking number has finished, Infobip platform generates a request to your **statusURL** \nset up in the NM configuration. This request contains report details of the call. We also provide the **correlationID** and \n**nmCorrelationID** to be used as identifiers for this call request.\n\nIn return from your platform, Infobip platform expects a confirmation that the request has been received successfully.\n"
      operationId: receive-masked-call-report
      parameters:
      - name: Authorization
        in: header
        description: For more details check [Secure your communication](https://www.infobip.com/docs/voice-and-video/number-masking).
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: 'Authorization: <token>'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9ddf5548c4806a579a37575477f73704a9d1f23ccda5d683f70483437522f25d.StatusRequest'
            examples:
              Status request:
                summary: Status request
                value:
                  action: dial
                  from: '41793026727'
                  to: '41793026731'
                  transferTo: '41793026785'
                  duration: 15
                  status: answered
                  nmCorrelationId: 7cb72e4b-cf9f-40b6-9fc4-79588d18a666
                  ringingTime: '2018-01-01 12:00:00'
                  answeredTime: '2018-01-01 12:00:10'
                  correlationId: 0f754338-1aff-4e09-a933-7d205ca7aed4
                  inboundDuration: 30
                  calculatedDuration: 15
                  pricePerSecond: 0.01
                  currency: EUR
                  recordingFileId: 7e8d64c0-6c72-4922-aa96-48728753c660
                  recordCalleeAnnouncement: true
                  recordingStatus: SFTP
                  machineDetectionResult: HUMAN
                  clientReferenceId: 7e8d64c0-6c72-4922-aa96-48728753c660
      responses:
        '200':
          description: A successful response is represented by an HTTP status code 200 OK from the Client’s platform.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.StatusResponse'
  receive-url-destination-request:
    post:
      tags:
      - channels
      summary: URL destination webhook
      description: The client-defined API is triggered with information about the current call whenever the URL destination is reached in route resolution. The expected response is a valid endpoint destination.
      operationId: receive-url-destination-request
      parameters:
      - name: Authorization
        in: header
        description: Authentication generated based on route configuration. Basic and HMAC are supported.
        required: false
        style: simple
        explode: false
        schema:
          type: string
        example: 'Authorization: <token>'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationHttpRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse'
              examples:
                Phone destination response:
                  summary: Phone destination response
                  value:
                    value:
                      phoneNumber: '41793026834'
                      type: PHONE
                    type: ENDPOINT
                SIP destination response:
                  summary: SIP destination response
                  value:
                    value:
                      username: '41793026834'
                      sipTrunkId: 60d345fd3a799ec
                      type: SIP
                    connectTimeout: 30
                    recording:
                      recordingType: AUDIO
                    type: ENDPOINT
  call-link-status-webhook:
    post:
      tags:
      - channels
      summary: Call Link Webhook
      description: Webhook event payload that will be delivered on the url defined in the call link configuration.
      operationId: call-link-status-webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0e82c38c2cac57841ec8a3a6ca825965cdf7afbcdea80ae147c9d99f5ab3a8c3.WebhookEventPayload'
            examples:
              Call Link Webhook:
                summary: Call Link Webhook
                value:
                  callLinkId: r9wpIY
                  callLinkConfigId: 638dbdc6ecede164c3799d04
                  callDetails:
                    caller:
                      callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      endpoint:
                        phoneNumber: '44790987654'
                        type: PHONE
                      startTime: 2026-07-17T13:36:58.214+0000
                      joinTime: 2026-07-17T13:37:03.214+0000
                      leaveTime: 2026-07-17T13:37:13.214+0000
                      duration: 10
                      direction: OUTBOUND
                      state: FINISHED
                      type: DIALOG
                    callee:
                      callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      endpoint:
                        identity: jdoe
                        displayName: John Doe
                        type: WEBRTC
                      startTime: 2026-07-17T13:36:58.214+0000
                      joinTime: 2026-07-17T13:37:03.214+0000
                      leaveTime: 2026-07-17T13:37:13.214+0000
                      duration: 10
                      direction: INBOUND
                      state: FINISHED
                      type: DIALOG
                    dialogId: 00efdb95-c316-4c40-9f4a-76569faf1628
                    hangupSource: PLATFORM
                    type: WEBRTC
                  customData:
                    city: New York
                    language: en
                  recording:
                    composedFiles:
                    - id: da000100-023e-11e9-f808-3386da20fe84
                      name: Recording file
                      fileFormat: MP4
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      file:
                        id: da000100-023e-11e9-f808-3386da20fe84
                        name: Recording file
                        fileFormat: MP4
                  errorCode:
                    id: 10000
                    name: NORMAL_HANGUP
                    description: The call has ended with hangup initiated by caller, callee or API
              Phone Call Link Webhook with Machine Detection:
                summary: Phone Call Link Webhook with Machine Detection
                value:
                  callLinkId: r9wpIY
                  callLinkConfigId: 638dbdc6ecede164c3799d04
                  callDetails:
                    caller:
                      callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      endpoint:
                        phoneNumber: '44790987654'
                        type: PHONE
                      startTime: 2026-07-17T13:36:58.214+0000
                      joinTime: 2026-07-17T13:37:03.214+0000
                      leaveTime: 2026-07-17T13:37:13.214+0000
                      duration: 10
                      direction: OUTBOUND
                      state: FINISHED
                      type: DIALOG
                    callee:
                      callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      endpoint:
                        identity: jdoe
                        displayName: John Doe
                        type: WEBRTC
                      startTime: 2026-07-17T13:36:58.214+0000
                      joinTime: 2026-07-17T13:37:03.214+0000
                      leaveTime: 2026-07-17T13:37:13.214+0000
                      duration: 10
                      direction: INBOUND
                      state: FINISHED
                      type: DIALOG
                    dialogId: 00efdb95-c316-4c40-9f4a-76569faf1629
                    hangupSource: CALLER
                    machineDetection: HUMAN
                    type: PHONE
                  customData:
                    city: New York
                    language: en
                  recording:
                    composedFiles:
                    - id: da000100-023e-11e9-f808-3386da20fe84
                      name: Recording file
                      fileFormat: MP4
                    callRecordings:
                    - callId: d8d84155-3831-43fb-91c9-bb897149a79d
                      file:
                        id: da000100-023e-11e9-f808-3386da20fe84
                        name: Recording file
                        fileFormat: MP4
                  errorCode:
                    id: 10000
                    name: NORMAL_HANGUP
                    description: The call has ended with hangup initiated by caller, callee or API
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-inbound-email:
    post:
      tags:
      - channels
      summary: Receive parsed emails
      description: To enable the receipt of incoming emails using Infobip, please contact your Account Manager for detailed instructions on activating this feature. Once enabled, follow the steps outlined in our [Get Started guide](https://www.infobip.com/docs/email/get-started#inbound-parsing) to configure Inbound Parsing for your sender domain(s).
      externalDocs:
        description: Learn more
        url: https://www.infobip.com/docs/email/get-started#inbound-parsing
      operationId: receive-inbound-email
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.WebhookPayload'
            examples:
              WebhookExample:
                summary: WebhookExample
                value:
                  id: 6tood98mthy5cqdf5ixx
                  spfCheck: pass
                  dkimCheck:
                    result: pass
                    domains:
                    - test.com
                  senderIp: 192.0.2.54
                  from: John Doe <johndoe@test.com>
                  to: '[recipient@example.com]'
                  subject: Subject of the email
                  html: <div><h1>Hello world!</h1></div>
                  text: Hello world!
                  attachment1:
                  - 72
                  - 101
                  - 108
                  - 108
                  - 111
                  - 32
                  - 87
                  - 111
                  - 114
                  - 108
                  - 100
                  - 33
                  attachment2:
                  - 80
                  - 68
                  - 70
                  - 32
                  - 45
                  - 32
                  - 72
                  - 101
                  - 108
                  - 108
                  - 111
                  - 32
                  - 87
                  - 111
                  - 114
                  - 108
                  - 100
                  - 33
                  attachmentInfo:
                  - name: attachment1
                    contentType: text/plain
                    filename: helloworld.txt
                    contentId: f_m488049z2
                  - name: attachment2
                    contentType: application/pdf
                    filename: helloworld.pdf
                    contentId: f_m488049z3
                  envelope:
                    from: johndoe@test.com
                    to: recipient@example.com
                  headers:
                    DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed...
                    From: John Doe <johndoe@test.com>
                    To: recipient@example.com
                    MIME-Version: '1.0'
                    Received: by smtp.test.com for <johndoe@test.com>...
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-email-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive email delivery reports
      description: Here you can configure an endpoint via the `notifyUrl` parameter that will receive a delivery report each time an email is sent out. Alternatively, you can also provide the endpoint’s URL to Customer support and they will set it up for you.
      externalDocs:
        description: Learn more about the Email channel and its use cases
        url: https://www.infobip.com/docs/email
      operationId: receive-email-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.WebhookDLRPayload'
            examples:
              Example:
                summary: Example
                value:
                  results:
                  - entityId: promotional-traffic-entity
                    applicationId: marketing-automation-application
                    campaignReferenceId: campaign-reference-123
                    bulkId: aszzmbhu62l7bxkhmyrj
                    price:
                      pricePerMessage: 0
                      currency: UNKNOWN
                    status:
                      id: 5
                      groupId: 3
                      groupName: DELIVERED
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      groupId: 0
                      groupName: OK
                      permanent: false
                    messageId: hgtesn8bcmc71pujp92d
                    doneAt: 2020-09-08T05:27:59.256+0000
                    smsCount: 1
                    sentAt: 2020-09-08T05:27:57.628+0000
                    attemptCount: 1
                    timeToFirstAttempt: 123
                    browserLink: https://tracking.domain.com/render/content?id=9A31C6F61DBAE9664D74C7A5A5A01F92283F581D11EA80A28C12E83BC83D449BC4A9F32F1AE3C3E
                    sendingIp: 192.0.2.0
                    smtp:
                      response: 250 2.0.0 OK
                    callbackData: something you want back
                    to: john.doe@gmail.com
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-email-tracking-reports:
    post:
      tags:
      - channels
      summary: Receive user events
      description: For each email that you send out, we can send you a tracking report for opened, clicked, complained, late bounce and unsubscribed. All you need to do is specify your endpoint [when sending email](https://www.infobip.com/docs/api/channels/email/send-fully-featured-email) and we will deliver a report to you in real time.
      externalDocs:
        description: Learn more about the Email channel and its use cases
        url: https://www.infobip.com/docs/email
      operationId: receive-email-tracking-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.WebhookTrackingPayload'
            examples:
              Open reports:
                summary: Open reports
                value:
                  notificationType: OPENED
                  eventId: 8d2f8781-91fc-4473-9b0a-b12b51fafbe6
                  domain: some-domain.com
                  recipient: john.doe@some-domain.com
                  sendDateTime: 1704106800000
                  messageId: 14b734recsf69n8zkao5
                  bulkId: ikzzmbhu6223bxkhmyrj
                  callbackData: Callback data
                  recipientInfo:
                    deviceType: Phone
                    os: iOS 12
                    deviceName: Apple
                  geoLocation:
                    countryName: Los Angeles
                    city: United States
                  entityId: promotional-traffic-entity
                  applicationId: marketing-automation-application
                  campaignReferenceId: campaign-reference-123
              Click reports:
                summary: Click reports
                value:
                  notificationType: CLICKED
                  eventId: 8d2f8781-91fc-4473-9b0a-b12b51fafbe6
                  domain: some-domain.com
                  recipient: john.doe@some-domain.com
                  url: https://www.somelink.com
                  sendDateTime: 1704106800000
                  messageId: 14b734recsf69n8zkao5
                  bulkId: ikzzmbhu6223bxkhmyrj
                  callbackData: Callback data
                  recipientInfo:
                    deviceType: Phone
                    os: iOS 12
                    deviceName: Apple
                  geoLocation:
                    countryName: Los Angeles
                    city: United States
                  entityId: promotional-traffic-entity
                  applicationId: marketing-automation-application
                  campaignReferenceId: campaign-reference-123
              Unsubscribe reports:
                summary: Unsubscribe reports
                value:
                  notificationType: UNSUBSCRIBED
                  eventId: 8d2f8781-91fc-4473-9b0a-b12b51fafbe6
                  domain: some-domain.com
                  recipient: john.doe@some-domain.com
                  sendDateTime: 1704106800000
                  messageId: 14b734recsf69n8zkao5
                  bulkId: ikzzmbhu6223bxkhmyrj
                  callbackData: Callback data
                  recipientInfo:
                    deviceType: Phone
                    os: iOS 12
                    deviceName: Apple
                  geoLocation:
                    countryName: Los Angeles
                    city: United States
                  entityId: promotional-traffic-entity
                  applicationId: marketing-automation-application
                  campaignReferenceId: campaign-reference-123
              Complained reports:
                summary: Complained reports
                value:
                  notificationType: COMPLAINED
                  eventId: 8d2f8781-91fc-4473-9b0a-b12b51fafbe6
                  domain: some-domain.com
                  recipient: john.doe@some-domain.com
                  sender: noreply@some-domain.com
                  sendDateTime: 1704106800000
                  messageId: 14b734recsf69n8zkao5
                  bulkId: ikzzmbhu6223bxkhmyrj
                  callbackData: Callback data
                  entityId: promotional-traffic-entity
                  applicationId: marketing-automation-application
                  campaignReferenceId: campaign-reference-123
              Late bounce reports:
                summary: Late bounce reports
                value:
                  notificationType: LATE_BOUNCE
                  eventId: 8d2f8781-91fc-4473-9b0a-b12b51fafbe6
                  domain: some-domain.com
                  recipient: john.doe@some-domain.com
                  sender: noreply@some-domain.com
                  sendDateTime: 1704106800000
                  messageId: 14b734recsf69n8zkao5
                  bulkId: ikzzmbhu6223bxkhmyrj
                  callbackData: Callback data
                  entityId: promotional-traffic-entity
                  applicationId: marketing-automation-application
                  campaignReferenceId: campaign-reference-123
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-email-platform-events:
    post:
      tags:
      - channels
      summary: Receive email platform events
      description: Receive platform-level events related to your email sending configuration. Events are delivered as they occur, with the `type` field inside `eventDetails` indicating the specific event. Learn more about [bounce rates](https://www.infobip.com/docs/email/email-deliverability#bounce-rates).
      externalDocs:
        description: Set up event subscriptions
        url: https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions
      operationId: receive-email-platform-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.Payload'
            examples:
              High bounce rate warning:
                summary: High bounce rate warning
                description: Sent when a domain's bounce rate exceeds the warning threshold. The domain remains active but action is recommended to avoid suspension.
                value:
                  eventId: 550e8400-e29b-41d4-a716-446655440000
                  createdAt: 1767308400000
                  eventDetails:
                    type: HIGH_BOUNCE_RATE_WARNING
                    accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                    domain: example.com
                    warnThreshold: 3.0
                    bounceRate: 4.6
                    scope: HOURLY
              High bounce rate block:
                summary: High bounce rate block
                description: Sent when a domain's bounce rate exceeds the block threshold. The domain has been suspended and email sending is disabled for following 24 hours.
                value:
                  eventId: dc592d92-54bb-4c97-b9fb-7aafb8f07bfd
                  createdAt: 1767308400000
                  eventDetails:
                    type: HIGH_BOUNCE_RATE_BLOCKED
                    accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                    domain: example.com
                    blockThreshold: 5.0
                    bounceRate: 6.6
                    scope: DAILY
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-inbound-whatsapp-messages:
    post:
      tags:
      - channels
      summary: Receive WhatsApp inbound message
      description: Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by specifying your endpoint and we will send inbound WhatsApp messages to you as soon as they are delivered to us.<br/>Name of the default format or renderer for the inbound WhatsApp messages is `MO_OTT_CONTACT`, and is documented in this section.
      externalDocs:
        description: Learn more about WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-inbound-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundMessages'
            examples:
              Received WhatsApp TEXT message:
                summary: Received WhatsApp TEXT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      text: Hello, World!
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp TEXT message with Identity notification:
                summary: Received WhatsApp TEXT message with Identity notification
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      text: Hello, World!
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                    identity:
                      acknowledged: true
                      hash: eU2Fdi4EMUw=
                      createdAt: 2025-01-01T00:00:00.000+0000
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp TEXT message with ad referral:
                summary: Received WhatsApp TEXT message with ad referral
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      text: Hello, World!
                      referral:
                        sourceType: AD
                        sourceId: ad-source-id
                        sourceUrl: https://www.example.com/ad
                        headline: Ad headline
                        body: Ad body
                        ctwaClickId: ctwa-click-id
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp LOCATION message:
                summary: Received WhatsApp LOCATION message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      latitude: 40.748433333333
                      longitude: -73.985655555556
                      address: 350 5th Ave, New York, NY
                      name: Empire State Building
                      url: https://www.facebook.com/113272675352744
                      type: LOCATION
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp IMAGE message:
                summary: Received WhatsApp IMAGE message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      caption: Image Caption
                      type: IMAGE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp DOCUMENT message:
                summary: Received WhatsApp DOCUMENT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      caption: Document Title
                      type: DOCUMENT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp AUDIO message:
                summary: Received WhatsApp AUDIO message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      type: AUDIO
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp VIDEO message:
                summary: Received WhatsApp VIDEO message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      caption: Look at this!
                      type: VIDEO
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp VOICE message:
                summary: Received WhatsApp VOICE message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      caption: Voice Note
                      type: VOICE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp CONTACT message:
                summary: Received WhatsApp CONTACT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      contacts:
                      - addresses:
                        - street: Street
                          city: New York
                          state: NY
                          zip: '10001'
                          country: USA
                          countryCode: US
                          type: HOME
                        birthday: '1980-01-01'
                        emails:
                        - email: frank@example.com
                          type: HOME
                        name:
                          firstName: Frank
                          lastName: Bipper
                          middleName: John
                          namePrefix: Mr.
                          formattedName: Frank Bipper
                        org:
                          company: Infobip
                          department: Support
                          title: eng.
                        phones:
                        - phone: '385918889999'
                          type: CELL
                          waId: '385918889999'
                        urls:
                        - url: https://www.infobip.com
                          type: HOME
                      type: CONTACT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INFECTED_CONTENT message:
                summary: Received WhatsApp INFECTED_CONTENT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      malware: Infected content detected
                      type: INFECTED_CONTENT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp BUTTON message:
                summary: Received WhatsApp BUTTON message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      text: Button text
                      payload: Payload
                      type: BUTTON
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp STICKER message:
                summary: Received WhatsApp STICKER message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                      type: STICKER
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_BUTTON_REPLY message:
                summary: Received WhatsApp INTERACTIVE_BUTTON_REPLY message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      id: button-reply-id
                      title: Button reply title
                      type: INTERACTIVE_BUTTON_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_LIST_REPLY message:
                summary: Received WhatsApp INTERACTIVE_LIST_REPLY message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      id: list-reply-id
                      title: List reply title
                      description: List reply description
                      type: INTERACTIVE_LIST_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_FLOW_REPLY message:
                summary: Received WhatsApp INTERACTIVE_FLOW_REPLY message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      text: flow-reply-id
                      response:
                        flow-data: flow-input-response
                      type: INTERACTIVE_FLOW_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_PAYMENT_CONFIRMATION message:
                summary: Received WhatsApp INTERACTIVE_PAYMENT_CONFIRMATION message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      referenceId: payment-confirmation-id
                      paymentId: payment-confirmation-id
                      status: SUCCESS
                      currency: INR
                      totalAmount:
                        value: 299
                        offset: 100
                      transactionId: transaction-id
                      transactionType: UPI
                      type: INTERACTIVE_PAYMENT_CONFIRMATION
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT message:
                summary: Received WhatsApp INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      paymentAcknowledgementType: PIX
                      timestamp: 2025-01-01T00:00:00.000+0000
                      paymentId: payment-id
                      referenceId: transaction-id
                      type: INTERACTIVE_PAYMENT_ACKNOWLEDGEMENT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_CALL_PERMISSION_REPLY message:
                summary: Received WhatsApp INTERACTIVE_CALL_PERMISSION_REPLY message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      callPermissionReply:
                        response: ACCEPT
                        expirationTimestamp: 2025-01-01T00:00:00.000+0000
                      type: INTERACTIVE_CALL_PERMISSION_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY message:
                summary: Received WhatsApp INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      inThreadAuthenticationReply:
                        status: VERIFIED
                        businessScopedPasskeyHash: d4KXmNqYpeR-rU62bHLA9sivkZWjtxgcf8P1nyDraolMV5C7uEs93kQwF24mGcTybnnJ6h1zzr-v7-QWupXJmdrA
                      type: INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp ORDER message:
                summary: Received WhatsApp ORDER message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      catalogId: order-id
                      productItems:
                      - currency: EUR
                        itemPrice: 1.99
                        productRetailerId: product-retailer-id
                        quantity: 1
                      text: I like you store!
                      type: ORDER
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp REACTION message:
                summary: Received WhatsApp REACTION message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2025-01-01T10:10:00.000+0000
                    messageId: wamid.HBgLMjc4MTMzMjE0ODIVAgAonoIAUsydhfskYyRDdEMjE4Njg3MzlBMDU2NzI4NgA=
                    callbackData: callbackData
                    message:
                      emoji: 🤓
                      action: ADDED
                      context:
                        id: abcdef_ghij124567890klmnopr
                      type: REACTION
                    price:
                      pricePerMessage: 0
                      currency: EUR
                    contact:
                      name: Frank
                      phoneNumber: '385919998888'
                      userId: HR.123123123
                      parentUserId: HR.ENT.456456456
                      username: Frank
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-whatsapp-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyURL` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.
      externalDocs:
        description: Learn more about the WhatsApp channel and its use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryResult'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: ''
                    price:
                      pricePerMessage: 0.21
                      currency: BRL
                    status:
                      id: 5
                      groupId: 3
                      groupName: DELIVERED
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      groupId: 0
                      groupName: OK
                      permanent: false
                    messageId: fb469d73-d362-463f-b30f-1e959b53badc
                    doneAt: 2019-04-09T16:01:56.494-0300
                    messageCount: 1
                    sentAt: 2019-04-09T16:00:58.647-0300
                    to: '41793026731'
                    contact:
                      name: name
                      phoneNumber: '41793026731'
                      userId: US.1349120865530274191
                      parentUserId: US.ENT.118157495734
                      username: username
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-whatsapp-seen-reports:
    post:
      tags:
      - channels
      summary: Receive seen reports
      description: For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer Support and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyURL` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.
      externalDocs:
        description: Learn more about the WhatsApp channel and its use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenResult'
            examples:
              Seen reports:
                summary: Seen reports
                value:
                  results:
                  - messageId: 1215f543ab19-345f-adbd-12ad31451ed25f35
                    from: '385919998888'
                    to: '41793026731'
                    sentAt: 2018-12-12T11:21:57.793+0000
                    seenAt: 2018-12-12T11:21:58.251+0000
                    applicationId: example-application-id
                    entityId: example-entity-id
                    contact:
                      name: name
                      phoneNumber: '41793026731'
                      userId: US.1349120865530274191
                      parentUserId: US.ENT.118157495734
                      username: username
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-whatsapp-payment-notification:
    post:
      tags:
      - channels
      summary: Receive WhatsApp Payment Notification
      description: Receive notification about payment transaction updates.
      externalDocs:
        description: Learn more about the WhatsApp channel and its use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-payment-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotificationResponse'
            examples:
              Payment notification:
                summary: Payment notification
                value:
                  from: '41793026731'
                  content:
                    from: '447860064555'
                    type: payment
                    referenceId: '72123248136'
                    paymentId: fd3e847h2
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T01:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                  createdAt: 2023-01-01T01:00:00.000+0000
              Payment PayU notification:
                summary: Payment PayU notification
                value:
                  from: '41793026731'
                  content:
                    from: '447860064555'
                    type: payment
                    referenceId: '72123248136'
                    paymentId: fd3e847h2
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    callbackData:
                    - customData1
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T01:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                  createdAt: 2023-01-01T01:00:00.000+0000
              Payment Razorpay notification:
                summary: Payment Razorpay notification
                value:
                  from: '41793026731'
                  content:
                    from: '447860064555'
                    type: payment
                    referenceId: '72123248136'
                    paymentId: fd3e847h2
                    paymentStatus: CAPTURED
                    currency: INR
                    totalAmountValue: 21000
                    totalAmountOffset: 100
                    callbackData:
                      customKey1: customValue1
                      customKey2: customValue2
                    transactions:
                    - id: '27194245144'
                      type: UPI
                      status: SUCCESS
                      createdTimestamp: 2023-01-01T01:00:00.000+0000
                      updatedTimestamp: 2023-01-01T01:00:00.000+0000
                  createdAt: 2023-01-01T01:00:00.000+0000
      responses:
        '200':
          description: Your server returns this code, if it accepts the callback.
  receive-whatsapp-marketing-update-notification:
    post:
      tags:
      - channels
      summary: Receive WhatsApp Marketing Update Notification
      description: Receive notification about user preferences for marketing template messages.
      externalDocs:
        description: Learn more about the WhatsApp channel and its use cases.
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-marketing-update-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotificationResponse'
            examples:
              Stop notification:
                summary: Stop notification
                value:
                  from: '41793026731'
                  content:
                    sender: '41793026731'
                    from: '385919998888'
                    notificationMessagesStatus: stop
                    description: User requested to stop marketing messages
                  createdAt: 2024-01-01T01:00:00.000+0000
              Resume notification:
                summary: Resume notification
                value:
                  from: '41793026731'
                  content:
                    sender: '41793026731'
                    from: '385919998888'
                    notificationMessagesStatus: resume
                    description: User requested to resume marketing messages
                  createdAt: 2024-01-01T01:00:00.000+0000
      responses:
        '200':
          description: Your server returns this code, if it accepts the callback.
  receive-whatsapp-message-template-update-events:
    post:
      tags:
      - channels
      summary: Receive WhatsApp template update
      description: For each message template you create, we can send you updates. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.
      externalDocs:
        description: Learn more about the WhatsApp channel and use cases
        url: https://www.infobip.com/docs/whatsapp
      operationId: receive-whatsapp-message-template-update-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateUpdatePushEvent'
            examples:
              Template APPROVED event:
                summary: Template APPROVED event
                value:
                  messageTemplateId: '111'
                  messageTemplateName: template_name
                  messageTemplateLanguage: en
                  timestamp: 2019-11-09T16:00:00.000+0000
                  change:
                    type: TEMPLATE_STATUS_UPDATE
                    newStatus: APPROVED
                    reason: NONE
                  entityId: 123456
                  applicationId: 1234567
              Template REJECTED event:
                summary: Template REJECTED event
                value:
                  messageTemplateId: '111'
                  messageTemplateName: template_name
                  messageTemplateLanguage: en
                  timestamp: 2019-11-09T16:00:00.000+0000
                  change:
                    type: TEMPLATE_STATUS_UPDATE
                    newStatus: REJECTED
                    reason: SCAM
                  entityId: 123456
                  applicationId: 1234567
              Template FLAGGED event:
                summary: Template FLAGGED event
                value:
                  messageTemplateId: '111'
                  messageTemplateName: template_name
                  messageTemplateLanguage: en
                  timestamp: 2019-11-09T16:00:00.000+0000
                  change:
                    type: TEMPLATE_STATUS_UPDATE
                    newStatus: FLAGGED
                  entityId: 123456
                  applicationId: 1234567
              Template category change event:
                summary: Template category change event
                value:
                  messageTemplateId: '111'
                  messageTemplateName: template_name
                  messageTemplateLanguage: en
                  timestamp: 2019-11-09T16:00:00.000+0000
                  change:
                    type: TEMPLATE_CATEGORY_UPDATE
                    previousCategory: MARKETING
                    newCategory: UTILITY
                  entityId: 123456
                  applicationId: 1234567
              Template quality change event:
                summary: Template quality change event
                value:
                  messageTemplateId: '111'
                  messageTemplateName: template_name
                  messageTemplateLanguage: en
                  timestamp: 2019-11-09T16:00:00.000+0000
                  change:
                    type: TEMPLATE_QUALITY_UPDATE
                    previousQualityScore: LOW
                    newQualityScore: HIGH
                  entityId: 123456
                  applicationId: 1234567
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-whatsapp-identity-change-notification:
    post:
      tags:
      - channels
      summary: Receive WhatsApp Identity Change Notification
      description: Receive notification about end user's identity change. Feature is not enabled by default.
      externalDocs:
        description: Learn more.
        url: https://www.infobip.com/docs/whatsapp/additional-functionality#identity-change
      operationId: receive-whatsapp-identity-change-notification
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEventResponse'
            examples:
              Identity change reports:
                summary: Identity change reports
                value:
                  from: '41793026731'
                  content:
                    description: Security code changed.
                    hash: eU2Fdi4EMUw=
                    type: user_identity_changed
                    userNumber: '385919998888'
                    userId: HR.123123123
                  createdAt: 2022-01-18T23:23:09.206+0000
      responses:
        '200':
          description: Your server returns this code, if it accepts the callback.
  receive-inbound-viber-messages:
    post:
      tags:
      - channels
      summary: Receive Viber inbound message
      description: Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: receive-viber-inbound-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessages'
            examples:
              Received Viber TEXT message:
                summary: Received Viber TEXT message
                value:
                  results:
                  - sender: '385912345678'
                    to: givenClient
                    integrationType: VIBER
                    receivedAt: 2020-04-01T11:02:43.594+0000
                    messageId: '1234567890123456789'
                    message:
                      text: givenText
                      trackingData: givenTrackingData
                      type: TEXT
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 1
              Received Viber FILE message:
                summary: Received Viber FILE message
                value:
                  results:
                  - sender: '385912345678'
                    to: givenClient
                    integrationType: VIBER
                    receivedAt: 2020-04-01T11:02:43.594+0000
                    messageId: '1234567890123456789'
                    message:
                      url: https://example.com/givenUrl.pdf
                      fileName: givenFileName
                      trackingData: givenTrackingData
                      type: FILE
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 1
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-viber-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Viber delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Viber channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: receive-outbound-viber-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value:
                  results:
                  - bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                    to: '441134960001'
                    sender: '441134960000'
                    sentAt: 2023-02-01T23:00:00.000+0000
                    doneAt: 2023-02-03T00:01:01.000+0000
                    messageCount: 1
                    mccMnc: '22801'
                    callbackData: Callback data
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>a28dd97c-2222-4fcf-99f1-0b557ed381da</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <to>441134960001</to>\n      <sender>441134960000</sender>\n      <sentAt>2023-02-01T23:00:00.000+0000</sentAt>\n      <doneAt>2023-02-03T00:01:01.000+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <callbackData>Callback data</callbackData>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-viber-seen-reports:
    post:
      tags:
      - channels
      summary: Receive seen reports
      description: For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.
      operationId: receive-viber-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReports'
            examples:
              Seen report:
                summary: Seen report
                value:
                  results:
                  - messageId: 1215f543ab19-345f-adbd-12ad31451ed25f35
                    from: '385919998888'
                    to: '41793026731'
                    sentAt: 2023-04-05T11:21:57.793+0000
                    seenAt: 2023-04-05T11:22:10.251+0000
                    applicationId: example-application-id
                    entityId: example-entity-id
                    campaignReferenceId: campaignRefId
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-viber-bot-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Viber Bot delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Viber Bot channel and use cases
        url: https://www.infobip.com/docs/viber
      operationId: receive-outbound-viber-bot-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '2034072219640523072'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                    to: '66855538125'
                    sender: '44113496000'
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>2034072219640523072</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <to>66855538125</to>\n      <sender>44113496000</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-viber-bot-api-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about the Viber Bot and use cases
        url: https://www.infobip.com/docs/viber
      operationId: receive-viber-bot-api-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-line-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive LON delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about LINE channel and use cases
        url: https://www.infobip.com/docs/line
      operationId: receive-outbound-line-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReports'
          application/xml:
            schema:
              $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReports'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-zalo-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.<br/>Name of the default format or renderer for inbound Zalo messages is `INBOUND_MESSAGES_SAPI_UNIFIED`, and is documented in this section.
      externalDocs:
        description: Learn more about Zalo channel and use cases
        url: https://www.infobip.com/docs/zalo
      operationId: receive-zalo-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundResponse'
            examples:
              Received text message:
                summary: Received text message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      text: Hello! I have a question about my order.
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received image message:
                summary: Received image message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/photo.jpg
                      thumbnail: https://example.com/thumb.jpg
                      type: IMAGE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received video message:
                summary: Received video message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/video.mp4
                      thumbnail: https://example.com/thumb.jpg
                      type: VIDEO
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received audio message:
                summary: Received audio message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/audio.m4a
                      type: AUDIO
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received file message:
                summary: Received file message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/document.pdf
                      name: document.pdf
                      size: 204800
                      fileType: application/pdf
                      type: FILE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received GIF message:
                summary: Received GIF message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/animation.gif
                      type: GIF
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received link message:
                summary: Received link message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/article
                      thumbnail: https://example.com/thumb.jpg
                      description: Interesting article
                      type: LINK
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received location message:
                summary: Received location message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      latitude: 10.7769
                      longitude: 106.7009
                      type: LOCATION
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received sticker message:
                summary: Received sticker message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      url: https://example.com/sticker.png
                      id: e1540df031b5deb81a4
                      type: STICKER
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received business card message:
                summary: Received business card message
                value:
                  results:
                  - sender: '1234567890123456789'
                    to: OFFICIAL-ACCOUNT-ID-XY12Z3
                    integrationType: ZALO_NOTIFICATION_SERVICE
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    message:
                      name: John Smith
                      avatar: https://example.com/avatar.jpg
                      type: BUSINESS_CARD
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-zalo-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive delivery reports
      description: Incoming Reports will be forwarded to this endpoint. Please specify the endpoint’s URL for each message via the webhooks > delivery > url parameter. Alternatively you can provide the endpoint’s URL to [Customer Support](support@infobip.com) and they will set it up for you. Contact [support@infobip.com](support@infobip.com) if you require help.
      externalDocs:
        description: Learn more about the Zalo channel and its use cases
        url: https://www.infobip.com/docs/api/channels/zalo
      operationId: receive-outbound-zalo-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportRequest'
            examples:
              Received report:
                summary: Received report
                value:
                  results:
                  - bulkId: BULK-ID-123-xyz
                    messageId: 45db39c3-7822-4e72-a3ec-c87442c0ffz9
                    to: '41793026727'
                    sentAt: 2019-11-09T16:00:00.000+0000
                    doneAt: 2019-11-09T16:00:00.000+0000
                    messageCount: 1
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    entityId: my-entity-id
                    applicationId: my-application-id
                    channel: ZALO_NOTIFICATION_SERVICE
                  - bulkId: BULK-ID-123-xyz
                    messageId: 12db39c3-7822-4e72-a3ec-c87442c0ffc5
                    to: '41793026834'
                    sentAt: 2019-11-09T17:00:00.000+0000
                    doneAt: 2019-11-09T17:00:00.000+0000
                    messageCount: 1
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    entityId: my-entity-id
                    applicationId: my-application-id
                    channel: ZALO_NOTIFICATION_SERVICE
          application/xml:
            schema:
              $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportRequest'
            examples:
              Received report:
                summary: Received report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ZaloReportRequest>\n  <results>\n    <results>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>45db39c3-7822-4e72-a3ec-c87442c0ffz9</messageId>\n      <to>41793026727</to>\n      <sentAt>2019-11-09T16:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T16:00:00.000+0000</doneAt>\n      <messageCount>1</messageCount>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <entityId>my-entity-id</entityId>\n      <applicationId>my-application-id</applicationId>\n      <channel>ZALO_NOTIFICATION_SERVICE</channel>\n    </results>\n    <results>\n      <bulkId>BULK-ID-123-xyz</bulkId>\n      <messageId>12db39c3-7822-4e72-a3ec-c87442c0ffc5</messageId>\n      <to>41793026834</to>\n      <sentAt>2019-11-09T17:00:00.000+0000</sentAt>\n      <doneAt>2019-11-09T17:00:00.000+0000</doneAt>\n      <messageCount>1</messageCount>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <entityId>my-entity-id</entityId>\n      <applicationId>my-application-id</applicationId>\n      <channel>ZALO_NOTIFICATION_SERVICE</channel>\n    </results>\n  </results>\n</ZaloReportRequest>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-push-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Push delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Mobile Push and In-App Messages
        url: https://www.infobip.com/docs/mobile-push
      operationId: receive-outbound-push-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReports'
          application/xml:
            schema:
              $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReports'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-inbound-rcs-messages:
    post:
      tags:
      - channels
      summary: Receive RCS inbound message
      description: Set up logic for processing incoming messages to customize two-way communication. Inbound messages are forwarded in real time to the endpoint provided during the account setup.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-incoming-rcs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessages'
            examples:
              TEXT message response:
                summary: TEXT message response
                value:
                  results:
                  - campaignReferenceId: CAMP-2026-Q1
                    sender: '385911234567'
                    to: DemoSender
                    integrationType: RCS
                    receivedAt: 2026-03-03T14:22:30.000+0000
                    interactionType: BASIC_MESSAGE
                    rcsCount: 1
                    keyword: START
                    messageId: msg-abc123
                    pairedMessageId: msg-xyz456
                    callbackData: custom-user-data
                    message:
                      text: Hello, world!
                      type: TEXT
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    conversation:
                      canInitiate: true
                      id: null
                    platform:
                      applicationId: ext-app-001
                      entityId: ext-entity-001
                  messageCount: 1
                  pendingMessageCount: 0
              FILE message response:
                summary: FILE message response
                value:
                  results:
                  - campaignReferenceId: CAMP-2026-Q1
                    sender: '385911234567'
                    to: DemoSender
                    integrationType: RCS
                    receivedAt: 2026-03-03T14:22:30.000+0000
                    interactionType: SINGLE_MESSAGE
                    rcsCount: 1
                    keyword: START
                    messageId: msg-abc123
                    pairedMessageId: msg-xyz456
                    callbackData: custom-user-data
                    message:
                      url: https://example.com/file.pdf
                      name: file.pdf
                      contentType: pdf
                      size: 123456
                      type: FILE
                    price:
                      trafficType: SINGLE
                      pricePerMessage: 0.005
                      currency: EUR
                    conversation:
                      canInitiate: false
                      id: conv-xyz789
                    platform:
                      applicationId: ext-app-001
                      entityId: ext-entity-001
                  messageCount: 1
                  pendingMessageCount: 0
              SUGGESTION message response:
                summary: SUGGESTION message response
                value:
                  results:
                  - campaignReferenceId: CAMP-2026-Q1
                    sender: '385911234567'
                    to: DemoSender
                    integrationType: RCS
                    receivedAt: 2026-03-03T14:22:30.000+0000
                    interactionType: BASIC_MESSAGE
                    rcsCount: 1
                    keyword: START
                    messageId: msg-abc123
                    pairedMessageId: msg-xyz456
                    callbackData: custom-user-data
                    message:
                      text: suggestionText
                      postbackData: suggestionPostbackData
                      type: SUGGESTION
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    conversation:
                      canInitiate: false
                      id: conv-xyz789
                    platform:
                      applicationId: ext-app-001
                      entityId: ext-entity-001
                  messageCount: 1
                  pendingMessageCount: 0
              LOCATION message response:
                summary: LOCATION message response
                value:
                  results:
                  - campaignReferenceId: CAMP-2026-Q1
                    sender: '385911234567'
                    to: DemoSender
                    integrationType: RCS
                    receivedAt: 2026-03-03T14:22:30.000+0000
                    interactionType: BASIC_MESSAGE
                    rcsCount: 1
                    keyword: START
                    messageId: msg-abc123
                    pairedMessageId: msg-xyz456
                    callbackData: custom-user-data
                    message:
                      latitude: 37.7749
                      longitude: -122.4194
                      type: LOCATION
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    conversation:
                      canInitiate: false
                      id: conv-xyz789
                    platform:
                      applicationId: ext-app-001
                      entityId: ext-entity-001
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  inbound-events-receive-inbound-rcs-events:
    post:
      tags:
      - channels
      summary: Receive RCS user action event
      description: Set up logic for processing incoming events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: inbound-events-receive-inbound-rcs-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvents'
            examples:
              SUGGESTION event response:
                summary: SUGGESTION event response
                value:
                  results:
                  - campaignReferenceId: CAMP-2026-Q1
                    sender: '385911234567'
                    to: DemoSender
                    integrationType: RCS
                    receivedAt: 2026-03-03T14:22:30.000+0000
                    interactionType: EVENT
                    keyword: START
                    messageId: msg-abc123
                    pairedMessageId: msg-xyz456
                    callbackData: custom-user-data
                    message:
                      text: suggestionText
                      postbackData: suggestionPostbackData
                      type: SUGGESTION
                    price:
                      trafficType: null
                      pricePerMessage: 0
                      currency: EUR
                    conversation:
                      canInitiate: false
                      id: conv-xyz789
                    platform:
                      applicationId: ext-app-001
                      entityId: ext-entity-001
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-typing-indicator-events:
    post:
      tags:
      - channels
      summary: Receive RCS typing indicator event
      description: Set up logic for processing incoming typing indicator events to customize two-way communication. Inbound events are forwarded in real time to the endpoint provided during the account setup.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-typing-indicator-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvents'
            examples:
              TYPING_INDICATOR event response:
                summary: TYPING_INDICATOR event response
                value:
                  results:
                  - sender: '385911234567'
                    to: DemoSender
                    receivedAt: '2026-03-03T14:22:30Z'
                    event:
                      type: TYPING_INDICATOR
                    entityId: ext-entity-001
                    applicationId: ext-app-001
                  eventCount: 1
                  pendingEventCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-rcs-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive RCS delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-outbound-rcs-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports'
            examples:
              RCS message delivered:
                summary: RCS message delivered
                value:
                  results:
                  - bulkId: BULK-123456
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No error
                      permanent: false
                    conversation:
                      canInitiate: true
                      id: null
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    interactionType: BASIC_MESSAGE
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: sender
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
              RCS message failed:
                summary: RCS message failed
                value:
                  results:
                  - bulkId: BULK-123456
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 2
                      groupName: UNDELIVERABLE
                      id: 4
                      name: UNDELIVERABLE_REJECTED_OPERATOR
                      description: Message rejected by operator
                    error:
                      groupId: 1
                      groupName: HANDSET_ERRORS
                      id: 7002
                      name: EC_UNKNOWN_USER
                      description: No matching user found (on platform or on provider)
                      permanent: true
                    conversation:
                      canInitiate: false
                      id: null
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    interactionType: BASIC_MESSAGE
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: sender
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
              RCS with failover RCS message delivered:
                summary: RCS with failover RCS message delivered
                value:
                  results:
                  - bulkId: BULK-123456
                    channel: RCS
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No error
                      permanent: false
                    conversation:
                      canInitiate: false
                      id: conv-xyz789
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    interactionType: BASIC_MESSAGE
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: sender
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
              RCS with failover RCS message failed:
                summary: RCS with failover RCS message failed
                value:
                  results:
                  - bulkId: BULK-123456
                    channel: RCS
                    price:
                      trafficType: BASIC
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 1
                      groupName: PENDING
                      id: 7
                      name: PENDING_ENROUTE
                      description: Message sent to next instance
                    error:
                      groupId: 1
                      groupName: HANDSET_ERRORS
                      id: 7002
                      name: EC_UNKNOWN_USER
                      description: No matching user found (on platform or on provider)
                      permanent: true
                    conversation:
                      canInitiate: false
                      id: null
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    interactionType: BASIC_MESSAGE
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: sender
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
              RCS with failover SMS message delivered:
                summary: RCS with failover SMS message delivered
                value:
                  results:
                  - bulkId: BULK-123456
                    channel: SMS
                    price:
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No error
                      permanent: false
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: InfoSMS
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
              RCS with failover SMS message failed:
                summary: RCS with failover SMS message failed
                value:
                  results:
                  - bulkId: BULK-123456
                    channel: SMS
                    price:
                      pricePerMessage: 0.005
                      currency: EUR
                    status:
                      groupId: 2
                      groupName: UNDELIVERABLE
                      id: 4
                      name: UNDELIVERABLE_REJECTED_OPERATOR
                      description: Message rejected by operator
                    error:
                      groupId: 1
                      groupName: HANDSET_ERRORS
                      id: 9
                      name: EC_ILLEGAL_SUBSCRIBER
                      description: Illegal Subscriber
                      permanent: true
                    messageId: msg-abc123
                    doneAt: 2026-03-03T14:22:35.000+0100
                    messageCount: 1
                    sentAt: 2026-03-03T14:22:30.000+0100
                    mccMnc: '21910'
                    callbackData: custom-user-data
                    to: '385911234567'
                    sender: InfoSMS
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                    campaignReferenceId: CAMP-2026-Q1
          application/xml:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports'
            examples:
              RCS message delivered:
                summary: RCS message delivered
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <price>\n        <trafficType>BASIC</trafficType>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No error</description>\n        <permanent>false</permanent>\n      </error>\n      <conversation>\n        <canInitiate>true</canInitiate>\n        <id/>\n      </conversation>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <interactionType>BASIC_MESSAGE</interactionType>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>sender</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
              RCS message failed:
                summary: RCS message failed
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <price>\n        <trafficType>BASIC</trafficType>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>2</groupId>\n        <groupName>UNDELIVERABLE</groupName>\n        <id>4</id>\n        <name>UNDELIVERABLE_REJECTED_OPERATOR</name>\n        <description>Message rejected by operator</description>\n      </status>\n      <error>\n        <groupId>1</groupId>\n        <groupName>HANDSET_ERRORS</groupName>\n        <id>7002</id>\n        <name>EC_UNKNOWN_USER</name>\n        <description>No matching user found (on platform or on provider)</description>\n        <permanent>true</permanent>\n      </error>\n      <conversation>\n        <canInitiate>false</canInitiate>\n        <id/>\n      </conversation>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <interactionType>BASIC_MESSAGE</interactionType>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>sender</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
              RCS with failover RCS message delivered:
                summary: RCS with failover RCS message delivered
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <channel>RCS</channel>\n      <price>\n        <trafficType>BASIC</trafficType>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No error</description>\n        <permanent>false</permanent>\n      </error>\n      <conversation>\n        <canInitiate>false</canInitiate>\n        <id>conv-xyz789</id>\n      </conversation>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <interactionType>BASIC_MESSAGE</interactionType>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>sender</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
              RCS with failover RCS message failed:
                summary: RCS with failover RCS message failed
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <channel>RCS</channel>\n      <price>\n        <trafficType>BASIC</trafficType>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>1</groupId>\n        <groupName>PENDING</groupName>\n        <id>7</id>\n        <name>PENDING_ENROUTE</name>\n        <description>Message sent to next instance</description>\n      </status>\n      <error>\n        <groupId>1</groupId>\n        <groupName>HANDSET_ERRORS</groupName>\n        <id>7002</id>\n        <name>EC_UNKNOWN_USER</name>\n        <description>No matching user found (on platform or on provider)</description>\n        <permanent>true</permanent>\n      </error>\n      <conversation>\n        <canInitiate>false</canInitiate>\n        <id/>\n      </conversation>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <interactionType>BASIC_MESSAGE</interactionType>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>sender</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
              RCS with failover SMS message delivered:
                summary: RCS with failover SMS message delivered
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <channel>SMS</channel>\n      <price>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>InfoSMS</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
              RCS with failover SMS message failed:
                summary: RCS with failover SMS message failed
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><RcsWebhookDeliveryReports>\n  <results>\n    <result>\n      <bulkId>BULK-123456</bulkId>\n      <channel>SMS</channel>\n      <price>\n        <pricePerMessage>0.005</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>2</groupId>\n        <groupName>UNDELIVERABLE</groupName>\n        <id>4</id>\n        <name>UNDELIVERABLE_REJECTED_OPERATOR</name>\n        <description>Message rejected by operator</description>\n      </status>\n      <error>\n        <groupId>1</groupId>\n        <groupName>HANDSET_ERRORS</groupName>\n        <id>9</id>\n        <name>EC_ILLEGAL_SUBSCRIBER</name>\n        <description>Illegal Subscriber</description>\n        <permanent>true</permanent>\n      </error>\n      <messageId>msg-abc123</messageId>\n      <doneAt>2026-03-03T14:22:35.000+0100</doneAt>\n      <messageCount>1</messageCount>\n      <sentAt>2026-03-03T14:22:30.000+0100</sentAt>\n      <mccMnc>21910</mccMnc>\n      <callbackData>custom-user-data</callbackData>\n      <to>385911234567</to>\n      <sender>InfoSMS</sender>\n      <platform>\n        <entityId>ext-entity-001</entityId>\n        <applicationId>ext-app-001</applicationId>\n      </platform>\n      <campaignReferenceId>CAMP-2026-Q1</campaignReferenceId>\n    </result>\n  </results>\n</RcsWebhookDeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-seen-reports:
    post:
      tags:
      - channels
      summary: Receive seen reports
      description: For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.
      operationId: receive-seen-reports-rcs
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReports'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-conversation-started-events:
    post:
      tags:
      - channels
      summary: Receive RCS conversation started event
      description: Webhook notifying that a message's billing model changed from non-conversational to conversational.
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-conversation-started-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvents'
            examples:
              CONVERSATION_STARTED event response:
                summary: CONVERSATION_STARTED event response
                value:
                  results:
                  - messageId: msg-abc123
                    trafficType: A2P_CONVERSATION
                    event:
                      type: CONVERSATION_STARTED
                    conversation:
                      type: A2P
                      id: conv-xyz789
                      startTime: 2026-06-14T09:12:00.000+0000
                      endTime: 2026-06-15T09:12:00.000+0000
                    platform:
                      entityId: ext-entity-001
                      applicationId: ext-app-001
                  eventCount: 1
                  pendingEventCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-capability-check-result:
    post:
      tags:
      - channels
      summary: Receive Capability Check result
      description: 'Receive the results requested by [Check RCS capability (async)](#channels/rcs/capability-check-rcs-destinations-notify). This callback will be invoked once per each phone number with POST method. '
      externalDocs:
        description: Learn more about RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-capability-check-result
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult'
            examples:
              Capability Check Result:
                summary: Capability Check Result
                value:
                  capabilityCheckResult:
                    bulkId: d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8
                    messageId: b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3
                    phoneNumber: '441134960001'
                    code: ENABLED
                  options:
                    platform:
                      entityId: Example entity id
                      applicationId: Example application id
          application/xml:
            schema:
              $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult'
            examples:
              Capability Check Result:
                summary: Capability Check Result
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CapabilityCheckAsyncResult>\n  <capabilityCheckResult>\n    <bulkId>d5c3bdff-2d44-4f74-8a8e-3792fa57dfc8</bulkId>\n    <messageId>b5c3bdff-2d44-4f74-8a8e-3792fa57dfc3</messageId>\n    <phoneNumber>441134960001</phoneNumber>\n    <code>ENABLED</code>\n  </capabilityCheckResult>\n  <options>\n    <platform>\n      <entityId>Example entity id</entityId>\n      <applicationId>Example application id</applicationId>\n    </platform>\n  </options>\n</CapabilityCheckAsyncResult>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-sender-update-events:
    post:
      tags:
      - channels
      summary: Receive an RCS sender update event
      description: "Any time you request some operation to be executed for RCS sender, that operation will be\n                executed asynchronously. After operation is executed, an event is sent. Also, some operations for RCS sender\n                can be executed by Infobip team (e.g. launching a sender) and for these operations, an event will be sent too.\n                If you would like to receive these events, you need to subscribe to this event over 'RCS' channel, and specify the\n                'SENDER_UPDATE' event. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n                for additional info."
      externalDocs:
        description: Learn more about the RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-sender-update-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateWebhookResponse'
            examples:
              RCS Sender update event:
                summary: RCS Sender update event
                value:
                  results:
                  - event: RCS_SENDER_STATUS_UPDATE
                    senderName: DemoSender
                    senderStatus: READY_FOR_TESTING
                    googleAgentId: demosender_axdawe0_agent
                    updatedAt: 2025-02-15T16:38:24.000+0000
                    platform:
                      applicationId: application-id
                      entityId: entity-id
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-sender-launch-update-events:
    post:
      tags:
      - channels
      summary: Receive an RCS sender launch update event
      description: "When a launch request is submitted for a given RCS sender, the launch status is updated\n                individually for each provider within the selected country. This webhook delivers real-time updates\n                whenever the launch status changes for any provider in any country. To receive these events, you must\n                subscribe to the RCS channel and specify the SENDER_LAUNCH_UPDATE event. For more details on managing\n                subscriptions, please refer to the [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n                documentation."
      externalDocs:
        description: Learn more about the RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-sender-launch-update-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusWebhookResponse'
            examples:
              RCS provider Launched:
                summary: RCS provider Launched
                value:
                  results:
                  - event: RCS_SENDER_LAUNCH_STATUS_UPDATE
                    senderName: DemoSender
                    senderStatus: PENDING_LAUNCH
                    coverage:
                    - countryCode: US
                      providers:
                      - name: ATT
                        status: COMPLETED
                        updatedAt: 2026-01-15T16:38:24.000+0000
                    updatedAt: 2026-01-15T16:38:24.000+0000
                    platform:
                      applicationId: application-id
                      entityId: entity-id
              RCS provider Rejected:
                summary: RCS provider Rejected
                value:
                  results:
                  - event: RCS_SENDER_LAUNCH_STATUS_UPDATE
                    senderName: DemoSender
                    senderStatus: PENDING_LAUNCH
                    coverage:
                    - countryCode: US
                      providers:
                      - name: ATT
                        status: REJECTED
                        rejectionReason: 'Request rejected due to missing information: Privacy policy needs opt-out ("Text STOP to opt out"), "Message and data rates may apply" disclaimer, and frequency disclosure. Terms must include "Information will not be sold, rented, or shared" statement.'
                        updatedAt: 2026-01-15T16:38:24.000+0000
                    updatedAt: 2026-01-15T16:38:24.000+0000
                    platform:
                      applicationId: application-id
                      entityId: entity-id
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-test-number-update-events:
    post:
      tags:
      - channels
      summary: Receive an RCS test number update event
      description: "Any time you request some operation to be executed for RCS test number, that operation will be\n                executed asynchronously. After operation is executed, an event is sent. Also, status of test number could be\n                changed as a result of end user action (e.g. user has accepted an invitation to become a tester) and in these\n                situations, an event will be sent too. If you would like to receive these events, you need to subscribe to this\n                event over 'RCS' channel, and specify the 'TEST_NUMBER_UPDATE' event.\n                Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info."
      externalDocs:
        description: Learn more about the RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-test-number-update-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateWebhookResponse'
            examples:
              RCS test number update event:
                summary: RCS test number update event
                value:
                  results:
                  - event: RCS_TEST_NUMBER_STATUS_UPDATE
                    senderName: DemoSender
                    testNumber: '+441134960002'
                    senderStatus: LAUNCHED
                    testNumberStatus: APPROVED
                    updatedAt: 2025-02-23T15:11:39.000+0000
                    completedAt: 2025-02-23T15:11:39.000+0000
                    platform:
                      applicationId: application-id
                      entityId: entity-id
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-rcs-message-template-update-events:
    post:
      tags:
      - channels
      summary: Receive an RCS template update
      description: "For each message template you create, we can send you updates.\n            For this to work you need to configure subscriptions.\n            Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management)\n            for additional info. Available only for senders that support templates."
      externalDocs:
        description: Learn more about the RCS channel and use cases
        url: https://www.infobip.com/docs/rcs
      operationId: receive-rcs-message-template-update-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateUpdateEvent'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-omni-failover-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive delivery status report
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyUrl` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.
      operationId: receive-omni-failover-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: 1dece649-6c8f-404e-8c6e-c7e073be509a
                    messageId: fb469d73-d362-463f-b30f-1e959b53badc
                    to: '41793026731'
                    sentAt: 2023-04-06T15:22:37.413+0000
                    doneAt: 2023-04-06T15:22:37.437+0000
                    messageCount: 1
                    price:
                      pricePerMessage: 0.21
                      currency: BRL
                    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
                    channel: WHATSAPP
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-omni-failover-message-seen-reports:
    post:
      tags:
      - channels
      summary: Receive seen reports
      description: For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Once the setup is complete, we will be able to deliver the [reports](https://www.infobip.com/docs/essentials/response-status-and-error-codes) to you in real time. Alternatively you can specify the endpoint per each message via the `notifyUrl` parameter. Contact support@infobip.com if you require help. Use one URL for all report types.
      operationId: receive-omni-failover-message-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.SeenReports'
            examples:
              Seen reports:
                summary: Seen reports
                value:
                  results:
                  - messageId: 1215f543ab19-345f-adbd-12ad31451ed25f35
                    from: '385919998888'
                    to: '41793026731'
                    sendAt: 2023-04-05T11:21:57.793+0000
                    seenAt: 2023-04-05T11:22:10.251+0000
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-omni-failover-inbound-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded in real time to the end-point client provided during the setup. This way, 2-way communication will be established, and the enterprise is enabled to create a certain logic for processing incoming messages.
      operationId: receive-omni-failover-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.ottReportResponse'
            examples:
              Received WhatsApp TEXT message:
                summary: Received WhatsApp TEXT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2019-07-19T11:23:26.998+0000
                    messageId: ABEGOFl3VCQoAhBalbc6rTQT6mgS29EmGZ7a
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: TEXT
                      text: Support hello
                    contact:
                      name: Frank
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp IMAGE message:
                summary: Received WhatsApp IMAGE message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2018-09-10T11:27:17.980+0000
                    messageId: ABEGOFkWA5EBAgo6B82cNiWIAMKC
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: IMAGE
                      caption: Image Caption
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                    price:
                      pricePerMessage: 0.0
                      currency: HRK
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp STICKER message:
                summary: Received WhatsApp STICKER message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2018-09-10T11:27:17.980+0000
                    messageId: ABEGOFkWA5EBAgo6B82cNiWIAMKC
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: STICKER
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/f1b96d31-9ab9-4513-808b-50ab37360fbe
                    price:
                      pricePerMessage: 0.0
                      currency: HRK
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp AUDIO message:
                summary: Received WhatsApp AUDIO message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: AUDIO
                      url: https://{base_url/whatsapp/1/senders/551140038883/media/cb5608eb-aa38-454f-a045-899df74324e2
                    price:
                      pricePerMessage: 0.0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp VIDEO message:
                summary: Received WhatsApp VIDEO message
                value:
                  results:
                  - from: '385918889999'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2019-09-24T12:21:06.486+0000
                    messageId: ABEGOFmJJRkFAhDvgHvPWYmCNKXZSQaqgH2A
                    pairedMessageId: null
                    callbackData: null
                    message:
                      caption: Look at this!
                      type: VIDEO
                      url: https://{base_url}/whatsapp/1/senders/447860098731/media/42f076b9-1d1e-4d56-8c1e-02d0a402a1e3
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp DOCUMENT message:
                summary: Received WhatsApp DOCUMENT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2018-09-10T12:10:18.379+0000
                    messageId: ABEGOFkWA5EBAgo6B82cNiWIAMKC
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: DOCUMENT
                      caption: Document caption
                      url: https://{base_url}/whatsapp/1/senders/447796344125/media/c256e11d-a7e9-4dbb-aa9c-2a6028ddf7e8
                    price:
                      pricePerMessage: 0.0
                      currency: HRK
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp LOCATION message:
                summary: Received WhatsApp LOCATION message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2018-09-10T12:13:53.864+0000
                    messageId: ABEGOFkWA5EBAgo6B82cNiWIAMKC
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: LOCATION
                      longitude: -73.985655555556
                      latitude: 40.748433333333
                      name: Empire State Building
                      url: https://www.facebook.com/113272675352744
                      address: 350 5th Ave, New York, NY
                    price:
                      pricePerMessage: 0.0
                      currency: HRK
                  messageCount: 1
                  pendingMessageCount: 1
              Received WhatsApp VOICE message:
                summary: Received WhatsApp VOICE message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2020-02-04T20:42:48.790+0000
                    messageId: ABEGVUGWh3gEAgo6XoxYzF6sEhdys
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: VOICE
                      url: https://{base_url}/whatsapp/1/senders/554332947008/media/a852fb92-8506-4c3d-aab2-81bf436786e6
                    price:
                      pricePerMessage: 0.0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 1113
              Received WhatsApp CONTACT message:
                summary: Received WhatsApp CONTACT message
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2019-09-24T10:07:04.070+0000
                    messageId: ABEGOFmJJRkFAhA7ud6mcWKmglIlIO6xibx9
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: CONTACT
                      contacts:
                      - name:
                          firstName: Frank
                          lastName: Bipper
                          formattedName: Frank Bipper
                        org:
                          company: Infobip
                        phones:
                        - phone: +385 91 888 9999
                          type: CELL
                          waId: '385918889999'
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received WhatsApp TEXT message with Identity notification:
                summary: Received WhatsApp TEXT message with Identity notification
                value:
                  results:
                  - from: '385919998888'
                    to: '41793026731'
                    integrationType: WHATSAPP
                    receivedAt: 2019-07-19T11:23:26.998+0000
                    messageId: ABEGOFl3VCQoAhBalbc6rTQT6mgS29EmGZ7a
                    pairedMessageId: null
                    callbackData: null
                    message:
                      type: TEXT
                      text: Support hello
                    identity:
                      createdAt: 2020-01-01T00:00:00.000+0000
                      acknowledged: true
                      hash: eU2Fdi4EMUw=
                    contact:
                      name: Frank
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received Viber TEXT message:
                summary: Received Viber TEXT message
                value:
                  results:
                  - from: '385912345678'
                    to: givenClient
                    integrationType: VIBER
                    receivedAt: 2020-04-01T11:02:43.594+0000
                    messageId: '1234567890123456789'
                    pairedMessageId: null
                    callbackData: null
                    message:
                      text: givenText
                      type: TEXT
                    price:
                      pricePerMessage: 36.666667
                      currency: RUB
                  messageCount: 1
                  pendingMessageCount: 1
              Received Viber FILE message:
                summary: Received Viber FILE message
                value:
                  results:
                  - from: '385912345678'
                    to: givenClient
                    integrationType: VIBER
                    receivedAt: 2020-04-01T11:02:43.594+0000
                    messageId: '1234567890123456789'
                    pairedMessageId: null
                    callbackData: null
                    message:
                      url: https://example.com/givenUrl.pdf
                      fileName: givenFileName
                      trackingData: givenTrackingData
                      type: FILE
                    price:
                      pricePerMessage: 36.666667
                      currency: RUB
                  messageCount: 1
                  pendingMessageCount: 1
              Received Facebook message:
                summary: Received Facebook message
                value:
                  results:
                  - from: '1234567891234567'
                    to: '987654321987654'
                    integrationType: FACEBOOK
                    receivedAt: 2020-03-31T16:13:59.142+0000
                    messageId: m_Bb2C5U8lYXqoN8ASsoi58LW9ID_zBzKWkzEmnthGcWOhCCK9r93h7onrN5HHvWtF9C4BzitxUtXQbtzCg3xNsw
                    pairedMessageId: null
                    callbackData: null
                    message:
                      text: givenText
                      type: TEXT
                    price:
                      pricePerMessage: 0.0
                      currency: MMK
                  messageCount: 1
                  pendingMessageCount: 845
      responses:
        '200':
          description: Your server returns this code if it accepts the callback
  receive-inbound-livechat-messages:
    post:
      tags:
      - channels
      summary: Receive Livechat inbound messages
      description: Set up the logic for processing incoming messages to enable customized two-way communication. Inbound messages will be forwarded in real-time to the specified endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number by specifying your endpoint, and we will send inbound Live Chat messages to you.<br/>The name of the default format or renderer for the inbound Live Chat messages is `MO_OTT_CONTACT`, and is documented in this section.
      externalDocs:
        description: Learn more about the Live Chat channel and use cases.
        url: https://www.infobip.com/docs/live-chat
      operationId: receive-inbound-livechat-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessages'
            examples:
              Received text message example:
                summary: Received text message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      text: givenText
                      type: TEXT
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received audio message example:
                summary: Received audio message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      url: https://d3131dgcggnrk5.cloudfront.net/infobiplivechat/C075EA09-80A1-43A4-AF46-0DD60F530DD8?Expires=1729697709&Signature=LH2DOVOw77R292MEJ1uq-BA6xuJkmEPc~kzQYk9tRHJLfDGe8xd2o~Cl1MlA45WI8c7K5som4~4coA496UJBeaJABrV~aFxjpOXrl6riMjqa355Xii~wKU70tMOY5L4tDFfaR6tNWuGYy~Nh~2PIZDdQUxngeyonCwL20Z92rpbsKQYt1sly6WJD4W0ISswcFr8acO47E-JzGBF2AwDMJ7sdaruknIZsCPOEfx9ClX98AuL78jZ0OE1iaNbu7xqt~krhZb4IWX9aBjxZXquHHj5PtZ25DO5e0rJljt~3IZYZ7u4LKV~pwuGExTaS4BcT4WBiuwk6AuTOT4Bd0ae4BQ__&Key-Pair-Id=APKAJKBXNLXMS4C35KIQ
                      id: C075EA09-80A1-43A4-AF46-0DD60F530DD8
                      type: AUDIO
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received video message example:
                summary: Received video message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      url: https://d3131dgcggnrk5.cloudfront.net/infobiplivechat/C075EA09-80A1-43A4-AF46-0DD60F530DD8?Expires=1729697709&Signature=LH2DOVOw77R292MEJ1uq-BA6xuJkmEPc~kzQYk9tRHJLfDGe8xd2o~Cl1MlA45WI8c7K5som4~4coA496UJBeaJABrV~aFxjpOXrl6riMjqa355Xii~wKU70tMOY5L4tDFfaR6tNWuGYy~Nh~2PIZDdQUxngeyonCwL20Z92rpbsKQYt1sly6WJD4W0ISswcFr8acO47E-JzGBF2AwDMJ7sdaruknIZsCPOEfx9ClX98AuL78jZ0OE1iaNbu7xqt~krhZb4IWX9aBjxZXquHHj5PtZ25DO5e0rJljt~3IZYZ7u4LKV~pwuGExTaS4BcT4WBiuwk6AuTOT4Bd0ae4BQ__&Key-Pair-Id=APKAJKBXNLXMS4C35KIQ
                      caption: Video caption
                      id: C075EA09-80A1-43A4-AF46-0DD60F530DD8
                      type: VIDEO
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received image message example:
                summary: Received image message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      url: https://d3131dgcggnrk5.cloudfront.net/infobiplivechat/C075EA09-80A1-43A4-AF46-0DD60F530DD8?Expires=1729697709&Signature=LH2DOVOw77R292MEJ1uq-BA6xuJkmEPc~kzQYk9tRHJLfDGe8xd2o~Cl1MlA45WI8c7K5som4~4coA496UJBeaJABrV~aFxjpOXrl6riMjqa355Xii~wKU70tMOY5L4tDFfaR6tNWuGYy~Nh~2PIZDdQUxngeyonCwL20Z92rpbsKQYt1sly6WJD4W0ISswcFr8acO47E-JzGBF2AwDMJ7sdaruknIZsCPOEfx9ClX98AuL78jZ0OE1iaNbu7xqt~krhZb4IWX9aBjxZXquHHj5PtZ25DO5e0rJljt~3IZYZ7u4LKV~pwuGExTaS4BcT4WBiuwk6AuTOT4Bd0ae4BQ__&Key-Pair-Id=APKAJKBXNLXMS4C35KIQ
                      caption: Image caption
                      id: C075EA09-80A1-43A4-AF46-0DD60F530DD8
                      type: IMAGE
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received document message example:
                summary: Received document message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      url: https://d3131dgcggnrk5.cloudfront.net/infobiplivechat/C075EA09-80A1-43A4-AF46-0DD60F530DD8?Expires=1729697709&Signature=LH2DOVOw77R292MEJ1uq-BA6xuJkmEPc~kzQYk9tRHJLfDGe8xd2o~Cl1MlA45WI8c7K5som4~4coA496UJBeaJABrV~aFxjpOXrl6riMjqa355Xii~wKU70tMOY5L4tDFfaR6tNWuGYy~Nh~2PIZDdQUxngeyonCwL20Z92rpbsKQYt1sly6WJD4W0ISswcFr8acO47E-JzGBF2AwDMJ7sdaruknIZsCPOEfx9ClX98AuL78jZ0OE1iaNbu7xqt~krhZb4IWX9aBjxZXquHHj5PtZ25DO5e0rJljt~3IZYZ7u4LKV~pwuGExTaS4BcT4WBiuwk6AuTOT4Bd0ae4BQ__&Key-Pair-Id=APKAJKBXNLXMS4C35KIQ
                      caption: Document caption
                      id: C075EA09-80A1-43A4-AF46-0DD60F530DD8
                      type: DOCUMENT
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received survey response message example:
                summary: Received survey response message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      surveySatisfaction: SATISFIED
                      message: Thank you for your help!
                      type: SURVEY_RESPONSE
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received bundled message example:
                summary: Received bundled message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      inboundMessage:
                        text: Start the chat
                        type: TEXT
                      outboundMessages:
                      - content:
                          suggestedReplies:
                          - Start the chat
                          source:
                            text: Hello, how can we help you?
                            type: TEXT
                          reply: Start the chat
                          type: QUICK_REPLY
                        momentMillis: 1727105627
                      type: BUNDLE
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Received Cards Button message example:
                summary: Received Cards Button message example
                value:
                  results:
                  - from: ad2086a7-a1ce-40d7-bef0-3f5f4cb2e83b
                    to: 7f45afb8-0920-4ecd-87f8-a1f8b02225dd
                    integrationType: LIVE_CHAT
                    receivedAt: 2024-09-19T11:52:00.000+0000
                    messageId: pmlado1c:msg-95d12702-1162-49fd-af74-3d570dbbc20b:fc0ee343-91ea-4b7d-b53c-381fa58e01ac
                    message:
                      inboundMessage:
                        text: Information about services
                        payloadType: POSTBACK
                        payload: servicesInfo
                        type: BUTTON_RESPONSE
                      outboundMessages:
                      - content:
                          text: Hello, how can we help you?
                          url: ''
                          buttonPayloads:
                          - title: Information about products
                            type: POSTBACK
                            payload: productsInfo
                          - title: Information about services
                            type: POSTBACK
                            payload: servicesInfo
                          type: LIVE_CHAT_BUTTON
                        momentMillis: 1727105627
                      type: BUNDLE
                    threadId: 26756aab-d4eb-4f87-84df-73b61f8c0840
                    currentLanguage: en-US
                    userData:
                      cdpPersonId: 10313
                      userIdentity:
                        identityType: EMAIL
                        identityValue: user@example.com
                        pushRegistrationId: 40ECB0DE-A338-41F4-9F61-E49495738191
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-apple-mfb-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Apple Messages for Business delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Apple Messages for Business channel and use cases
        url: https://www.infobip.com/docs/apple-messages-for-business
      operationId: receive-outbound-apple-mfb-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value:
                  results:
                  - bulkId: '1688025180464000013'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: '1688025180464000014'
                    to: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    sender: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports'
            examples:
              Delivery report:
                summary: Delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>1688025180464000013</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>1688025180464000014</messageId>\n      <to>a42fa0e0-1d5f-44f6-a321-0e40300f7712</to>\n      <sender>urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-messages-apple-mfb-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Apple Messages for Business channel and use cases
        url: https://www.infobip.com/docs/apple-messages-for-business
      operationId: receive-messages-apple-mfb-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundResponse'
            examples:
              Text message response example:
                summary: Text message response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      text: Text
                      attachments:
                      - fileName: filename
                        downloadId: downloadId
                        url: http://image.url
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Typing Indicator response example:
                summary: Typing Indicator response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      typingIndicatorType: TYPING_START
                      type: TYPING_INDICATOR
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              List Picker response example:
                summary: List Picker response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      listPickerSelectedItems:
                      - title: item title
                        identifier: selectedIdentifier
                      type: LIST_PICKER_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Time Picker response example:
                summary: Time Picker response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      selectedTime: 2023-05-29T00:00:00.000+0000
                      selectedDuration: 30
                      timezoneOffset: 1
                      selectedTimeslotIdentifier: identifier
                      type: TIME_PICKER_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Authentication response example:
                summary: Authentication response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      authenticated: true
                      authenticationCode: auth_code
                      errorCode: 0
                      type: AUTHENTICATION_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Apple Pay response example:
                summary: Apple Pay response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      paid: true
                      lineItems:
                      - type: type
                        label: label
                        amount: '1'
                      total:
                        type: type
                        label: label
                        amount: '1'
                      type: APPLE_PAY_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Custom Interactive response example:
                summary: Custom Interactive response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      urlData:
                      - name: param1
                        value: value1
                      - name: param2
                        value: value2
                      urlRawData: param1,value1
                      sessionIdentifier: givenSessionIdentifier
                      attachments:
                      - fileName: filename
                        downloadId: downloadId
                        url: http://image.url
                      type: CUSTOM_INTERACTIVE_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Close Conversation response example:
                summary: Close Conversation response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      type: CLOSE_CONVERSATION
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Quick Reply response example:
                summary: Quick Reply response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      quickReplySelectedItem:
                        identifier: quick_reply_id
                        title: title
                      type: QUICK_REPLY
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Form response example:
                summary: Form response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      privateForm: true
                      selections:
                      - pageIdentifier: pageIdentifier
                        subtitle: subtitle
                        item:
                          title: title
                          value: value
                        type: INPUT
                      type: FORM_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
              Invitation response example:
                summary: Invitation response example
                value:
                  results:
                  - sender: a42fa0e0-1d5f-44f6-a321-0e40300f7712
                    to: urn:mbid:AQAAY9Jnpv/q1IF4WbOLgbiYgFXChjL7cr/rXgVCLG5fZbaG5izE6Wh/U6Hkh0bdBtXHijppErU/Pc2m1R+ZChHIHbgEVFY9bIGIrNrZuUZxdv6IPPoCc1h3bHaqQpJVmA336yywH/vqxBZwQoT7YMETabM+8es=
                    integrationType: APPLE_BC
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: '1688025180464000014'
                    callbackData: callbackData
                    message:
                      context:
                        intent: Intent
                        group: group
                        locale: en_UK
                        capabilityList:
                        - AUTHENTICATION_REQUEST
                        - FORM
                        - LIST_PICKER
                        - QUICK_REPLY
                        - TIME_PICKER
                      requestIdentifier: givenRequestIdentifier
                      choice: 'YES'
                      type: INVITATION_RESPONSE
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-outbound-instagram-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Instagram delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Instagram channel and use cases
        url: https://www.infobip.com/docs/instagram
      operationId: receive-outbound-instagram-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '2034072219640523072'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                    to: '66855538125'
                    sender: '44113496000'
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>2034072219640523072</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <to>66855538125</to>\n      <sender>44113496000</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-instagram-api-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Instagram channel and use cases
        url: https://www.infobip.com/docs/instagram
      operationId: receive-instagram-api-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundResponse'
            examples:
              Received Instagram DM message:
                summary: Received Instagram DM message
                value:
                  results:
                  - sender: '6662136340512053'
                    to: '17841447570021717'
                    integrationType: INSTAGRAM_DM
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    messageId: aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDQ3NTcwMDIxODE4OjM0MDI4MjM2Njg0MTcxMDMwMTI0NDI3NjAxOTkzMzk2MzExNTc2NjozMTE3ODY3NTY2NDU5MzAzNzQ2NzUxNzQ2NTAzODY4NDE2MAZbcd
                    message:
                      mid: aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDQ3NTcwMDIxODE4OjM0MDI4MjM2Njg0MTcxMDMwMTI0NDI3NjAxOTkzMzk2MzExNTc2NjozMTE3ODY3NTY2NDU5MzAzNzQ2NzUxNzQ2NTAzODY4NDE2MAZfdf
                      text: Hello
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-outbound-messenger-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Messenger delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: receive-outbound-messenger-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '1688025180464000013'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: '1688025180464000014'
                    to: '66855538125'
                    sender: '44113496000'
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>1688025180464000013</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>1688025180464000014</messageId>\n      <to>66855538125</to>\n      <sender>44113496000</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-messenger-seen-reports:
    post:
      tags:
      - channels
      summary: Receive seen reports
      description: For each message that you send out, we can send you a seen report. For this to work you need to have an endpoint to forward the reports to. Please provide the endpoint’s URL to Customer support and they will set it up for you. Alternatively, you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.
      operationId: receive-messenger-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReports'
            examples:
              Seen report:
                summary: Seen report
                value:
                  results:
                  - messageId: 1215f543ab19-345f-adbd-12ad31451ed25f35
                    from: '6662136340512053'
                    to: '17841447570021717'
                    sentAt: 2026-06-07T11:21:57.793+0000
                    seenAt: 2026-06-07T11:22:10.251+0000
                    applicationId: example-application-id
                    entityId: example-entity-id
                    campaignReferenceId: campaignRefId
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-messenger-marketing-click:
    post:
      tags:
      - channels
      summary: Receive Messenger Marketing Click event
      description: Event is sent when a person clicks a Marketing Message. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/messenger
      operationId: receive-messenger-marketing-click
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MarketingMessageClick'
            examples:
              Clicked event:
                summary: Clicked event
                value:
                  notificationType: MARKETING_CLICK
                  from: '1111111111111111111'
                  to: '111222333444555'
                  messageId: '222222222222'
                  campaignId: '123456789'
                  clickedAt: 2026-07-18T00:00:00.000+0000
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-messenger-api-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/facebook-messenger
      operationId: receive-messenger-api-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundRequest'
            examples:
              Received Messenger message:
                summary: Received Messenger message
                value:
                  results:
                  - sender: '6662136340512053'
                    to: '17841447570021717'
                    receivedAt: 2023-01-01T00:00:00.000+0000
                    message:
                      mid: aWdfZAG1faXRlbToxOklHTWVzc2FnZAUlEOjE3ODQxNDQ3NTcwMDIxODE4OjM0MDI4MjM2Njg0MTcxMDMwMTI0NDI3NjAxOTkzMzk2MzExNTc2NjozMTE3ODY3NTY2NDU5MzAzNzQ2NzUxNzQ2NTAzODY4NDE2MAZfdf
                      text: Hello
                      type: TEXT
                  messageCount: 1
                  pendingMessageCount: 0
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-messenger-consent-update:
    post:
      tags:
      - channels
      summary: Receive Messenger consent update event
      description: 'Event is sent when the person opts in or opts out of Marketing Messages. The `event` field indicates the type: `SUBSCRIBE` for opt-in, `UNSUBSCRIBE` for opt-out. For this to work you need to configure subscriptions. Refer to [Subscriptions Management](https://www.infobip.com/docs/cpaas-x/subscriptions-management) for additional info. <br/> Collecting subscription tokens still works on the Messenger platform. However, marketing messages on Messenger are no longer available for new users. For existing users, this feature will be deprecated on January 12, 2026. After this date, marketing messages will no longer be supported.'
      externalDocs:
        description: Learn more about Messenger channel and use cases
        url: https://www.infobip.com/docs/messenger
      operationId: receive-messenger-consent-update
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdate'
            examples:
              Opt-in (SUBSCRIBE):
                summary: Opt-in (SUBSCRIBE)
                value:
                  results:
                  - channel: MESSENGER
                    event: SUBSCRIBE
                    sender: '112345678901234'
                    from: '6662136340512053'
                    createdAt: 2024-01-14T12:00:00.000+0000
                    channelData:
                      notificationMessagesToken: '5049615565024480819'
                      tokenExpiry: 2030-01-01T00:00:00.000+0000
                      userTokenStatus: REFRESHED
                      notificationMessagesTimezone: Europe/Warsaw
                      subscriptionPayload: promo_campaign_v2
                      subscriptionTitle: Get weekly deals
              Opt-out (UNSUBSCRIBE):
                summary: Opt-out (UNSUBSCRIBE)
                value:
                  results:
                  - channel: MESSENGER
                    event: UNSUBSCRIBE
                    sender: '112345678901234'
                    from: '6662136340512053'
                    createdAt: 2024-02-01T09:00:00.000+0000
                    channelData:
                      notificationMessagesToken: '5049615565024480819'
                      tokenExpiry: 2030-01-01T00:00:00.000+0000
                      userTokenStatus: NOT_REFRESHED
                      subscriptionPayload: promo_campaign_v2
                      subscriptionTitle: Get weekly deals
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-outbound-kakao-alim-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Kakao Alim delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Kakao Alim channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#alim-talk
      operationId: receive-outbound-kakao-alim-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '2034072219640523072'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                    to: '66855538125'
                    sender: '44113496000'
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>2034072219640523072</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>2250be2d4219-3af1-78856-aabe-1362af1edfd2</messageId>\n      <to>66855538125</to>\n      <sender>44113496000</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-outbound-kakao-sangdam-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive Kakao Sangdam delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about Kakao Sangdam channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#sangdam-talk
      operationId: receive-outbound-kakao-sangdam-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value:
                  results:
                  - bulkId: '1688025180464000013'
                    price:
                      pricePerMessage: 0.15
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: '1688025180464000014'
                    to: '66855538125'
                    sender: OFFICIAL-ACCOUNT-ID-123
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    mccMnc: '22801'
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports'
            examples:
              Delivery reports:
                summary: Delivery reports
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>1688025180464000013</bulkId>\n      <price>\n        <pricePerMessage>0.15</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>1688025180464000014</messageId>\n      <to>66855538125</to>\n      <sender>OFFICIAL-ACCOUNT-ID-123</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <mccMnc>22801</mccMnc>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-kakao-sangdam-api-incoming-messages:
    post:
      tags:
      - channels
      summary: Receive incoming message
      description: Incoming messages will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about the Kakao Sangdam and use cases
        url: https://www.infobip.com/docs/api/channels/kakao/sangdam
      operationId: receive-kakao-sangdam-api-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-outbound-kakao-chingu-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive brand message delivery reports
      description: For each message that you send out, we can send you a delivery report. For this to work you need to have an endpoint to forward the reports to. Please specify the endpoint per each message via the `webhooks > delivery > url` parameter. Alternatively, you can provide the endpoint’s URL to Customer support and they will set it up for you. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about brand message channel and use cases
        url: https://www.infobip.com/docs/kakaotalk/message-types#chingu-talk
      operationId: receive-outbound-kakao-chingu-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports'
          application/xml:
            schema:
              $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-open-channel-outbound-message:
    post:
      tags:
      - channels
      summary: Receive Open Channel outbound Message
      description: Set up logic for processing outbound messages to customize two-way communication. Outbound messages are forwarded in real time to the endpoint provided during the account setup.
      operationId: receive-open-channel-outbound-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.WebhookRequest'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-outbound-tiktok-message-delivery-reports:
    post:
      tags:
      - channels
      summary: Receive TikTok delivery reports
      description: Use this webhook to receive delivery reports for outbound TikTok messages. To receive delivery reports, configure the webhook URL for each message by using the `webhooks > delivery > url` parameter. Alternatively, contact [Support](mailto:support@infobip.com) to configure the webhook URL for you.
      externalDocs:
        description: Learn more about the TikTok channel and its use cases
        url: https://www.infobip.com/docs/tiktok
      operationId: receive-outbound-tiktok-message-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports'
            examples:
              Received report:
                summary: Received report
                value:
                  results:
                  - bulkId: a28dd97c-2222-4fcf-99f1-0b557ed381da
                    price:
                      pricePerMessage: 0.01
                      currency: EUR
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    sender: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    sentAt: 2023-09-26T10:52:15.457+0000
                    doneAt: 2023-09-26T10:52:15.799+0000
                    messageCount: 1
                    platform:
                      entityId: promotional-traffic-entity
                      applicationId: marketing-automation-application
          application/xml:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports'
            examples:
              Received report:
                summary: Received report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><DeliveryReports>\n  <results>\n    <result>\n      <bulkId>a28dd97c-2222-4fcf-99f1-0b557ed381da</bulkId>\n      <price>\n        <pricePerMessage>0.01</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n      <status>\n        <groupId>3</groupId>\n        <groupName>DELIVERED</groupName>\n        <id>5</id>\n        <name>DELIVERED_TO_HANDSET</name>\n        <description>Message delivered to handset</description>\n      </status>\n      <error>\n        <groupId>0</groupId>\n        <groupName>OK</groupName>\n        <id>0</id>\n        <name>NO_ERROR</name>\n        <description>No Error</description>\n        <permanent>false</permanent>\n      </error>\n      <messageId>a28dd97c-1ffb-4fcf-99f1-0b557ed381da</messageId>\n      <to>u5NkbnslAgxpOelvH01Y+rs7Uw=</to>\n      <sender>-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o</sender>\n      <sentAt>2023-09-26T10:52:15.457+0000</sentAt>\n      <doneAt>2023-09-26T10:52:15.799+0000</doneAt>\n      <messageCount>1</messageCount>\n      <platform>\n        <entityId>promotional-traffic-entity</entityId>\n        <applicationId>marketing-automation-application</applicationId>\n      </platform>\n    </result>\n  </results>\n</DeliveryReports>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-tiktok-seen-reports:
    post:
      tags:
      - channels
      summary: Receive TikTok seen reports
      description: Use this webhook to receive seen reports for outbound TikTok messages. To receive seen reports, configure the webhook URL for each message by using the `webhooks > seen > url` parameter. Alternatively, contact [Support](mailto:support@infobip.com) to configure the webhook URL for you.
      operationId: receive-tiktok-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReports'
            examples:
              Received seen report:
                summary: Received seen report
                value:
                  results:
                  - messageId: 45db39c3-7822-4e72-a3ec-c87442c0ffz9
                    from: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    to: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    sentAt: 2019-11-09T16:00:00.000+0000
                    seenAt: 2019-11-09T16:00:05.000+0000
                    applicationId: marketing-automation-application
                    entityId: promotional-traffic-entity
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-inbound-tiktok-messages:
    post:
      tags:
      - channels
      summary: Receive an inbound TikTok message
      description: Use this webhook to receive inbound TikTok messages in real time. Infobip forwards messages to the webhook URL configured during account setup, so you can process them and continue two-way conversations. The default format for inbound TikTok messages is `MO_OTT_MSISDN`.
      externalDocs:
        description: Learn more about the TikTok channel and its use cases
        url: https://www.infobip.com/docs/api/channels/tiktok
      operationId: receive-inbound-tiktok-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundMessage'
            examples:
              Received inbound message:
                summary: Received inbound message
                value:
                  results:
                  - sender: u5NkbnslAgxpOelvH01Y+rs7Uw=
                    to: -000pcMJDSDHK-UvK012b10KKXmCvWmVF8o
                    integrationType: TIKTOK
                    receivedAt: 2019-11-09T16:00:00.000+0000
                    messageId: a28dd97c-1ffb-4fcf-99f1-0b557ed381da
                    message:
                      conversationId: u5NkbnslAgxpOelvH01Y+rs7Uw=
                      text: Hello!
                      type: TEXT
                    price:
                      pricePerMessage: 0
                      currency: EUR
                  messageCount: 1
                  pendingMessageCount: 0
          application/xml:
            schema:
              $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundMessage'
            examples:
              Received inbound message:
                summary: Received inbound message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><TikTokInboundMessage>\n  <messageCount>1</messageCount>\n  <pendingMessageCount>0</pendingMessageCount>\n  <results>\n    <result>\n      <sender>u5NkbnslAgxpOelvH01Y+rs7Uw=</sender>\n      <to>-000pcMJDSDHK-UvK012b10KKXmCvWmVF8o</to>\n      <integrationType>TIKTOK</integrationType>\n      <receivedAt>2019-11-09T16:00:00.000+0000</receivedAt>\n      <messageId>a28dd97c-1ffb-4fcf-99f1-0b557ed381da</messageId>\n      <message>\n        <conversationId>u5NkbnslAgxpOelvH01Y+rs7Uw=</conversationId>\n        <text>Hello!</text>\n      </message>\n      <price>\n        <pricePerMessage>0</pricePerMessage>\n        <currency>EUR</currency>\n      </price>\n    </result>\n  </results>\n</TikTokInboundMessage>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
components:
  schemas:
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBodyType:
      type: string
      enum:
      - TEXT
      - JSON
      - AUDIO
      - IMAGE
      - FILE
      title: OpenChannelMessageBodyType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        mediaUrl:
          type: string
          description: URL of an image sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported image types are `JPG`, `JPEG`, `PNG`. Maximum image size is 5MB.
          maxLength: 2048
          minLength: 1
        caption:
          type: string
          description: Caption of the image.
          maxLength: 3000
          minLength: 0
      required:
      - mediaUrl
      title: ImageContent
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogBroadcastWebrtcTextRequest:
      type: object
      properties:
        text:
          type: string
          description: Text to broadcast.
      title: DialogBroadcastWebrtcTextRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode:
      type: string
      description: The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.
      enum:
      - NONE
      - TURKISH
      - GREEK
      - CYRILLIC
      - SERBIAN_CYRILLIC
      - CENTRAL_EUROPEAN
      - BALTIC
      - NON_UNICODE
      - PORTUGUESE
      - COLOMBIAN
      - BULGARIAN_CYRILLIC
      - ALL
      title: TransliterationCode
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    255235e6822dc92d5cc7957b8b662dded0a769ad7b7082a765f4f30895636e11.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    8cb345d2b2e2a0cd5a7383bf2012768938eaa465c6e4f6554958ac7f4a58aa3f.V1TemplatePublicApiRequest:
      type: object
      properties:
        name:
          type: string
          description: Template name. Must only contain lowercase alphanumeric characters and underscores.
        language:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language'
        category:
          type: string
          description: All listed categories will be available until May 1, 2023.
          enum:
          - ACCOUNT_UPDATE
          - PAYMENT_UPDATE
          - PERSONAL_FINANCE_UPDATE
          - SHIPPING_UPDATE
          - RESERVATION_UPDATE
          - ISSUE_RESOLUTION
          - APPOINTMENT_UPDATE
          - TRANSPORTATION_UPDATE
          - TICKET_UPDATE
          - ALERT_UPDATE
          - AUTO_REPLY
          example: ACCOUNT_UPDATE
        structure:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData'
      required:
      - category
      - language
      - name
      - structure
      title: TemplateRequest
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Direction:
      type: string
      description: Call direction.
      enum:
      - INBOUND
      - OUTBOUND
      title: Direction
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReport'
      title: RcsWebhookDeliveryReports
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status:
      type: object
      description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        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.
        action:
          type: string
          description: Action that should be taken to eliminate the error.
      title: Status
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Context:
      type: object
      description: Information about the message to which the end user responded.
      properties:
        id:
          type: string
          description: MessageId of the message to which the end user responded.
          readOnly: false
          writeOnly: true
        from:
          type: string
          description: End user's phone number.
          readOnly: false
          writeOnly: true
        referredProduct:
          $ref: '#/components/schemas/033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514.ReferredProduct'
      title: Context
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.MoReport:
      type: object
      discriminator:
        propertyName: integrationType
        mapping:
          WHATSAPP: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData'
          VIBER: '#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport'
          FACEBOOK: '#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport'
      oneOf:
      - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData'
      - $ref: '#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport'
      - $ref: '#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport'
      title: MoReport
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: Identifier of an RCS sender that will be used to send message.
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedWebhooksWithSeen'
      required:
      - content
      - destinations
      title: RcsMessage
    e7089e7463ca9bbf5ccd1fc35b7db93dfead631972de2930bb5def17a2b45bf6.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateRequest:
      type: object
      properties:
        sender:
          type: string
          description: Must be provided if senderGroup is not provided.
          maxLength: 40
          minLength: 1
        senderGroup:
          type: string
          description: Must be provided if sender is not provided.
          maxLength: 40
          minLength: 1
        name:
          type: string
          description: Template name.
          maxLength: 200
          minLength: 1
        isAdult:
          type: boolean
          default: false
          description: Indicates whether the recipient is an adult.
        templateContent:
          $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent'
      required:
      - name
      - templateContent
      title: CreateTemplateRequest
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderPageResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBaseData'
        paging:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo'
      required:
      - paging
      - results
      title: RcsSenderPageResponse
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        sentAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
        applicationId:
          type: string
          description: Application id that the message is linked to.
        entityId:
          type: string
          description: Entity id that the message is linked to.
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: SeenReport
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage:
      type: object
      description: Billing package.
      properties:
        packageType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackageType'
        countryCode:
          type: string
          description: Country code. Currently, only `USA` is supported and required for the `UNLIMITED` package type.
          example: USA
        addressId:
          type: string
          description: ID of SIP trunk address.
      required:
      - packageType
      title: BillingPackage
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    94dad8b938c4159f751dc1ff0b70e7beab7409955ce0b31399dbe9488973d3a6.DtmfSendRequest:
      type: object
      properties:
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
        dtmf:
          type: string
          description: DTMF digits to send.
      required:
      - dtmf
      title: DtmfSendRequest
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.DialCallbackRequest:
      type: object
      description: Markup Language dial callback request object. Sent to the callback URL configured on the Dial instruction once the dial endpoint has been processed. Extends the instructions callback payload with the dial endpoint result.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        dialData:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialData'
      title: DialCallbackRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingLocation:
      type: string
      enum:
      - SAO_PAULO
      - BOGOTA
      - FRANKFURT
      - JOHANNESBURG
      - NEW_YORK
      - PORTLAND
      - MOSCOW
      - SINGAPORE
      - ISTANBUL
      - KUALA_LUMPUR
      - JAKARTA
      - MUMBAI
      - HONG_KONG
      - RIYADH
      - CHENNAI
      title: RecordingLocation
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role:
      type: object
      description: Represents the role of the call inside the conference.
      discriminator:
        propertyName: type
        mapping:
          DEFAULT: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DefaultRole'
          ADVISOR: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AdvisorRole'
          MONITOR: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MonitorRole'
          LISTENER: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ListenerRole'
          AUDITOR: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuditorRole'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RoleType'
      title: Role
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReport'
      title: DeliveryReports
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent:
      type: object
      description: Message content.
      oneOf:
      - $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent'
      - $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent'
      title: SmsMessageContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImporterAddress:
      type: object
      description: Importer address. Required when catalogId is not provided. It's supported only for UPI PayU payments.
      properties:
        firstAddressLine:
          type: string
          description: First line of the address.
        secondAddressLine:
          type: string
          description: Second line of the address.
        city:
          type: string
          description: City.
        zoneCode:
          type: string
          description: Zone code.
        postalCode:
          type: string
          description: Postal code.
        countryCode:
          type: string
          description: Country code.
      title: InteractiveOrderDetailsImporterAddress
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStream:
      type: object
      properties:
        audioProperties:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamAudioProperties'
      title: MediaStream
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice'
        status:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus'
        error:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateHeaderContent:
      type: object
      description: Media template header. Required for media templates which contain headers
      properties:
        textPlaceholder:
          type: string
          description: Text placeholder. Required for templates that contain a text header.
          writeOnly: true
        documentUrl:
          type: string
          description: Document URL. Required for templates that contain a document header.Supported document types are PDF, DOC(X), PPT(X), XLS(X). Maximum document size is 100MB.
          writeOnly: true
        documentFilename:
          type: string
          description: Document name. Required for templates that contain a document header.
          writeOnly: true
        imageUrl:
          type: string
          description: 'Image URL. Required for templates that contain an image header. Supported image types: JPG, JPEG, PNG. Maximum image size is 5MB.'
          writeOnly: true
        videoUrl:
          type: string
          description: Video URL. Required for templates that contain a video header. Supported video types are MP4, 3GPP. Maximum video size is 16MB.
          writeOnly: true
        latitude:
          type: number
          format: double
          description: Location latitude. The value must be between -90 and 90. Required for templates that contain a location header.
          maximum: 90
          minimum: -90
          writeOnly: true
        longitude:
          type: number
          format: double
          description: Location longitude. The value must be between -180 and 180. Required for templates that contain a location header.
          maximum: 180
          minimum: -180
          writeOnly: true
      required:
      - documentFilename
      - documentUrl
      - imageUrl
      - latitude
      - longitude
      - textPlaceholder
      - videoUrl
      title: MediaTemplateHeaderContent
      writeOnly: true
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange:
      type: object
      description: Change that has been applied to template.
      discriminator:
        propertyName: type
        mapping:
          TEMPLATE_STATUS_UPDATE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStatusPushEventChange'
          TEMPLATE_CATEGORY_UPDATE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateCategoryPushEventChange'
          TEMPLATE_QUALITY_UPDATE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateQualityPushEventChange'
      properties:
        type:
          type: string
          description: Type of change that has been applied to template.
          enum:
          - TEMPLATE_STATUS_UPDATE
          - TEMPLATE_CATEGORY_UPDATE
          - TEMPLATE_QUALITY_UPDATE
      required:
      - type
      title: TemplatePushEventChange
    0e82c38c2cac57841ec8a3a6ca825965cdf7afbcdea80ae147c9d99f5ab3a8c3.WebhookEventPayload:
      type: object
      properties:
        callLinkId:
          type: string
          description: Id of the used call link.
        callLinkConfigId:
          type: string
          description: Id of the call link configuration used.
        callDetails:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallDetails'
        customData:
          type: object
          additionalProperties:
            type: string
            description: Custom attributes sent in a call once it has started.
          description: Custom attributes sent in a call once it has started.
        recording:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.WebhookRecording'
        errorCode:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ErrorCode'
      title: WebhookEventPayload
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editValidityPeriod:
      type: object
      description: Template validity period in which WhatsApp will try to deliver template message to end user. Validity period can be customized between 30 seconds and 15 minutes. -1 can be used to use Meta's default message validity period. This is 24 hours for the Cloud senders and 30 days for the On-Premises. Works only for templates with `AUTHENTICATION` category. It can be only edited alongside with category or structure in the request.
      properties:
        amount:
          type: integer
          format: int32
          description: Template validity period amount.
        timeUnit:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit'
      required:
      - amount
      title: editValidityPeriod
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusContent:
      type: object
      description: Template order status. Should be defined, only if template contains order status.
      properties:
        orderStatuses:
          type: array
          description: Array of order statuses information.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent'
      required:
      - orderStatuses
      title: TemplateOrderStatusContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowTextHeaderContent'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveFlowHeaderContent
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ValidityWindow:
      type: object
      description: Description of a call link validation period and the number of times it can be used within the range.
      properties:
        oneTime:
          type: boolean
          default: false
          description: By default, call links are generated for multiple calls.If you want to limit the period for how long a link is valid, specify the start and end time. If you want to invalidate a link after establishing a call, set this value to 'true' (defaults to 'false').For ROOM calls, this value cannot be 'true'.
        startTime:
          type: string
          format: date-time
          description: 'Specify starting moment in the UTC timezone for when a call link becomes valid. Defaults to the time when a link was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
          example: '2023-01-01T08:00:00Z'
        endTime:
          type: string
          format: date-time
          description: 'Specify ending moment in the UTC timezone for when a call link becomes invalid. Default value is 24 hours after a link was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
          example: '2023-12-01T16:00:00Z'
        acceptableHours:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.AcceptableHours'
        acceptableDays:
          type: array
          description: Specify the days a link can be used. It is every day of the week, by default.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DayOfWeek'
      title: ValidityWindow
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReport'
      title: DeliveryReports
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether to enable answering machine detection. If set to true, answering machine detection will generate an event indicating if the call was answered by a human or a machine.
        messageDetectionTimeout:
          type: integer
          format: int32
          description: Indicates maximum duration for detecting the end of the message when a answering machine is detected. If set to 0, no end of message detection will be done. Expressed in seconds.
          maximum: 60
        detectionTime:
          type: number
          format: double
          default: 3.7
          description: Indicates time in seconds during which answering machine detection will analyse the call before making a decision. Shorter detection time may come at the expense of accuracy. Must be lower than `messageDetectionTimeout` if `messageDetectionTimeout` is specified.
          maximum: 5
          minimum: 1
      required:
      - enabled
      title: MachineDetectionRequest
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction:
      type: object
      description: Button with action.
      properties:
        title:
          type: string
          description: The text that will appear on the action button.
          maxLength: 30
          minLength: 1
        action:
          type: string
          description: The URL users are directed to or the action performed when pressing the action button.
          maxLength: 1000
          minLength: 0
      required:
      - action
      - title
      title: ButtonWithAction
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileRecording:
      type: object
      description: List of call recordings.
      properties:
        callId:
          type: string
          description: Id of the call.
        file:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.File'
      title: FileRecording
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SpeechOptions:
      type: object
      properties:
        language:
          type: string
          description: Language used in speech that needs to be captured. For full list of supported languages see [Supported languages](https://www.infobip.com/docs/voice-and-video/interactive-voice-response-ivr#speech-recognition-supported-languages-ivr-over-api).
        keyPhrases:
          type: array
          description: Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited.
          items:
            type: string
            description: Array of keyphrases used for matching capturing speech. If full captured text contains one of the specified phrases, that phrase will be set in variable specified in capture parameter. If keyphrases are not set or no matching is done, variable will be set to empty string. Every keyphrase can contain up to 5 words and number of keyphrases is not limited.
        maxSilence:
          type: integer
          format: int32
          description: If used, this parameter defines the number of seconds of silence that will stop capturing. For example value of 3 defines that capturing stops as soon as 3 seconds of silence is detected or when timeout expires, whichever happens first. Minimum value is 1 and maximum value is 5. The value must be lower than the timeout value.
          maximum: 5
          minimum: 1
      required:
      - language
      - maxSilence
      title: SpeechOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContentType:
      type: string
      enum:
      - RESPONSE_BUTTON
      - USER_FEEDBACK
      - FOLLOW
      - UNFOLLOW
      - TEXT
      - USER_SUBMIT_INFO
      - IMAGE
      - VIDEO
      - AUDIO
      - FILE
      - GIF
      - LINK
      - STICKER
      - LOCATION
      - BUSINESS_CARD
      - UNKNOWN
      title: ZaloInboundContentType
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.GetViberTemplatesResponse:
      type: object
      description: List of templates per page.
      properties:
        templates:
          type: array
          description: List of templates for requested page.
          items:
            $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.ViberTemplateResponseNoDates'
        paging:
          $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.Paging'
      required:
      - templates
      title: GetViberTemplatesResponse
    fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReportsResponse:
      type: object
      properties:
        results:
          type: array
          description: List of API reports
          items:
            $ref: '#/components/schemas/fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReport'
      title: ApiReportsResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice:
      type: object
      description: 'Used to define voice in which text would be synthesized. It has two parameters: _name_ and _gender_. When only _name_ is provided, then that exact voice with that name will be used to synthesize text. If only _gender_ is provided, then text is synthesized with first voice in given gender. If voice is not set, then default voice for that specific language is used.'
      properties:
        gender:
          type: string
          description: Gender of the voice. Can be `male` or `female`.
        name:
          type: string
          description: 'Name of the voice. Example: `Joanna`'
      title: Voice
    74d8b21d2b740d37eba3fa2f7296b180343b1bcffffec58c82756c7c83775e15.PublicHangupRequest:
      type: object
      description: Hangup request.
      properties:
        errorCode:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicErrorCode'
      title: PublicHangupRequest
    477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage:
      type: object
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.TextMessage'
          FILE: '#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.FileMessage'
      properties:
        type:
          $ref: '#/components/schemas/450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.Type'
      title: MoMessage
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogPlayRequest:
      type: object
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the file will be played.
        content:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent'
      required:
      - content
      title: DialogPlayRequest
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdate:
      type: object
      properties:
        results:
          type: array
          description: List of consent update results.
          items:
            $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdateResult'
      required:
      - results
      title: MessengerConsentUpdate
    4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationPageResponse:
      type: object
      properties:
        results:
          type: array
          description: List of results for this page.
          items:
            $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse'
        pageInfo:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo'
      title: PushConfigurationPageResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsActionContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      title: InteractiveButtonsContent
    6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.Recording:
      type: object
      description: Recording metadata
      properties:
        composedFiles:
          type: array
          description: Composed recording files.
          items:
            $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingFile'
        callRecordings:
          type: array
          description: Call recording data.
          items:
            $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.CallRecording'
      title: Recording
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkConfigPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig'
        paging:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo'
      title: CallLinkConfigPage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveInThreadAuthenticationRequestMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - from
      - to
      title: InteractiveInThreadAuthenticationRequestMessage
    6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPreAnswerRequest:
      type: object
      properties:
        ringing:
          type: boolean
          default: false
          description: Indicates whether to play a ringing sound on the call after pre-answering it.
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      title: PublicPreAnswerRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus:
      type: string
      description: Status of call recording.
      enum:
      - SUCCESSFUL
      - PARTIALLY_FAILED
      - FAILED
      title: RecordingStatus
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType:
      type: string
      enum:
      - CALL_ROUTING
      title: ApplicationType
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.MediaStreamConfigPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: MediaStreamConfigPage
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RegionalOptions'
        destinationMatching:
          type: array
          description: The SMS failover destination matching.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.FailoverDestinationPair'
      required:
      - text
      title: NonMsisdnSmsFailover
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SchedulingOptions:
      type: object
      description: Scheduling object that allows setting up detailed time windows within which calls can be established. Note that calling time window is set in UTC timezone.
      properties:
        startTime:
          type: string
          format: date-time
          description: Scheduling start date and time.
        callingTimeWindow:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindow'
      title: SchedulingOptions
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallsConfigurationPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: CallsConfigurationPage
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection:
      type: string
      description: 'The direction of the call. Possible values are: INBOUND, OUTBOUND.'
      enum:
      - INBOUND
      - OUTBOUND
      example: INBOUND
      title: CallDirection
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.InboundMessageZaloInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: ZaloInboundResponse
    52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.ConversionDetails:
      type: object
      description: 'Details should contain value and currency information indicating exact value of the conversion that happened. '
      properties:
        currency:
          type: string
          description: Currency of the conversion. Has to be the same as it is set on ad account.
          example: USD
        value:
          type: number
          description: Value of the conversion. Can be 0.
          example: 100
      required:
      - currency
      - value
      title: ConversionDetails
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData:
      type: object
      description: Template body.
      properties:
        text:
          type: string
          description: 'Plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}...'
        examples:
          type: array
          description: Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders.
          items:
            type: string
            description: Placeholders examples. The number of examples has to be the same as the number of placeholders. Examples cannot contain placeholders.
            writeOnly: true
          writeOnly: true
      required:
      - text
      title: BodyApiData
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationHttpRequest:
      type: object
      properties:
        applicationId:
          type: string
          default: CALL_ROUTING
          description: Identifier of the application that originated the call.
        routeId:
          type: string
          description: Identifier of the route that is used to process the call.
          example: f8fc8aca-786d-4943-9af2-e7ec01b5e80d
        callId:
          type: string
          description: Identifier of the call that is being processed.
          example: d8d84155-3831-43fb-91c9-bb897149a79d
        from:
          type: string
          description: Phone number from which the call originated from.
          example: '44790123456'
        to:
          type: string
          description: Destination phone number of the call.
          example: '44790123456'
        startTime:
          type: string
          format: date-time
          description: Timestamp representing start time of the call.
          example: '2024-01-01T10:00:00Z'
      title: UrlDestinationHttpRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceData:
      type: object
      description: Fields representing details specific for voice messages.
      properties:
        feature:
          type: string
          description: Name of the Infobip Voice service or feature.
        startTime:
          type: string
          description: 'Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        answerTime:
          type: string
          description: 'Date and time when the voice message was answered. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        endTime:
          type: string
          description: 'Date and time when the voice message was ended. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        duration:
          type: integer
          format: int32
          description: Duration of the voice message, in seconds.
        chargedDuration:
          type: integer
          format: int32
          description: Charged duration of the voice message, in seconds.
        fileDuration:
          type: number
          format: double
          description: Duration of the voice message audio file, in seconds.
        direction:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallDirection'
        dtmfCodes:
          type: string
          description: DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.
        answeredBy:
          type: string
          description: If machine detection is used, contains the result of the machine detection (`HUMAN` or `MACHINE`).
        callRecordingFileId:
          type: string
          description: Call recording file identification, if the call was recorded. Currently, populated only if the call was IVR.
        ivr:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrData'
      title: VoiceData
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CriteriaType:
      type: string
      enum:
      - PHONE
      - SIP
      - WEBRTC
      - APPLICATION
      - WHATSAPP
      title: CriteriaType
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Platform'
        validityPeriod:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultSmsFailover'
      title: TikTokMessageOptions
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundMessage:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.InboundMessageTikTokInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: TikTokInboundMessage
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile:
      type: object
      description: Recorded file.
      properties:
        id:
          type: string
          description: File ID.
        name:
          type: string
          description: File name.
        fileFormat:
          type: string
          description: File format.
          enum:
          - MP3
          - WAV
          - MP4
        size:
          type: integer
          format: int64
          description: File size in bytes.
        startTime:
          type: string
          format: date-time
          description: Date and time when the recording started.
        endTime:
          type: string
          format: date-time
          description: Date and time when the recording ended.
        creationTime:
          type: string
          format: date-time
          description: File creation time.
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
        location:
          type: string
          description: Location of recording file after processing.
          enum:
          - UPLOADING
          - UPLOADED
          - HOSTED
        customData:
          type: object
          additionalProperties:
            type: string
          description: Client-defined data.
      title: RecordedFile
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpointType:
      type: string
      enum:
      - PHONE
      - SIP
      - WEBRTC
      - VIBER
      - WHATSAPP
      - WEBSOCKET
      title: CallEndpointType
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppStyle:
      type: string
      description: Set to `MODAL` to use in app dialog for actionable message or `BANNER` to show a standard banner view. `MODAL` is supported on iOS from [3.6.0](https://github.com/infobip/mobile-messaging-sdk-ios/releases/tag/3.6.0), on Android from [1.13.0](https://github.com/infobip/mobile-messaging-sdk-android/releases/tag/1.13.0) and on Cordova from [0.7.0](https://github.com/infobip/mobile-messaging-cordova-plugin/releases/tag/0.7.0). `BANNER` is supported from iOS [5.0.0](https://github.com/infobip/mobile-messaging-sdk-ios/releases/tag/5.0.0), Android [2.0.0](https://github.com/infobip/mobile-messaging-sdk-android/releases/tag/2.0.0) and Cordova [1.0.0](https://github.com/infobip/mobile-messaging-cordova-plugin/releases/tag/1.0.0)
      enum:
      - MODAL
      - BANNER
      title: InAppStyle
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.Envelope:
      type: object
      description: The values of the envelope-from and envelope-to headers of the inbound email.
      properties:
        from:
          type: string
          description: The sender name and sender address from which the inbound email was sent.
        to:
          type: string
          description: The reply-to address to which the inbound email was sent.
      required:
      - from
      - to
      title: Envelope
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.OMNIChannel:
      type: string
      description: OMNI Channel.
      enum:
      - SMS
      - EMAIL
      - VOICE
      - PARSECO
      - PUSH
      - VIBER
      - FACEBOOK
      - LINE
      - VKONTAKTE
      - KAKAO_CHINGU
      - KAKAO_ALIM
      - WHATSAPP
      - MMS
      title: OMNIChannel
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.InboundMessageTikTokInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContent'
        price:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageTikTokInboundContent
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    ac429fcfd24f9a7e1a25e07a88be90c98df1692e2811a989e35dc3301ebb4715.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MoPrice:
      type: object
      description: A price object showing currency and a price per each message.
      properties:
        pricePerMessage:
          type: number
          format: double
          description: Price per one SMS.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MoPrice
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RepeatWhile:
      type: object
      description: Repeat-While action is a control flow statement that repeatedly executes a block of code, as long as the boolean condition in the while field is true. Comparison is done using equal (==) or not equal (!=) operators. Make sure not to provide a condition that causes an infinite loop.
      properties:
        repeat:
          type: array
          description: Array of actions to execute.
          items:
            type: object
            description: Array of actions to execute.
        while:
          type: string
          description: The expression to evaluate.
      required:
      - repeat
      - while
      title: Repeat While
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogRecordingPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: DialogRecordingPage
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryDay'
        from:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryTime'
        to:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventInteractionType:
      type: string
      description: 'The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.'
      enum:
      - EVENT
      title: RcsEventInteractionType
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType:
      type: string
      description: Type of the phone number. It specifies verification type.
      enum:
      - EXTERNAL_SMS
      - EXTERNAL_VOICE
      example: EXTERNAL_SMS
      title: NumberType
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      required:
      - content
      - from
      - to
      title: InteractiveVoiceButtonMessage
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions'
      title: DefaultMessageRequestOptions
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReport:
      type: object
      description: Arrays of delivery reports, one object for every message.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the bulk of messages.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          type: string
          description: Destination address of the voice message.
        sentAt:
          type: string
          description: 'Date and time when the voice message was initiated. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          description: 'Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        startTime:
          type: string
          description: 'Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        endTime:
          type: string
          description: 'Date and time when the voice message was ended. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        answerTime:
          type: string
          description: 'Date and time when the voice message was answered. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        duration:
          type: integer
          format: int32
          description: Duration of the voice message, in seconds.
        fileDuration:
          type: number
          format: double
          description: Duration of the voice message audio file, in seconds.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Custom data sent over to the notifyUrl.
        dtmfCodes:
          type: string
          description: DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.
        recordedAudioFileUrl:
          type: string
          description: Url to retrieve recorded calls that were made by voice messages with the record feature activated.  Using that URL with GET method will initiate the download of the recorded file. If using a REST testing client, make sure to save the downloaded data instead of displaying it in the client’s response area. Recordings are encoded as PCM WAVE signed little-endian 16bit 8kHz audio files.
        scenarioId:
          type: string
          description: The ID that uniquely identifies the IVR scenario.
        scenarioName:
          type: string
          description: Name of IVR scenario.
        price:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price'
        status:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus'
        error:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError'
      title: VoiceReport
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveMultiProductMessage
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryDay:
      type: string
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        latitude:
          type: number
          format: double
          description: Latitude of a location sent in the WhatsApp message.
          maximum: 90
          minimum: -90
        longitude:
          type: number
          format: double
          description: Longitude of a location sent in the WhatsApp message.
          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
      title: LocationContent
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.WhatsAppCategory:
      type: string
      description: Category of the template.
      enum:
      - MARKETING
      - AUTHENTICATION
      - UTILITY
      example: MARKETING
      title: WhatsAppCategory
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Say:
      type: object
      description: Say action converts text to speech and plays it to the caller.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - say
        text:
          type: string
          description: Text to be spoken.
        language:
          type: string
          description: Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages). Use value from abbreviation column in the table.
          example: en
        speechRate:
          type: number
          format: double
          default: 1
          description: Speech rate (0.5 to 2.0).
          maximum: 2
          minimum: 0.5
        loopCount:
          type: integer
          format: int32
          description: Number of times to repeat the speech.
          minimum: 1
        voicePreferences:
          $ref: '#/components/schemas/49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences'
      required:
      - action
      - text
      title: Say
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMoReport:
      type: object
      description: An array of result objects.
      properties:
        applicationId:
          type: string
          description: Application id linked to the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        messageId:
          type: string
          description: Unique message ID.
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
        to:
          type: string
          description: The destination address of the message.
        text:
          type: string
          description: Full content of the message.
        cleanText:
          type: string
          description: Content of the message without a keyword (if a keyword was sent).
        keyword:
          type: string
          description: Keyword extracted from the message content.
        receivedAt:
          type: string
          format: date-time
          description: 'Indicates when the Infobip platform received the message. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        smsCount:
          type: integer
          format: int32
          description: The number of parts the message content was split into.
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MoPrice'
        callbackData:
          type: string
          description: Custom callback data sent over the notifyUrl.
        entityId:
          type: string
          description: Entity id linked to the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        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.
      title: SmsMoReport
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Available only for `linkUrl` field of RICH_LINK.
      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
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentStatus:
      type: string
      description: Status of the payment.
      enum:
      - NEW
      - PENDING
      - CAPTURED
      - CANCELED
      - FAILED
      - UNKNOWN
      example: PENDING
      title: PaymentStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailGroupDestination:
      type: object
      description: "An array of destination objects for where messages are being sent. A valid destination is required.\n\n Note: Maximum number of recipients is 1000 overall including `to`, `cc` and `bcc` field."
      properties:
        to:
          type: array
          description: List of TO recipient email addresses.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailToDestination'
        cc:
          type: array
          description: List of CC recipient email addresses.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailToDestination'
        bcc:
          type: array
          description: List of BCC recipient email addresses.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailToDestination'
        replyTo:
          type: string
          description: Email address to which recipients of the email can reply.
        preserveRecipients:
          type: boolean
          default: false
          description: 'When this option is set to `true`, all recipients in the `to` field will be able to see the entire list of

            recipients who received the email, and the response will include a single `messageId`.

            If the option is set to `false` , each recipient will only see their own email address, and the response will provide a unique `messageId`

            for each individual recipient.'
      required:
      - to
      title: EmailGroupDestination
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentLink:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers.
          writeOnly: true
        contentType:
          type: string
          description: Content type for media, for example `image/png`.
          writeOnly: true
        contentUrl:
          type: string
          description: URL of externally hosted content.
          writeOnly: true
      required:
      - contentUrl
      title: Link segment
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderRequestAcceptedResponse:
      type: object
      properties:
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
      required:
      - senderName
      - senderStatus
      title: RcsSenderRequestAcceptedResponse
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UrlOptions'
      title: DefaultMessageRequestOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.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: Required to use entity in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageTemplate:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Template'
        paging:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageInfo'
      required:
      - paging
      - results
      title: PageTemplate
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - SHARE_POST
      - REFERRAL_AD
      - REFERRAL_SHORT_LINK
      - REACTION
      title: TikTokInboundContentType
    4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest:
      type: object
      properties:
        recordingType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType'
        conferenceComposition:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceComposition'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
        filePrefix:
          type: string
          description: 'Custom name for the recording''s zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).

            Using the same `filePrefix` will override the files on the SFTP server.

            For recording without composition, `callId` and `fileId` will be appended to the `filePrefix` value.'
      required:
      - recordingType
      title: ConferenceRecordingRequest
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogFacebookOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice'
        status:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus'
        error:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError'
        platform:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform'
        content:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogFacebookOutboundContent
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InboundMessageInstagramDmInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: InstagramDmInboundResponse
    2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID of the bulk request.
        calls:
          type: array
          description: Bulk call list.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCall'
      title: BulkResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Failover:
      type: object
      description: SMS message to be sent if the WhatsApp template message could not be delivered.
      properties:
        from:
          type: string
          description: SMS sender number. Must be in international format.
          maxLength: 24
          minLength: 1
        text:
          type: string
          description: Content of the SMS that will be sent.
          maxLength: 4096
          minLength: 1
      required:
      - from
      - text
      title: Failover
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestination:
      type: object
      description: Recipient destination address. [Check examples](https://www.infobip.com/docs/mobile-push/mobile-push-over-api) how to work with recipients
      discriminator:
        propertyName: type
        mapping:
          EXTERNAL_USER_ID: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationExternalUserId'
          EMAIL: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationEmail'
          PHONE_NUMBER: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationPhoneNumber'
          REGISTRATION: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationRegistration'
          MULTIPLE: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationMultiple'
      properties:
        type:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationType'
      required:
      - type
      title: PushDestination
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogResponseLogTikTokOutboundMessageContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogTikTokOutboundMessageContent'
        cursor:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.CursorPageInfo'
      title: LogResponseLogTikTokOutboundMessageContent
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileFormat:
      type: string
      description: Format of the file.
      enum:
      - MP3
      - WAV
      - MP4
      title: FileFormat
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioRequest:
      type: object
      properties:
        name:
          type: string
          description: The name of IVR scenario.
        description:
          type: string
          description: Description of IVR scenario.
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        record:
          type: boolean
          description: Indicates if all calls using the scenario should be recorded.
        script:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script'
      required:
      - name
      - script
      title: UpdateScenarioRequest
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Price:
      type: object
      description: Sent email price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one email request.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.GeoLocation:
      type: object
      description: Geolocation data such as Country and City. This data will be available only for opens, clicks and unsubscribes.
      properties:
        countryName:
          type: string
          description: Country where the user action is recorded.
        city:
          type: string
          description: City where the user action is recorded.
      title: GeoLocation
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogResponseLogKakaoAlimOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogKakaoAlimOutboundContent'
        cursor:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.CursorPageInfo'
      title: LogResponseLogKakaoAlimOutboundContent
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeFrom:
      type: object
      description: The exact time of day to start sending messages. Time is expressed in the UTC time zone. If set, use it together with the `to` property with minimum 1 hour difference.
      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
          writeOnly: true
        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
          writeOnly: true
      required:
      - hour
      - minute
      title: DeliveryTimeFrom
      writeOnly: true
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone:
      type: object
      description: List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.
      properties:
        phoneNumber:
          type: string
          description: Phone number. Can be in E.164 format (e.g. +1234567890) or in local/national format (e.g. 1234567). Numbers starting with “+” are validated as E.164, with a known network prefix and a number length that follows country-specific rules. Numbers without “+” must contain only digits and be 3 to 20 characters long.
          pattern: ^\+?[0-9 \-().]{1,30}$
        label:
          type: string
          description: Label for the phone number. Must be plain text (no URLs, HTML or markup).
          maxLength: 25
          minLength: 1
      required:
      - label
      - phoneNumber
      title: Phone
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkMessageInfo:
      type: object
      properties:
        messages:
          type: array
          description: Array of sent message objects, one object per every message.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          example: '2034072219640523073'
      title: BulkMessageInfo
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkRequest:
      type: object
      discriminator:
        propertyName: type
        mapping:
          STATIC: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkRequest'
          REGISTERED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkRequest'
          PROVIDER: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkRequest'
          AUTHENTICATED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkRequest'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType'
        name:
          type: string
          description: SIP trunk name.
          maxLength: 128
          minLength: 0
        location:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation'
        internationalCallsAllowed:
          type: boolean
          default: false
          description: Indicates whether international calls should be allowed. Calls between different countries are considered international.
        channelLimit:
          type: integer
          format: int32
          description: Maximum number of concurrent channels.
          maximum: 1000
        billingPackage:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage'
      required:
      - billingPackage
      - channelLimit
      - name
      title: SipTrunkRequest
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SubdomainResponse:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
      title: SubdomainResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureSayInstruction:
      type: object
      description: Text-to-speech content to say before capturing DTMF input.
      properties:
        text:
          type: string
          description: Text to be spoken.
        language:
          type: string
          description: Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages). Use value from Abbreviation column in the table.
          example: en
        speechRate:
          type: number
          format: double
          default: 1
          description: Speech rate (0.5 to 2.0).
          maximum: 2
          minimum: 0.5
        voicePreferences:
          $ref: '#/components/schemas/49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences'
      required:
      - text
      title: CaptureSayInstruction
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessage'
        options:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageRequestOptions'
      required:
      - messages
      title: TikTokRequest
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Platform'
        validityPeriod:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DefaultSmsFailover'
      title: MsisdnMessageFailoverOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties:
      type: object
      properties:
        audio:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioMediaProperties'
        video:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.VideoMediaProperties'
      title: MediaProperties
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform'
        validityPeriod:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultSmsFailover'
        targeting:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoTargeting'
      title: KakaoMessageOptions
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.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
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicSayRequest:
      type: object
      description: Call say request.
      properties:
        text:
          type: string
          description: Text to read. Use the Speech Synthesis Markup Language (SSML) in a request to fine-tune your output.
        language:
          type: string
          description: Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech).
          enum:
          - ar
          - ar-ma
          - ar_xa
          - bg
          - bn
          - bn-in
          - ca
          - cmn-cn
          - cs
          - da
          - de
          - de-at
          - de-ch
          - el
          - en
          - en-au
          - en-ca
          - en-gb
          - en-gb-wls
          - en-ie
          - en-in
          - en-ph
          - es
          - es-419
          - es-ar
          - es-co
          - es-mx
          - es-us
          - et-ee
          - fi
          - fil-ph
          - fr
          - fr-ca
          - fr-ch
          - gu
          - he
          - hi
          - hr
          - hu
          - id
          - is
          - it
          - ja
          - kk-kz
          - kn
          - ko
          - lt
          - lv
          - ml
          - mr-in
          - ms
          - nb-no
          - nl
          - nl-be
          - 'no'
          - pa-in
          - pl
          - pt-br
          - pt-pt
          - ro
          - ru
          - sk
          - sl
          - sr-rs
          - sv
          - sw-ke
          - sw-tz
          - ta
          - te
          - th
          - tr
          - uk
          - ur-in
          - ur-pk
          - uz-uz
          - vi
          - wls
          - yue-hk
          - zh-cn
          - zh-tw
        speechRate:
          type: number
          format: double
          description: Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`.
        loopCount:
          type: integer
          format: int32
          description: Number of times to read the text.
        preferences:
          $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences'
        stopOn:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      required:
      - language
      - text
      title: PublicSayRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ImageType:
      type: string
      description: Image type.
      enum:
      - LOGO
      - BACKGROUND
      title: ImageType
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.SouthKoreaOptions'
      title: RegionalOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Log:
      type: object
      description: Collection of logs.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          type: string
          description: The message destination address.
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
        text:
          type: string
          description: Text of the message that was sent.
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Tells when the message was finished processing by Infobip (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        smsCount:
          type: integer
          format: int32
          description: The number of sent message segments.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        price:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Price'
        status:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Status'
        error:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Error'
      title: Log
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiRisk:
      type: string
      description: 'Indicates the risk status of email addresses.

        High-risk addresses have a very high chance of bouncing and potentially damaging the sender''s reputation.

        Low-risk addresses have a very low chance of bouncing and are less likely to damage the sender''s reputation.

        '
      enum:
      - LOW
      - MEDIUM
      - HIGH
      - UNKNOWN
      title: ApiRisk
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Event:
      type: object
      discriminator:
        propertyName: type
        mapping:
          DTMF_CAPTURED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfCapturedEvent'
          CALL_ESTABLISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEstablishedEvent'
          CALL_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFinishedEvent'
          CALL_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallFailedEvent'
          CALL_PRE_ESTABLISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPreEstablishedEvent'
          CALL_RECEIVED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReceivedEvent'
          CALL_STARTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallStartedEvent'
          CALL_RINGING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRingingEvent'
          CALL_MEDIA_CHANGED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallMediaChangedEvent'
          CALL_RECORDING_STARTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStartedEvent'
          CALL_RECORDING_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingFailedEvent'
          CALL_RECORDING_READY: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingReadyEvent'
          CALL_RECORDING_STOPPED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingStoppedEvent'
          CONFERENCE_RECORDING_STARTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStartedEvent'
          CONFERENCE_RECORDING_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingFailedEvent'
          CONFERENCE_RECORDING_READY: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingReadyEvent'
          CONFERENCE_RECORDING_STOPPED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingStoppedEvent'
          CONFERENCE_CREATED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCreatedEvent'
          CONFERENCE_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceFinishedEvent'
          ERROR: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorEvent'
          PARTICIPANT_MEDIA_CHANGED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantMediaChangedEvent'
          PARTICIPANT_JOIN_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinFailedEvent'
          PARTICIPANT_JOINED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoinedEvent'
          PARTICIPANT_JOINING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantJoiningEvent'
          PARTICIPANT_REMOVED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRemovedEvent'
          PARTICIPANT_RECORDING_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRecordingFailedEvent'
          PARTICIPANT_STARTED_TALKING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStartedTalkingEvent'
          PARTICIPANT_STOPPED_TALKING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantStoppedTalkingEvent'
          PARTICIPANT_ROLE_CHANGED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangedEvent'
          PARTICIPANT_ROLE_CHANGE_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantRoleChangeFailedEvent'
          PLAY_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PlayFinishedEvent'
          CONFERENCE_COMPOSITION_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFailedEvent'
          CONFERENCE_COMPOSITION_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceCompositionFinishedEvent'
          SAY_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SayFinishedEvent'
          MACHINE_DETECTION_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFinishedEvent'
          MACHINE_DETECTION_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionFailedEvent'
          MACHINE_MESSAGE_DETECTION_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFinishedEvent'
          MACHINE_MESSAGE_DETECTION_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineMessageDetectionFailedEvent'
          MEDIA_STREAM_STARTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamStartedEvent'
          MEDIA_STREAM_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFinishedEvent'
          MEDIA_STREAM_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamFailedEvent'
          APPLICATION_TRANSFER_REQUESTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferRequestedEvent'
          APPLICATION_TRANSFER_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFailedEvent'
          APPLICATION_TRANSFER_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ApplicationTransferFinishedEvent'
          DIALOG_CREATED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCreatedEvent'
          DIALOG_ESTABLISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogEstablishedEvent'
          DIALOG_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFailedEvent'
          DIALOG_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogFinishedEvent'
          DIALOG_RECORDING_STARTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStartedEvent'
          DIALOG_RECORDING_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingFailedEvent'
          DIALOG_RECORDING_READY: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingReadyEvent'
          DIALOG_RECORDING_STOPPED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingStoppedEvent'
          DIALOG_COMPOSITION_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFailedEvent'
          DIALOG_COMPOSITION_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogCompositionFinishedEvent'
          TRANSCRIPTION: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TranscriptionEvent'
          SPEECH_CAPTURED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SpeechCapturedEvent'
          BULK_CALL_STATUS: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallStatusEvent'
          CALL_RECORDING_DELETED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingDeletedEvent'
          CONFERENCE_RECORDING_DELETED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingDeletedEvent'
          DIALOG_RECORDING_DELETED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingDeletedEvent'
          CALL_DISCONNECTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDisconnectedEvent'
          CALL_RECONNECTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallReconnectedEvent'
          DIALOG_TRANSFER_REQUESTED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferRequestedEvent'
          DIALOG_TRANSFER_FAILED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFailedEvent'
          DIALOG_TRANSFER_FINISHED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogTransferFinishedEvent'
      properties:
        conferenceId:
          type: string
          description: Unique ID of the conference, if the event is related to a conference.
          maxLength: 128
        callId:
          type: string
          description: Unique ID of the call, if the event is related to a call.
          maxLength: 128
        timestamp:
          type: string
          format: date-time
          description: Date and time for when the event has occurred.
        callsConfigurationId:
          type: string
          description: Unique ID of the calls configuration, if the event is related to a calls configuration.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        bulkId:
          type: string
          description: Unique ID of the bulk action, if the event is related to a bulk action.
        dialogId:
          type: string
          description: Unique ID of the dialog that event is related to.
          maxLength: 128
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.EventType'
      title: Event
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetectionOptions:
      type: object
      properties:
        waitEndOfMessageDetection:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WaitForEom'
        endOfMessageDetectionTimeout:
          type: integer
          format: int32
          description: Specifies the timeout (in seconds) to wait for the end of the message after a machine is detected. If set, actions defined in `onMachineDetected` will be executed only after the end of the message is detected or the timeout is reached. If not set, `onMachineDetected` actions will be triggered immediately after machine detection. If the timeout is reached before the end of the message, actions defined in `onTimeout` will be executed instead.
          maximum: 60
          minimum: 1
      title: AnsweringMachineDetectionOptions
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailResponse:
      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/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: EmailResponse
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.AcceptableHours:
      type: object
      description: Specify time range within a day when a link can be used. It is 00:00 - 23:59, by default. UTC timezone is used.
      properties:
        start:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.TimeOfDay'
        end:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.TimeOfDay'
      title: AcceptableHours
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessages:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.InboundMessageViberInboundMessageContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: ViberInboundMessages
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InboundMessageAppleMfbInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: AppleMfbInboundResponse
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentTransactionNotification:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the transaction.
          minLength: 1
        type:
          type: string
          description: Type of the transaction.
          enum:
          - UPI
          - BR
          - UNKNOWN
        status:
          type: string
          description: Status of the transaction.
          enum:
          - PENDING
          - FAILED
          - SUCCESS
          - CANCELED
          - UNKNOWN
        createdTimestamp:
          type: string
          format: date-time
          description: 'Creation time of the transaction. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        updatedTimestamp:
          type: string
          format: date-time
          description: 'Update time of the transaction. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      title: whatsappPaymentTransactionNotification
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogViberOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice'
        status:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus'
        error:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageError'
        platform:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform'
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogViberOutboundContent
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SouthKoreaOptions'
      title: RegionalOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessages:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessage'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      required:
      - messageCount
      - pendingMessageCount
      - results
      title: RcsInboundMessages
    7e9cb629dd52a85ce6e062228c85b37a768e3c9da7cd3bd0d9451171d2b14262.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkDestination:
      type: string
      description: Destination type.
      enum:
      - ROOM
      - WEBRTC
      - PHONE
      title: CallLinkDestination
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ViberData:
      type: object
      description: 'Viber-specific data used if the message is sent through a Viber channel. Must be one of: text, image, file, text with button or text with image and button.'
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 14 days is not supported. Additionally, period should be longer than 35 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        imageURL:
          type: string
          description: URL of the image sent in the Viber message.
          maxLength: 1000
          minLength: 0
          writeOnly: true
        fileName:
          type: string
          description: File name of the file sent in the Viber message.
          maxLength: 25
          minLength: 0
          writeOnly: true
        fileType:
          type: string
          description: 'File type (extension) of the file sent in the Viber message. Has to be one of: doc, docx, rtf, dot, dotx, odt ,odf, fodt, txt, info, pdf, xps, pdax, eps, xls, xlsx, ods, fods, csv, xlsm, xltx'
          writeOnly: true
        fileUrl:
          type: string
          description: 'URL of the file sent in the Viber message. For example: http://example.com/document.docx'
          pattern: ^(https?)://.*$
          writeOnly: true
        buttonText:
          type: string
          description: Viber button label. Max 30 characters.
          maxLength: 30
          minLength: 0
          writeOnly: true
        buttonURL:
          type: string
          description: Viber Button Call To Action. Should contain URL or telephone number to call. Format for telephone number is tel:.
          maxLength: 1000
          minLength: 0
          writeOnly: true
        trackingData:
          type: string
          description: Viber tracking data. Enables tracking messages, sent tracking_data value will be passed back with user's reply
          maxLength: 100
          minLength: 0
          writeOnly: true
        isPromotional:
          type: boolean
          description: Indicates if content is of promotional character.
          writeOnly: true
        forcePrimaryDevice:
          type: boolean
          description: Defines if Text message will be sent only to the users primary device (smartphone).
          writeOnly: true
      title: ViberData
      writeOnly: true
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price:
      type: object
      description: MMS price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one MMS.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SouthKoreaOptions'
      title: RegionalOptions
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionModeType:
      type: string
      enum:
      - SYNC
      - ASYNC
      title: MachineDetectionModeType
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTimeWindow:
      type: object
      description: Set specific scheduling options to send a message within daily or hourly intervals.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryDay'
          writeOnly: true
        from:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTime'
        to:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
      writeOnly: true
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsToDestination'
        content:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent'
        options:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageOptions'
        webhooks:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Webhooks'
      required:
      - content
      - destinations
      title: SmsMessage
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.SpeechCaptureRequest:
      type: object
      properties:
        language:
          $ref: '#/components/schemas/61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language'
        timeout:
          type: integer
          format: int32
          description: The maximum duration of speech capture.
          maximum: 30
          minimum: 1
        maxSilence:
          type: integer
          format: int32
          description: The silence duration before terminating the speech capture after speech has been detected.
          maximum: 5
          minimum: 1
        keyPhrases:
          type: array
          description: Array of key-phrases used for matching capturing speech.
          items:
            type: string
            description: Array of key-phrases used for matching capturing speech.
          uniqueItems: true
        terminateOnKeyPhrase:
          type: boolean
          default: true
          description: Indicates whether speech capture should terminate immediately upon detecting a key phrase. Defaults to `true`. When `false`, capture proceeds until completion and retains only the first matched key phrase, if any.
        customDictionary:
          type: array
          description: Array of custom words (typically, industry-specific terms) used for improved speech capture.
          items:
            type: string
            description: Array of custom words (typically, industry-specific terms) used for improved speech capture.
        advancedFormatting:
          type: boolean
          default: false
          description: Toggles enhanced text formatting features like punctuation, proper casing, numeral normalization, and disfluency filtering. Defaults to `false`.
      required:
      - language
      - timeout
      title: SpeechCaptureRequest
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editSubCategory:
      type: string
      description: Sub category of template. It is required only if edited template has already sub category.
      enum:
      - ORDER_STATUS
      title: editSubCategory
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime:
      type: object
      properties:
        hour:
          type: integer
          format: int32
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.CaptureDtmfCallbackRequest:
      type: object
      description: Markup Language captureDtmf callback request object. Sent to the callback URL configured on the CaptureDtmf instruction after the caller has finished entering DTMF digits (or the timeout expired). Extends the instructions callback payload with the collected DTMF sequence.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        capturedDtmf:
          type: string
          description: DTMF digits collected from the caller. Empty when the timeout elapsed with no input and callOnEmpty is enabled.
          example: '1234'
      title: CaptureDtmfCallbackRequest
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionStatus:
      type: string
      description: Status of the transaction.
      enum:
      - PENDING
      - FAILED
      - SUCCESS
      - CANCELED
      - UNKNOWN
      example: SUCCESS
      title: PaymentTransactionStatus
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - FILE
      - CAROUSEL
      - LOCATION
      - CONTACT
      - STICKER
      - URL
      title: ViberBotOutboundContentType
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData:
      type: object
      description: Template header. Can be `image`, `document`, `video`, `location` or `text`.
      discriminator:
        propertyName: format
        mapping:
          TEXT: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TextHeaderApiData'
          IMAGE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ImageHeaderApiData'
          VIDEO: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1VideoHeaderApiData'
          DOCUMENT: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1DocumentHeaderApiData'
          LOCATION: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1LocationHeaderApiData'
      properties:
        format:
          type: string
          enum:
          - TEXT
          - IMAGE
          - VIDEO
          - DOCUMENT
          - LOCATION
      title: V1HeaderApiData
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType:
      type: string
      enum:
      - TEXT
      - FILE
      - CARD
      - CAROUSEL
      - PROVIDER_TEMPLATE
      title: RcsOutboundMessageContentType
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvents:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated events.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvent'
        messageCount:
          type: integer
          format: int32
          description: The number of events returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of events that have not been pulled in.
      required:
      - messageCount
      - pendingMessageCount
      - results
      title: RcsInboundEvents
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.BulkResponse:
      type: object
      description: Validations response
      properties:
        validationRequestId:
          type: string
          description: 'Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.

            '
      required:
      - validationRequestId
      title: BulkResponse
    676955110d1a0dfd70a111f0d54754844fb76cec84585649da79c94c1af5f6bc.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.SeenReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every received message.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeenReport'
      title: SeenReports
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Destination:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationTo'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GroupDestination'
      description: An array of destination objects for where messages are being sent. Each object in array can be one of available options. A valid destination is required.
      title: Destination
      writeOnly: true
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.FailoverMessage:
      type: object
      description: An array of messages being sent.
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        smsFailover:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Failover'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: FailoverMessage
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppStyle:
      type: string
      description: Set to `MODAL` to show mirrored push notification in app as a dialog for actionable message or `BANNER` to show a standard banner view. `MODAL` is supported on iOS from [3.6.0](https://github.com/infobip/mobile-messaging-sdk-ios/releases/tag/3.6.0), on Android from [1.13.0](https://github.com/infobip/mobile-messaging-sdk-android/releases/tag/1.13.0) and on Cordova from [0.7.0](https://github.com/infobip/mobile-messaging-cordova-plugin/releases/tag/0.7.0). `BANNER` is supported from iOS [5.0.0](https://github.com/infobip/mobile-messaging-sdk-ios/releases/tag/5.0.0), Android [2.0.0](https://github.com/infobip/mobile-messaging-sdk-android/releases/tag/2.0.0) and Cordova [1.0.0](https://github.com/infobip/mobile-messaging-cordova-plugin/releases/tag/1.0.0)
      enum:
      - MODAL
      - BANNER
      title: PushOutboundContentOptionsInAppStyle
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedWebhooksWithSeen:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenStatusReporting'
      title: AdvancedWebhooksWithSeen
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingNotFoundException:
      type: object
      properties:
        message:
          type: string
        cause:
          type: object
          properties:
            stackTrace:
              type: array
              items:
                type: object
                properties:
                  classLoaderName:
                    type: string
                  moduleName:
                    type: string
                  moduleVersion:
                    type: string
                  methodName:
                    type: string
                  fileName:
                    type: string
                  lineNumber:
                    type: integer
                    format: int32
                  className:
                    type: string
                  nativeMethod:
                    type: boolean
            message:
              type: string
            localizedMessage:
              type: string
        stackTrace:
          type: array
          items:
            type: object
            properties:
              classLoaderName:
                type: string
              moduleName:
                type: string
              moduleVersion:
                type: string
              methodName:
                type: string
              fileName:
                type: string
              lineNumber:
                type: integer
                format: int32
              className:
                type: string
              nativeMethod:
                type: boolean
        suppressed:
          type: array
          items:
            type: object
            properties:
              stackTrace:
                type: array
                items:
                  type: object
                  properties:
                    classLoaderName:
                      type: string
                    moduleName:
                      type: string
                    moduleVersion:
                      type: string
                    methodName:
                      type: string
                    fileName:
                      type: string
                    lineNumber:
                      type: integer
                      format: int32
                    className:
                      type: string
                    nativeMethod:
                      type: boolean
              message:
                type: string
              localizedMessage:
                type: string
        localizedMessage:
          type: string
      title: RecordingNotFoundException
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.RegionalData:
      type: object
      description: Region specific parameters, often specified by local laws. Use this if country or region that you are sending SMS to requires some extra parameters.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IndiaDltOptions'
        korea:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KoreaOptions'
      title: RegionalData
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ClientPriority:
      type: string
      description: Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
      enum:
      - HIGH
      - STANDARD
      - LOW
      title: ClientPriority
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Localization:
      type: object
      description: If the localization object is not defined, English will be used. If the localization type is set to PRESET, the language code is mandatory to be defined to one of the predefined values.If the localization type is set to BROWSER_DETECTED and the browser language is one of the languages that could be set in PRESET type, then that language will be used. Otherwise, English will be used.
      discriminator:
        propertyName: type
        mapping:
          PRESET: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PresetLocalization'
          BROWSER_DETECTED: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.BrowserDetectedLocalization'
      properties:
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.LocalizationType'
      title: Localization
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryResult:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryReport'
          readOnly: false
          writeOnly: true
      title: whatsappDlrReportsResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSBinaryMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        binary:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BinaryContent'
        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](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
          writeOnly: true
        deliveryTimeWindow:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow'
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination'
          writeOnly: true
        flash:
          type: boolean
          description: Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.
          writeOnly: true
        from:
          type: string
          description: The sender ID which 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).
          writeOnly: true
        intermediateReport:
          type: boolean
          description: The [real-time intermediate delivery report](https://www.infobip.com/docs/api#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
          writeOnly: true
        notifyContentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
          writeOnly: true
        notifyUrl:
          type: string
          description: The URL on your call back server on which the Delivery report will be sent.
          externalDocs:
            description: Delivery report format
            url: '#channels/sms/receive-outbound-sms-message-report'
          writeOnly: true
        regional:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.RegionalOptions'
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for [scheduled SMS](https://www.infobip.com/docs/api#channels/sms/get-scheduled-sms-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.'
          writeOnly: true
        validityPeriod:
          type: integer
          format: int64
          description: The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
          writeOnly: true
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 66
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 66
          minLength: 0
          writeOnly: true
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      required:
      - destinations
      title: SMSBinaryMessage
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguMessage'
        options:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultMessageRequestOptions'
      required:
      - messages
      title: KakaoChinguRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportSingle:
      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.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID.
          example: 45db39c3-7822-4e72-a3ec-c87442c0ffz9
        to:
          type: string
          description: Message destination address.
          example: '41793026727'
        sentAt:
          type: string
          description: 'Indicates whether the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: 2019-11-09T16:00:00.000+0000
        doneAt:
          type: string
          description: 'Indicates whether message processing was finished by Infobip (i.e., delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: 2019-11-09T16:00:00.000+0000
        messageCount:
          type: integer
          format: int32
          description: The number of messages were charged for this message request.
          example: 1
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through `callbackData` field in message.
          example: my-reference
        price:
          $ref: '#/components/schemas/270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Price'
        status:
          $ref: '#/components/schemas/270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Status'
        error:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ErrorReport'
        entityId:
          type: string
          description: Entity used in request.
          example: my-entity-id
        applicationId:
          type: string
          description: Application used in request.
          example: my-application-id
        channel:
          type: string
          description: The channel used for delivering the message.
          example: ZALO_NOTIFICATION_SERVICE
      required:
      - bulkId
      - channel
      - messageId
      - to
      title: ZaloReportSingle
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLink:
      type: object
      description: Use the call link feature to enable calls between users that have an Infobip account and users that don't.
      properties:
        id:
          type: string
          description: 'Identifier of the created call link. To open a call link, it should be concatenated to the URL: https://call-link.com/.'
        url:
          type: string
          description: A URL to initiate a call.
        identity:
          type: string
          description: Identity of a user who will use a call link.
          pattern: ^[\p{L}\p{N}\-_+=/.]{3,64}$
        displayName:
          type: string
          description: Display name of a user who will use a call link to initiate a call.
        showIdentity:
          type: boolean
          default: true
          description: Show identity or displayName on before a call.
        destination:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Destination'
        customData:
          type: object
          additionalProperties:
            type: string
            description: Custom attributes sent in a call once it is started.
          description: Custom attributes sent in a call once it is started.
        validityWindow:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ValidityWindow'
        callLinkConfigId:
          type: string
          description: ID of a configuration to use on an existing call link. If this parameter is not sent, and there are some call link configurations, the default one will be used. If there is no configurations, then the one with the system default values will be used.
      required:
      - destination
      - identity
      title: CallLink
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.UploadKeyApiDoc:
      type: object
      properties:
        file:
          type: string
          format: binary
          description: "Multipart form data containing the public key file. \n                        The file must be in PEM format with a 2048-bit RSA key\n                 and include the appropriate header and footer lines.\n                 Example file content: `----BEGIN PUBLIC KEY-----\\n MIIBIjAN... \\n ----END PUBLIC"
      required:
      - file
      title: UploadKeyApiDoc
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Template:
      type: object
      description: ZNS message template.
      properties:
        templateName:
          type: integer
          format: int64
          description: Name identifying the template. Is the same as registered template_id.
        displayName:
          type: string
          description: Human readable name of the template.
        status:
          type: string
          description: 'Template status. Possible values: `PENDING_REVIEW`, `DISABLE`, `ENABLE`, `REJECT`.'
        createdTime:
          type: string
          format: date-time
          description: 'Template creation date. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      title: Template
    a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording:
      type: object
      properties:
        conferenceId:
          type: string
          description: Conference ID.
          maxLength: 128
        conferenceName:
          type: string
          description: Conference name.
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        composedFiles:
          type: array
          description: File(s) with a recording of all conference participants.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
        callRecordings:
          type: array
          description: File(s) with a recording of one conference participant.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
        startTime:
          type: string
          format: date-time
          description: Date and time when the (first) recording started.
        endTime:
          type: string
          format: date-time
          description: Date and time when the (last) recording ended.
      title: PublicConferenceRecording
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RegionalOptions'
        destinationMatching:
          type: array
          description: The SMS failover destination matching.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.FailoverDestinationPair'
      required:
      - text
      title: NonMsisdnSmsFailover
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SortDirection:
      type: string
      enum:
      - ASC
      - DESC
      title: SortDirection
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Platform'
        validityPeriod:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryTimeWindow'
        soundEnabled:
          type: boolean
          description: Sound when a notification arrives on a device.
        soundName:
          type: string
          description: 'Name of the custom sound played when a notification arrives on a device. The audio file should be located in the app with max 30 seconds length. File extension is required for [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/How-to-use-custom-notification-sound%3F) and optional for [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/How-to-use-custom-notification-sound%3F). (Example: notification_sound.wav). Check Android and iOS usage details. To play a custom sound, `soundEnabled` must be set to `true`.'
        vibrationEnabled:
          type: boolean
          description: Notification vibration (Android only).
        contentAvailable:
          type: boolean
          description: System flag indicating whether or not mobile app should wake up when message received (iOS only).
        isSilent:
          type: boolean
          description: Set to true to send silent push message. Such messages aren’t displayed on device lock screen and in the notification center. Silent messages can be used to deliver custom data to your mobile application or to trigger a mirrored push notification.
        badge:
          type: integer
          format: int32
          description: Badge counter (iOS only).
        category:
          type: string
          description: 'Category id for actionable notification. Supported on [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/Interactive-notifications) since MM SDK version 1.6.16. Supported on [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/Interactive-Notifications) since MM SDK version 2.6.9. Predefined category ids: mm_accept_decline - Accept & Decline button actions.'
        showMirroredPush:
          type: boolean
          description: Show mirrored push notification in application.
        mirroredPushStyle:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppStyle'
        mirroredPushExpirationPeriod:
          type: integer
          format: int64
          description: Sets validity period for mirrored push notification. Users will only see mirrored push notification if they received it to their device within validity period, which starts from sending time.
          minimum: 0
        mirroredPushExpirationTimeUnit:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppExpirationTimeUnit'
        mirroredPushDismissTitle:
          type: string
          description: Specifies custom title for `Dismiss` button for mirrored push notification.
        mirroredPushOpenTitle:
          type: string
          description: Specifies custom title for `Open` button for mirrored push notification.
        onTapButtonAction:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonAction'
        inboxTopic:
          type: string
          description: A case sensitive topic name to save a message to an inbox. If the topic name does not exist for a specified account, message sending will be rejected. [A case sensitive topic name to save a message to an inbox](https://www.infobip.com/docs/mobile-push/inbox)
        inboxMessageExpirationPeriod:
          type: integer
          format: int64
          description: Sets validity period for inbox message. Users will only see the message in their inbox if it has not expired. Time unit for this parameter is set by property of inboxMessageExpirationTimeUnit. This field is only applicable when inboxTopic is present.
        inboxMessageExpirationTimeUnit:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInboxMessageExpirationTimeUnit'
        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.'
        customPayload:
          type: object
          additionalProperties:
            type: object
          description: Additional data that can be delivered with the Push message. customPayload must be formatted as JSON object.
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      title: PushUnificationMessageOptions
    0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetectionResult:
      type: string
      description: Result of Answering Machine Detection. Possible values are `HUMAN` and `MACHINE`.
      enum:
      - HUMAN
      - MACHINE
      title: MachineDetectionResult
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GetVoicesResponse:
      type: object
      properties:
        voices:
          type: array
          description: Array of voices belonging to the specified language.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SynthesisVoiceResponse'
      title: GetVoicesResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice'
        status:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus'
        error:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTestNumberApiRequest:
      type: object
      properties:
        testNumber:
          type: string
          description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
          pattern: ^\+?[1-9]\d{1,14}$
        primary:
          type: boolean
          default: false
          description: Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association.
      required:
      - testNumber
      title: CreateRcsTestNumberApiRequest
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogResponseLogInstagramDmOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogInstagramDmOutboundContent'
        cursor:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.CursorPageInfo'
      title: LogResponseLogInstagramDmOutboundContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    faa1195a85d1a730663c8d9058f7685a3760136466d26134605b0efcc286bec7.MultiTtsApiRequest:
      type: object
      description: Multiple voice messages request object.
      properties:
        messages:
          type: array
          description: Array of messages to be sent, one per every message.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MultiTtsApiMessage'
      required:
      - messages
      title: MultiTtsApiRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveListMessage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListTextHeaderContent'
      properties:
        type:
          type: string
          description: Type of the header content. Select the type from the dropdown to view its parameters.
      required:
      - type
      title: InteractiveListHeaderContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundMessagePushko:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent'
        price:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessagePrice'
        contact:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactProfile'
        identity:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Identity'
      required:
      - contact
      - from
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - to
      title: InboundMessagePushko
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReport:
      type: object
      description: Collection of email delivery reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessagePrice'
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageStatus'
        error:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
        attemptCount:
          type: integer
          format: int32
          description: Number of times delivery was attempted for the email.
        timeToFirstAttempt:
          type: integer
          format: int64
          description: This is the time in milliseconds between accepting the request and making the first delivery attempt to the destination.
      title: EmailDeliveryReport
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContentType:
      type: string
      enum:
      - SUGGESTION
      title: RcsInboundEventContentType
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoToOptions:
      type: object
      properties:
        goToLimit:
          type: integer
          format: int32
          description: Maximum number of times goto can jump to specified action. Valid values are from 1 to 100.
          maximum: 100
          minimum: 1
        countVariable:
          type: string
          description: Name of the variable which counts passes through goto action
      title: GoToOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination:
      type: object
      description: Indicates when to stop the action. The action can be interrupted at any time by the end user when they press any DTMF key.
      discriminator:
        propertyName: type
        mapping:
          DTMF: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfTermination'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTerminationType'
      title: PublicTermination
    6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse:
      type: object
      description: Recording API response.
      properties:
        application:
          $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication'
        recording:
          $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingMetadata'
      required:
      - application
      - recording
      title: RecordingApiResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File:
      type: object
      properties:
        id:
          type: string
          description: File ID.
          example: 218eceba-c044-430d-9f26-8f1a7f0g2d03
        name:
          type: string
          description: File name.
          example: Example file
        fileFormat:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat'
        size:
          type: integer
          format: int64
          description: File size in bytes.
          example: 292190
        creationTime:
          type: string
          format: date-time
          description: File creation time.
        expirationTime:
          type: string
          format: date-time
          description: File expiration time.
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
          example: 3
      required:
      - fileFormat
      - name
      title: File
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.ErrorCallbackRequest:
      type: object
      description: Markup Language error callback request object. Sent to the configured errorUrl when the platform fails to retrieve or execute a Markup Language script. Extends the instructions callback payload with the error code and details describing the failure.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        errorCode:
          type: string
          description: Error category code.
          example: HTTP_ERROR
        errorDetails:
          type: string
          description: Detailed error message.
          example: Error while reaching https://{yourDomain}/your/webhook/path
      title: ErrorCallbackRequest
    eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupResponse:
      type: object
      description: Markup language response object.
      properties:
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint'
        from:
          type: string
          description: Phone number from which the call originated from.
          example: '44790123456'
        externalId:
          type: string
          description: Unique identifier of the call.
      title: MarkupResponse
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RequestSchedulingSettings'
        priority:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ClientPriority'
      title: KakaoAlimMessageRequestOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUpload:
      type: object
      description: Play From Upload action performs playback of uploaded audio file. Not available in inbound IVR at the moment.
      properties:
        playFromUpload:
          type: string
          description: ID of uploaded file. The parameter can be constructed using variables.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUploadOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - playFromUpload
      title: Play From Upload
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Error:
      type: object
      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.
      title: Error
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventOptions:
      type: object
      description: Event options.
      properties:
        platform:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform'
        validityPeriod:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod'
      title: AppleMfbEventOptions
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsTextMessageContent:
      type: object
      allOf:
      - type: object
        properties:
          text:
            type: string
            description: Content of the message being sent.
          transliteration:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TransliterationCode'
          language:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage'
      required:
      - text
      title: text content
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    5305ca722d832817d411146f95eba84c3530f174d0fd6b1f72c09c5c2fbb1063.Application:
      type: object
      description: Application data for the recording.
      discriminator:
        propertyName: type
        mapping:
          WEBRTC: '#/components/schemas/5305ca722d832817d411146f95eba84c3530f174d0fd6b1f72c09c5c2fbb1063.WebrtcApplication'
      properties:
        type:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ApplicationType'
      required:
      - type
      title: Application
    74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateSipTrunkResponse:
      type: object
      discriminator:
        propertyName: type
        mapping:
          STATIC: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateStaticSipTrunkResponse'
          REGISTERED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateRegisteredSipTrunkResponse'
          PROVIDER: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateProviderSipTrunkResponse'
          AUTHENTICATED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.CreateAuthenticatedSipTrunkResponse'
      properties:
        id:
          type: string
          description: SIP trunk ID.
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType'
        name:
          type: string
          description: SIP trunk name.
        location:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation'
        internationalCallsAllowed:
          type: boolean
          description: Indicates whether international calls should be allowed. Calls between different countries are considered international.
        channelLimit:
          type: integer
          format: int32
          description: Maximum number of concurrent channels.
        billingPackage:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage'
        sbcHosts:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts'
      title: CreateSipTrunkResponse
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSendMessageRequest:
      type: object
      properties:
        message:
          type: string
          description: Message to send.
      required:
      - message
      title: DialogSendMessageRequest
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowResponseApiData:
      type: object
      properties:
        originalPrompt:
          type: string
          description: The prompt text used to generate this flow.
          example: Flow that contains form with name, surname and email of the user.
        responseId:
          type: string
          description: Unique identifier for this response. Use this value in future requests to reference generated flow.
          example: '12345'
        generatedFlow:
          type: object
          description: The generated output corresponding to the provided prompt.
      required:
      - generatedFlow
      - originalPrompt
      - responseId
      title: GenerateFlowResponseApiData
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo:
      type: object
      description: Platform information associated with the message.
      properties:
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: RcsPlatformInfo
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentCurrency:
      type: string
      description: Currency of the payment.
      enum:
      - INR
      - BRL
      - UNKNOWN
      example: INR
      title: PaymentCurrency
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContentType:
      type: string
      enum:
      - TEMPLATE
      title: KakaoAlimOutboundContentType
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform'
        validityPeriod:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnSmsFailover'
      title: NonMsisdnMessageFailoverOptions
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.File:
      type: object
      description: The list of the results for this page.
      properties:
        id:
          type: string
          description: File ID.
          example: 218eceba-c044-430d-9f26-8f1a7f0g2d03
        name:
          type: string
          description: File name.
          example: Example file
        fileFormat:
          type: string
          description: File format.
          example: WAV
        size:
          type: integer
          format: int64
          description: File size in bytes.
          example: 292190
        creationTime:
          type: string
          format: date-time
          description: File creation time.
        expirationTime:
          type: string
          format: date-time
          description: File expiration time.
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
          example: 3
      required:
      - fileFormat
      - name
      title: File
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegment:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentText'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentLink'
      description: Content of the message being sent.
      title: MmsLogsMessageSegment
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Destination:
      type: object
      description: Array of message destination addresses. Maximum number of destination addresses is 20k.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          type: string
          description: 'Message destination addresses. Destination address must be in the E.164 standard format (Example: `41793026727`).'
      required:
      - to
      title: Destination
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsCountryProvidersPageResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryProviders'
        paging:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo'
      required:
      - paging
      - results
      title: RcsCountryProvidersPageResponse
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogAppleMfbOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice'
        status:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus'
        error:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageError'
        platform:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform'
        content:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogAppleMfbOutboundContent
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails:
      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 passed, it will be automatically generated and returned in a response.
          readOnly: true
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status'
        to:
          type: string
          description: The destination address of the message.
          readOnly: true
        smsCount:
          type: integer
          format: int32
          description: This is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted.
          readOnly: true
      readOnly: true
      title: SMSResponseDetails
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListSectionContent:
      type: object
      description: Array of sections in the list.
      properties:
        title:
          type: string
          description: Title of the section. Required, if the message has more than one section.
          maxLength: 24
          minLength: 0
        rows:
          type: array
          description: An array of rows sent within a section. Section must contain at least one row. Message can have up to ten rows.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRowContent'
      required:
      - rows
      title: InteractiveListSectionContent
    033803db88cada38464c4e86c919c67cee20aa369072ec632b1c62ea0cc27514.ReferredProduct:
      type: object
      description: Product information included in the incoming message.
      properties:
        catalogId:
          type: string
          description: The ID that uniquely identifies the catalog registered with Facebook, connected to the WhatsApp Business Account (WABA) the sender belongs to.
          minLength: 0
        productRetailerId:
          type: string
          description: Product unique identifier, as defined in catalog.
          minLength: 0
      title: ReferredProduct
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          example: 1
        groupName:
          type: string
          description: Status group name.
          example: PENDING
        id:
          type: integer
          format: int32
          description: Status ID.
          example: 7
        name:
          type: string
          description: Status name.
          example: PENDING_ENROUTE
        description:
          type: string
          description: Human-readable description of the status.
          example: Message sent to next instance
        action:
          type: string
          description: Action that should be taken to eliminate the error.
      title: SingleMessageStatus
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedInfo:
      type: object
      description: Conversation details including type, ID, and time window.
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationType'
        id:
          type: string
          description: Unique conversation identifier.
        startTime:
          type: string
          format: date-time
          description: Conversation start time.
        endTime:
          type: string
          format: date-time
          description: Conversation end time.
      required:
      - endTime
      - id
      - startTime
      - type
      title: RcsConversationStartedInfo
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductActionContent:
      type: object
      description: Allows you to specify catalog and product details sent in the product message.
      properties:
        catalogId:
          type: string
          description: The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to.
        productRetailerId:
          type: string
          description: Product-unique identifier, as defined in catalog.
      required:
      - catalogId
      - productRetailerId
      title: InteractiveProductActionContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.IpCoreGeneralStatus:
      type: string
      description: Sent Message status.
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: IpCoreGeneralStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SmtpInfo:
      type: object
      description: SMTP details for the sent email.
      properties:
        response:
          type: string
          description: SMTP server response for the sent email.
      title: SmtpInfo
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - AUDIO
      - FILE
      - EXPIRED_SESSION
      title: KakaoSangdamInboundContentType
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Retry:
      type: object
      description: 'Used to define if the delivery of the Voice messages should be retried in case the first try doesn''t succeed. Additional retries will be made according to the schedule defined by _minPeriod_ and _maxPeriod_ parameters and platform''s internal retry logic. If the _minPeriod_ differs _maxPeriod_, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached.  If the retry attempt for the _maxPeriod_ is reached, the _maxPeriod_ will be used for all subsequent retries. If the _minPeriod_ and the _maxPeriod_ are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or _maxCount_ value is reached.'
      properties:
        maxCount:
          type: integer
          format: int32
          description: Specify the maximum number of retry attempts. Maximum value of the maxCount is `4`. If the value is higher than `4`, it will be set to `4`.
        maxPeriod:
          type: integer
          format: int32
          description: Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours.
        minPeriod:
          type: integer
          format: int32
          description: Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours.
      required:
      - maxCount
      - maxPeriod
      - minPeriod
      title: Retry
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateStatus:
      type: string
      description: Updated status of the template.
      enum:
      - PENDING
      - APPROVED
      - REJECTED
      example: APPROVED
      title: TemplateStatus
    ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityInfo:
      type: object
      properties:
        acknowledged:
          type: boolean
          description: Identity acknowledge status
          example: true
        hash:
          type: string
          description: Identity hash
          example: eU2Fdi4EMUw=
        createdAt:
          type: string
          format: date-time
          description: Identity event creation date
      required:
      - acknowledged
      - createdAt
      - hash
      title: IdentityInfo
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.InboundMessageFacebookInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent'
        price:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageFacebookInboundContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand:
      type: object
      description: Brand for which sender is created.
      properties:
        brandName:
          type: string
          description: Name of the brand.
          maxLength: 100
          minLength: 1
      required:
      - brandName
      title: RcsBrand
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselActionType:
      type: string
      enum:
      - QUICK_REPLY
      - URL
      title: MediaCarouselActionType
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportResult:
      type: object
      description: List of MO report results.
      properties:
        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 reply to.
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        subscriberId:
          type: string
          description: Subscriber ID of the message sender.
        to:
          type: string
          description: The message destination address.
        applicationCode:
          type: string
          description: Application code that the message was sent to.
        receivedAt:
          type: string
          format: date-time
          description: 'Indicates when the message was received. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        callbackData:
          type: string
          description: Callback data sent through callbackData field when the message was sent.
        text:
          type: string
          description: Full text of the received message.
        cleanText:
          type: string
          description: Text of the received message without the keyword.
        keyword:
          type: string
          description: Keyword extracted from the message text.
        customPayload:
          type: object
          additionalProperties:
            type: object
          description: Custom payload of the received message.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        initialMessageId:
          type: string
          description: The ID of the original MT message that initiated the conversation.
      required:
      - applicationCode
      - cleanText
      - from
      - messageId
      - receivedAt
      - text
      - to
      title: MoReportResult
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedWebhooksWithSeen:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenStatusReporting'
      title: AdvancedWebhooksWithSeen
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionLimit:
      type: object
      description: A list of time-bound restrictions for the given action.
      properties:
        timePeriod:
          type: string
          format: duration
          description: Duration for which the limitation is applied in ISO 8601 format.
          example: P7DT1H30M
        maxAllowed:
          type: integer
          format: int32
          description: The maximum number of actions allowed within the specified time period.
          example: 5
        currentUsage:
          type: integer
          format: int32
          description: The current number of actions the business has taken within the specified time period.
          example: 1
        limitExpirationTime:
          type: string
          format: date-time
          description: Time at which the limit will expire.
          example: '2025-10-06T08:12:26.422Z'
      required:
      - currentUsage
      - maxAllowed
      - timePeriod
      title: CallingPermissionActionLimit
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpResponse:
      type: object
      description: Dedicated IPs assigned to the IP pool.
      properties:
        id:
          type: string
          description: Dedicated IP identifier.
        ip:
          type: string
          deprecated: true
          description: Dedicated IP address.
        ipAddresses:
          type: array
          description: List of IP addresses that are paired together.
          items:
            type: string
          minItems: 1
          uniqueItems: true
      required:
      - id
      - ip
      - ipAddresses
      title: IpResponse
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiSuppressionType:
      type: string
      description: Type of suppression.
      enum:
      - BOUNCE
      - COMPLAINT
      - OVER_QUOTA
      title: ApiSuppressionType
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.CreateFlowRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the flow.
          example: My first flow
          maxLength: 200
          minLength: 1
        categories:
          type: array
          description: Categories of the flow.
          example: SIGN_UP
          items:
            $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory'
        cloneFlowId:
          type: string
          description: ID of source Flow to clone. The new flow with DRAFT status will inherit the flow.json from source flow.
          example: '987654'
      required:
      - categories
      - name
      title: CreateFlowRequest
    5cb8669321a9b28a95445a23a292423b19c28f831eda62032aef9c6b53da7813.RouteResponsePage:
      type: object
      description: Routes response object.
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse'
        paging:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo'
      title: RouteResponsePage
    18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplatesApiResponse:
      type: object
      properties:
        templates:
          type: array
          description: List of all templates for given sender.
          items:
            $ref: '#/components/schemas/18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse'
      title: TemplatesResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSmsFailover:
      type: object
      description: MMS to be sent in case a message could not be delivered through the main channel.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationFailoverRegionalOptions'
      required:
      - text
      title: MmsUnificationSmsFailover
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType:
      type: string
      default: NONE
      description: Fax type.
      enum:
      - NONE
      - INBAND
      - T38
      title: FaxType
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallLogPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: CallLogPage
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique dialog ID.
          example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
          maxLength: 128
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
          example: dc5942707c704551a00cd2ea
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        state:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState'
        startTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been created.
        establishTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been established.
        endTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been finished.
        parentCall:
          $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
        childCall:
          $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
      title: DialogResponse
    87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationCreateRequest:
      type: object
      properties:
        id:
          type: string
          description: Calls configuration ID. If not provided, system will generate random ID, which will be returned in response.
          maxLength: 128
          minLength: 1
          pattern: ^[a-zA-Z0-9_-]*$
        name:
          type: string
          description: Calls configuration name.
          maxLength: 128
          minLength: 1
      title: CallsConfigurationCreateRequest
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SendingSpeedLimit'
      title: RequestSchedulingSettings
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique campaign ID.
          example: '120213234151570'
        name:
          type: string
          description: Campaign name.
          example: Summer Sale Campaign
        adAccountId:
          type: string
          description: Facebook ad account ID associated with the campaign.
          example: ACT_123456789
        pageId:
          type: string
          description: Facebook page ID associated with the campaign.
          example: '111111111111111'
      title: CampaignResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReport:
      type: object
      properties:
        applicationId:
          type: string
          description: The Application ID sent in the email request.
        entityId:
          type: string
          description: The Entity ID sent in the email request.
        bulkId:
          type: string
          description: The ID that uniquely identifies bulks of request.
        messageId:
          type: string
          description: The ID that uniquely identifies the sent email request.
        to:
          type: string
          description: The recipient email address.
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the email was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-01-02T01:00:00.123Z'
        doneAt:
          type: string
          format: date-time
          description: Tells when the email request was processed by Infobip.
          example: '2021-01-02T01:00:00.123Z'
        messageCount:
          type: integer
          format: int32
          description: Email request count.
        attemptCount:
          type: integer
          format: int32
          description: Number of times delivery was attempted for the email.
        timeToFirstAttempt:
          type: integer
          format: int64
          description: This is the time in milliseconds between accepting the request and making the first delivery attempt to the destination.
        price:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Price'
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Status'
        error:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Error'
      title: ApiReport
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppressionRequest:
      type: object
      description: Suppressions request.
      properties:
        suppressions:
          type: array
          description: Email addresses to add to the suppression list. Number of destinations cannot exceed 10,000.
          items:
            $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppression'
          maxItems: 10
          minItems: 1
      required:
      - suppressions
      title: AddSuppressionRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest:
      type: object
      description: Sms failover message contents.
      properties:
        from:
          type: string
          description: Message failover sender.
          example: myFailoverRcsSender
        text:
          type: string
          description: Message failover text.
          example: This message was sent over SMS.
        validityPeriod:
          type: integer
          format: int32
          description: Message failover validity period.
          example: 15
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange'
        regional:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Regional'
      required:
      - from
      - text
      title: SmsFailoverRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentText:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers.
          writeOnly: true
        text:
          type: string
          description: Message text.
          writeOnly: true
      title: Text segment
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType:
      type: string
      enum:
      - APPLICATION
      - ENDPOINT
      - URL
      title: DestinationType
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.LogInstagramDmOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessagePrice'
        status:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageStatus'
        error:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageError'
        platform:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Platform'
        content:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogInstagramDmOutboundContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SouthKoreaOptions'
      title: RegionalOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckRequestState:
      type: object
      description: The sync response from the RCS capability checker for the specified phone numbers. Represents the current status of the requests.
      properties:
        messageId:
          type: string
          description: A unique message ID. This ID is automatically generated and will be included in the API response.
        phoneNumber:
          type: string
          description: The recipient's phone number that was checked for RCS capability.
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.StatusReason'
      required:
      - messageId
      - phoneNumber
      - status
      title: CapabilityCheckRequestState
      xml:
        name: CapabilityCheckRequestState
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBaseData:
      type: object
      properties:
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
        billingCategory:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory'
        useCase:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase'
        hostingRegion:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion'
        brand:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand'
        googleAgentId:
          type: string
          description: Google Agent ID associated with this sender.
        displayName:
          type: string
          description: The name of the sender displayed to the user on mobile device.
        description:
          type: string
          description: The description of the sender displayed to the user on mobile device.
        color:
          type: string
          description: Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.
        bannerUrl:
          type: string
          description: URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
        logoUrl:
          type: string
          description: URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when sender has been updated last time.
      required:
      - bannerUrl
      - billingCategory
      - brand
      - color
      - description
      - displayName
      - hostingRegion
      - logoUrl
      - senderName
      - senderStatus
      - updatedAt
      - useCase
      title: RcsSenderBaseData
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SendingSpeedLimit'
      title: RequestSchedulingSettings
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListActionContent:
      type: object
      description: Allows you to specify the title of the list and its sections. Each section can have a title and multiple rows to select.
      properties:
        title:
          type: string
          description: Title of the list. Does not allow emojis or markdown.
          maxLength: 20
          minLength: 1
        sections:
          type: array
          description: Array of sections in the list.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListSectionContent'
          maxItems: 10
          minItems: 1
      required:
      - sections
      - title
      title: InteractiveListActionContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationTo:
      type: object
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          writeOnly: true
        to:
          type: string
          description: 'Message destination address. Addresses must be in international format (Example: `41793026727`).'
          maxLength: 50
          minLength: 0
          writeOnly: true
      required:
      - to
      title: Destination as to
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventRequest:
      type: object
      properties:
        events:
          type: array
          description: An array of event objects of the events to be sent.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEvent'
        options:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DefaultEventRequestOptions'
      required:
      - events
      title: WhatsAppEventRequest
    2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupResponse:
      type: object
      properties:
        key:
          type: string
          description: Use to connect masking configuration with Voice-enabled number.
        name:
          type: string
          description: Unique configuration name. Alphanumeric, max length 100.
        callbackUrl:
          type: string
          description: Client's URL that will be called on each inbound call to related Number masking Voice number in order to get instructions of how to handle incoming calls. Instructions are a result of mapping logic implemented on your side according to your business case.
        statusUrl:
          type: string
          description: Client's URL for status report delivery after the call is finished.
        backupCallbackUrl:
          type: string
          description: If callbackUrl is unavailable this one will be called instead.
        backupStatusUrl:
          type: string
          description: If statusUrl is unavailable this one will be called instead.
        description:
          type: string
          description: Masking configuration description
        insertDateTime:
          type: string
          format: date-time
          description: Date and time (UTC timezone) when masking configuration is created.
        updateDateTime:
          type: string
          format: date-time
          description: Date and time (UTC timezone) when masking configuration was last modified.
      title: SetupResponse
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAdAccountsResponse:
      type: object
      properties:
        adAccounts:
          type: array
          description: List of ad accounts.
          items:
            $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountResponse'
      title: GetAdAccountsResponse
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.OtpRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType'
        locale:
          type: string
          default: en_US
          description: Locale which will be used to submit for verification.
          example: en_US
      required:
      - locale
      - type
      title: OtpRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DefaultMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlOptions'
      title: DefaultMessageRequestOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackageType:
      type: string
      description: Billing package type.
      enum:
      - METERED
      - UNLIMITED
      example: METERED
      title: BillingPackageType
    1612e6f124bb6c5b1f4f7b12ca64104d59fdfdf779c97454e478b219583b9d48.SMSAdvancedTextualRequest:
      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 to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs). Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and 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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSTextualMessage'
        sendingSpeedLimit:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SendingSpeedLimit'
        urlOptions:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions'
        tracking:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.Tracking'
        includeSmsCountInResponse:
          type: boolean
          default: false
          description: Set to true to return smsCount in the response. Default is false. smsCount is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than that limit will be split into multiple SMS and reflected in the total count of SMS submitted.
      required:
      - messages
      title: SMSTextualRequest
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse:
      type: object
      properties:
        dialogId:
          type: string
          description: Unique dialog ID.
          example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
          maxLength: 128
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
          example: dc5942707c704551a00cd2ea
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        state:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState'
        startTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been created.
        establishTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been established.
        endTime:
          type: string
          format: date-time
          description: Date and time for when the dialog has been finished.
        parentCallId:
          type: string
          description: Unique parent call ID.
          example: d8d84155-3831-43fb-91c9-10b5a8d628a0
          maxLength: 128
        childCallId:
          type: string
          description: Unique child call ID.
          example: ae024ad1-52e7-45d5-a5d2-cd7c809e03f8
          maxLength: 128
        duration:
          type: integer
          format: int64
          description: Dialog duration in seconds.
          example: 5
        recording:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingLog'
        errorCode:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo'
        hangupSource:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource'
      title: DialogLogResponse
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsSouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending MMS to phone numbers registered in South Korea.
      properties:
        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: MmsSouthKoreaOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FailoverDestinationPair:
      type: object
      description: The SMS failover destination matching.
      properties:
        initial:
          type: string
          description: The initial destination address specified in the request.
        failover:
          type: string
          description: 'The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)'
      required:
      - failover
      - initial
      title: FailoverDestinationPair
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateRequest:
      type: object
      properties:
        templateId:
          type: string
          description: Template ID.
        templateName:
          type: string
          description: Template name (10-60 characters).
          maxLength: 60
          minLength: 10
        templateContent:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateContent'
        params:
          type: array
          description: Template parameters for dynamic content.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameter'
        note:
          type: string
          description: Template note.
          maxLength: 400
          minLength: 1
        trackingId:
          type: string
          description: Tracking identifier.
          maxLength: 200
          minLength: 1
      required:
      - note
      - templateContent
      - templateId
      - templateName
      - trackingId
      title: EditTemplateRequest
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundTextContent'
          IMAGE: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundImageContent'
          VIDEO: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundVideoContent'
          AUDIO: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundAudioContent'
          FILE: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundFileContent'
          EXPIRED_SESSION: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundExpiredSessionContent'
      properties:
        type:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContentType'
      title: KakaoSangdamInboundContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: CallPage
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.InboundMessageAppleMfbInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent'
        price:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageAppleMfbInboundContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ButtonType:
      type: string
      description: Type of button action.
      enum:
      - GO_TO_COMPANY_PAGE
      - MAKE_PHONE_CALL
      - GO_TO_OA_INFORMATION_PAGE
      - GO_TO_ZALO_MINI_APP
      - GO_TO_COMPANY_APPLICATION_PAGE
      - GO_TO_ANOTHER_WEBSITE_OR_MINI_APP
      - GO_TO_ANOTHER_APPLICATION
      - GO_TO_OA_POST
      - COPY
      - PAY_NOW
      - SEE_DETAILS
      - GO_TO_ELECTRONIC_INVOICE_LOOKUP_PAGE
      - GO_TO_LANDING_PAGE_APP_DOWNLOAD
      title: ButtonType
    febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.SubdomainRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of a subdomain.
          pattern: ^[A-Za-z0-9](?:[A-Za-z0-9\-]{0,61}[A-Za-z0-9])?$
      title: SubdomainRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiErrorResponse:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiErrorResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent:
      type: object
      description: Template body.
      properties:
        placeholders:
          type: array
          description: Template's parameter values submitted in the same order as in the registered template. The value must not be null, but it can be an empty array, if the template was registered without placeholders. Values within the array must not be null or empty.
          items:
            type: string
            description: Template's parameter values submitted in the same order as in the registered template. The value must not be null, but it can be an empty array, if the template was registered without placeholders. Values within the array must not be null or empty.
      required:
      - placeholders
      title: TemplateBodyContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType:
      type: string
      enum:
      - BUBBLE
      - CAROUSEL
      title: ContainerType
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent:
      description: Polymorphic content played to the caller.
      oneOf:
      - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.FilePlayContent'
      - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlPlayContent'
      - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingPlayContent'
      title: PlayContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To:
      type: object
      description: The message destination address.
      properties:
        phoneNumber:
          type: string
          description: 'Destination phone number. Phone numbers must be in international format (example: `41793026727`).'
        emailAddress:
          type: string
          description: Destination email address.
        pushRegistrationId:
          type: string
          description: Unique ID for push registration.
        whatsAppUserId:
          type: string
          description: 'WhatsApp Business-Scoped User ID (BSUID). Format: `{CC}.{alphanumeric}` (e.g. `US.13491208655302741918`). Max 150 characters. Phone number takes precedence when both are provided.'
      title: To
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialRecording:
      type: object
      description: Recording configuration for dial actions.
      properties:
        filePrefix:
          type: string
          description: Prefix for recorded file names.
        recordingStatusCallbackUrl:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        recordingStatusCallbackEvents:
          type: array
          description: Set of recording status events that trigger the recording status callback.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent'
          uniqueItems: true
        customData:
          type: object
          additionalProperties:
            type: string
            description: Custom data to attach to recordings.
          description: Custom data to attach to recordings.
      title: DialRecording
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice'
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
    6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicStopPlayRequest:
      type: object
      properties:
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      title: PublicStopPlayRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmf:
      type: object
      description: CaptureDtmf action collects DTMF input from the caller.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - captureDtmf
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmfCallbackUrl'
        maxLength:
          type: integer
          format: int32
          default: 1
          description: Maximum number of digits to capture.
          maximum: 30
        timeout:
          type: integer
          format: int32
          default: 5
          description: Timeout in seconds waiting for input.
          maximum: 30
          minimum: 1
        terminator:
          type: string
          default: '#'
          description: DTMF digit that terminates input.
        play:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CapturePlayInstruction'
        say:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureSayInstruction'
      required:
      - action
      - callback
      title: CaptureDtmf
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceResponse:
      type: object
      properties:
        id:
          type: string
          description: Meta custom audience ID.
          example: '52512562968362'
        name:
          type: string
          description: Custom audience name.
          example: My CRM Audience
        description:
          type: string
          description: Custom audience description.
          example: Q3 campaign target users
        adAccountId:
          type: string
          description: Facebook ad account ID.
          example: act_3339405976215927
        pageId:
          type: string
          description: Facebook page ID.
          example: '108968269613427'
      title: CreateAudienceResponse
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LimitedTimeOfferApiData:
      type: object
      description: Limited time offer.
      properties:
        hasExpiration:
          type: boolean
          default: false
          description: Indicates whether offer expiration details will appear in the delivered message. If set to true, copy code button must be included in the buttons array, and must appear first in the array.
        text:
          type: string
          description: Offer details text. Up to 16 characters.
          maxLength: 16
          minLength: 1
      required:
      - text
      title: LimitedTimeOfferApiData
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneContent:
      type: object
      description: Array of phones information.
      properties:
        phone:
          type: string
          description: Contact's phone number.
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneType'
        waId:
          type: string
          description: Contact's WhatsApp ID.
      title: PhoneContent
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions:
      type: object
      properties:
        childCallHangup:
          type: boolean
          default: true
          description: Flag indicating if the parent call should be terminated when the child call ends.
        childCallRinging:
          type: boolean
          default: false
          description: Flag indicating if a child call's ringing should be propagated to the parent call. The parent call must be `INBOUND`. Cannot be `true` when `ringbackGeneration` is enabled.
        ringbackGeneration:
          $ref: '#/components/schemas/f9f4d06aa76c139ea87428e14c99b11f79a0ab9b330e26afc80d0c5a5ff1acbb.RingbackGeneration'
      title: DialogPropagationOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDiscount:
      type: object
      description: Discount of the order.
      properties:
        amount:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount'
        programName:
          type: string
          description: Discount program name.
          maxLength: 60
          minLength: 0
      required:
      - amount
      title: InteractiveOrderDetailsDiscount
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfoPageResponse:
      type: object
      description: Domain get response.
      properties:
        results:
          type: array
          description: Domains for requested paging information.
          items:
            $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfo'
        paging:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiPageDetails'
      required:
      - paging
      - results
      title: DomainInfoPageResponse
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBody:
      type: object
      description: Body of the message.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelTextMessageBody'
          JSON: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelJsonMessageBody'
          AUDIO: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelAudioMessageBody'
          IMAGE: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelImageMessageBody'
          FILE: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelFileMessageBody'
      properties:
        type:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBodyType'
      title: OpenChannelMessageBody
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.CallRecordingPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: CallRecordingPage
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType:
      type: string
      description: Recording type.
      enum:
      - AUDIO
      - AUDIO_AND_VIDEO
      title: RecordingType
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.CursorPageInfo:
      type: object
      description: Paging response.
      properties:
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        previousCursor:
          type: string
          description: The previous cursor, empty if there are no previous results.
        nextCursor:
          type: string
          description: The next cursor, empty if there are no subsequent results.
      required:
      - nextCursor
      - previousCursor
      - size
      title: CursorPageInfo
    477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoReport:
      type: object
      allOf:
      - $ref: '#/components/schemas/450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.IntegrationType'
      - properties:
          message:
            allOf:
            - $ref: '#/components/schemas/477ea179b1fa759a5e4ddd5edaa6af94d896d40bcb5c4181a042ac252296aece.MoMessage'
            description: Message content.
            readOnly: false
            writeOnly: true
      - $ref: '#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase'
      title: MoReport
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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.
          writeOnly: true
        timeUnit:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SendingSpeedLimit'
      title: RequestSchedulingSettings
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogRcsOutboundMessageContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice'
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus'
        error:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError'
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogRcsOutboundMessageContent
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.File:
      type: object
      description: Recording file.
      properties:
        id:
          type: string
          description: Id of the file.
        name:
          type: string
          description: Name of the file.
        fileFormat:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileFormat'
      title: File
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          LINE_NOTIFICATION: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOutboundNotificationContent'
      properties:
        type:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContentType'
      title: LineOnOutboundContent
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Error:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
        groupName:
          type: string
        id:
          type: integer
          format: int32
        name:
          type: string
        description:
          type: string
        permanent:
          type: boolean
      title: Error
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script:
      type: array
      description: 'Array of IVR actions defining scenario. NOTE: Answering Machine Detection, Call Recording and Speech Recognition (used for Capture action) are add-on features. To enable these add-ons, please contact our [sales](https://www.infobip.com/contact) organisation.'
      items:
        oneOf:
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApi'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Capture'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Collect'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Dial'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToMany'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversations'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ForEach'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoTo'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Hangup'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IfThenElse'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.MachineDetection'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetection'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Pause'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Play'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromRecording'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUpload'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTty'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Record'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RepeatWhile'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Say'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSms'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SetVariable'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SwitchCase'
        - $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WhileDo'
      title: Script
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          MESSAGE: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundMessageContent'
          DELIVERED: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundDeliveredContent'
          SUBSCRIBED: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundSubscribedContent'
          UNSUBSCRIBED: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundUnsubscribedContent'
          CONVERSATION_STARTED: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundConversationStartedContent'
      properties:
        type:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContentType'
      title: ViberBotInboundContent
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallDetails:
      type: object
      description: Call details.
      discriminator:
        propertyName: type
        mapping:
          WEBRTC: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.WebRtcCallDetails'
          ROOM: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RoomCallDetails'
          PHONE: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PhoneCallDetails'
      properties:
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DestinationType'
      title: CallDetails
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryDay'
        from:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryTime'
        to:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingResponse:
      type: object
      properties:
        application:
          $ref: '#/components/schemas/5305ca722d832817d411146f95eba84c3530f174d0fd6b1f72c09c5c2fbb1063.Application'
        recording:
          $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.Recording'
      title: RecordingResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationStatus'
      required:
      - status
      title: WhatsAppSenderRegistrationResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria:
      type: object
      description: List of criteria that should match route. For a route to match, any criterion should be met.
      properties:
        to:
          type: string
          description: 'Phone number or regular expression pattern representing the phone number. Applies to all search criteria types except `WEBRTC`. Examples: `41793026727`, `41793(.+)`.'
        value:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria'
      title: SearchCriteria
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEvent:
      type: object
      description: An array of event objects of the events to be sent.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where the event is being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ToDestination'
          maxItems: 1
          minItems: 1
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContent'
        options:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventOptions'
      required:
      - content
      - destinations
      - sender
      title: WhatsAppEvent
    18564d7c4791a7efa60d2b6c8cb85f3f93b60abdd39e67aaeb1d653e4aff3ecd.V1TemplateApiResponse:
      type: object
      description: List of all templates for given sender.
      properties:
        id:
          type: string
          description: Template ID.
          example: '111'
        businessAccountId:
          type: integer
          format: int64
          description: Business account ID to which template belongs.
          example: 222
        name:
          type: string
          description: Name of the template.
          example: template_name
        language:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language'
        status:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status'
        category:
          type: string
          description: Category of the template.
          enum:
          - ACCOUNT_UPDATE
          - PAYMENT_UPDATE
          - PERSONAL_FINANCE_UPDATE
          - SHIPPING_UPDATE
          - RESERVATION_UPDATE
          - ISSUE_RESOLUTION
          - APPOINTMENT_UPDATE
          - TRANSPORTATION_UPDATE
          - TICKET_UPDATE
          - ALERT_UPDATE
          - AUTO_REPLY
          - TRANSACTIONAL
          - OTP
          - MARKETING
          - AUTHENTICATION
          - UTILITY
          example: ACCOUNT_UPDATE
        structure:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData'
      title: TemplateResponse
    aa157138bc28697f89db8325cc3d3ce20c0f3c72c30b6831a5435f3f2d211cfe.CallRoutingRecordingPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApiResponse'
        paging:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo'
      title: CallRoutingRecordingPage
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameterType:
      type: string
      description: Type of the parameter.
      enum:
      - CUSTOMER_NAME
      - PHONE_NUMBER
      - ADDRESS
      - CODE
      - CUSTOM_LABELS
      - TRADING_STATUS
      - CONTACT_INFORMATION
      - GENDER_TITLE
      - PRODUCT_NAME_BRAND
      - QUANTITY_AMOUNT
      - TIME
      - OTP
      - URL
      - CURRENCY_VND
      - BANK_TRANSFER_NOTE
      title: TemplateParameterType
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent:
      type: object
      description: Template content details.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TextTemplate'
          IMAGE: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageTemplate'
          IMAGE_WIDE: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ImageWideTemplate'
          ITEM_LIST: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ItemListTemplate'
      properties:
        type:
          $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateTypes'
      required:
      - type
      title: BrandMessagesTemplateContent
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoRequest:
      type: object
      properties:
        about:
          type: string
          description: Manages the content of the sender\'s **About** section.
          example: Infobip Business Account
          maxLength: 130
          minLength: 0
        address:
          type: string
          description: Street address of the business.
          example: 35-38 New Bridge Street, London EC4V 6BW
          maxLength: 256
          minLength: 0
        description:
          type: string
          description: Description of the business.
          example: Infobip is a global cloud communications platform.
          maxLength: 512
          minLength: 0
        email:
          type: string
          description: Email of the business.
          example: info@example.com
          maxLength: 128
          minLength: 0
        vertical:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical'
        websites:
          type: array
          description: Websites of the business.
          example: https://www.infobip.com
          items:
            type: string
            description: Websites of the business.
            example: https://www.infobip.com
            maxLength: 256
            minLength: 0
          maxItems: 2
          minItems: 0
        logoUrl:
          type: string
          description: URL of the business' logo. Must be a valid URL starting with `https://` or `http://`. Supported logo types are `JPEG`, `PNG`. Log file should be at least 192x192 pixels and at most 640x640 pixels.
          example: https://example.com/logo
          maxLength: 2048
          minLength: 0
      title: BusinessInfoRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicErrorCode:
      type: string
      description: 'Error code to hang up with. There are rules for using error codes.


        `NORMAL_HANGUP` - Call needs to be established.


        `MACHINE_DETECTED` - Call needs to be established and must be `OUTBOUND`.


        `NO_ANSWER` - Call cannot be established.


        `BUSY` - Call cannot be established.


        `CANCELLED` - Call cannot be established.


        `REJECTED` - Call cannot be established.


        `FORBIDDEN` - Call cannot be established.


        `DESTINATION_NOT_FOUND` - Call cannot be established.


        `DESTINATION_UNAVAILABLE` - Call cannot be established.


        `INVALID_DESTINATION` - Call cannot be established.


        `SERVICE_UNAVAILABLE` - Call cannot be established.'
      enum:
      - NORMAL_HANGUP
      - MACHINE_DETECTED
      - NO_ANSWER
      - BUSY
      - CANCELLED
      - REJECTED
      - FORBIDDEN
      - DESTINATION_NOT_FOUND
      - DESTINATION_UNAVAILABLE
      - INVALID_DESTINATION
      - INVALID_REQUEST
      - REQUEST_TIMEOUT
      - SERVICE_UNAVAILABLE
      title: PublicErrorCode
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ResponseDetails:
      type: object
      description: Array of sent messages, one object per every message.
      properties:
        to:
          type: string
          description: The message destination address.
        status:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SingleMessageStatus'
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
      title: ResponseDetails
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSmsData:
      type: object
      properties:
        text:
          type: string
          description: The text of the message that will be sent.
        from:
          type: string
          description: Represents sender ID and it can be alphanumeric or numeric; alphanumeric sender ID length should be between 3 and 11 characters; numeric sender ID length should be between 3 and 14 characters; the parameter can be constructed using variables
        to:
          type: string
          description: Must be a valid E164 MSISDN; the parameter can be constructed using variables
      required:
      - from
      - text
      - to
      title: SendSmsData
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateInfo:
      type: object
      description: Information about a ZNS message template.
      properties:
        templateName:
          type: integer
          format: int64
          description: Name identifying the template. Must be the same as registered template_id.
        displayName:
          type: string
          description: Human readable name of the template.
        status:
          type: string
          description: 'Template status. Possible values: `PENDING_REVIEW`, `DISABLE`, `ENABLE`, `REJECT`.'
        reason:
          type: string
          description: Reason for current template status.
        templateProperties:
          type: array
          description: List of template properties.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateProperty'
        templateButtons:
          type: array
          description: List of template buttons.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateButton'
        previewUrl:
          type: string
          description: Path to the template preview.
        templateTag:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateTag'
      title: TemplateInfo
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryDay'
        from:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime'
        to:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsProviderTemplateApiStatus:
      type: string
      description: 'Template status for this specific provider. Possible values:

        * `PENDING`: Status indicating that the template has been submitted to the provider and is being under review.

        * `APPROVED`: Status indicating that the template has been approved by the provider.

        * `REJECTED`: Status indicating that the template has been rejected by the provider.

        * `SUSPENDED`: Status indicating that the template has been suspended by the provider.


        Please note that the template must be approved by the provider before it can be used for messaging.'
      enum:
      - PENDING
      - APPROVED
      - REJECTED
      - SUSPENDED
      title: RcsProviderTemplateApiStatus
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VoiceData:
      type: object
      description: Voice-specific data used if the message is sent through a voice channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          maxLength: 2147483647
          minLength: 1
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        language:
          type: string
          description: Supported languages for Voice messages. List of supported languages can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech)
          writeOnly: true
      title: VoiceData
      writeOnly: true
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelWebhookData:
      type: object
      description: Response webhook data.
      properties:
        url:
          type: string
          description: Override URL to which the outbound response will be sent, required to be in HTTPS URL format.
        callbackData:
          type: object
          description: Additional data that can be used for identifying a message response. Data contained here will be included in the outbound message sent as response to this inbound message.
      title: OpenChannelWebhookData
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReport'
      title: DeliveryReports
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrMessage:
      type: object
      description: Array of IVR messages to be sent, one object per every message.
      properties:
        scenarioId:
          type: string
          description: Scenario key.
        from:
          type: string
          description: Numeric sender ID length should be between 3 and 14 characters.
        destinations:
          type: array
          description: Array of message destination addresses. Maximum number of destination addresses is 20k.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Destination'
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        notifyContentVersion:
          type: integer
          format: int32
          description: Specifies the version of the report model to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2.
        callbackData:
          type: string
          description: Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters.
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
        sendAt:
          type: string
          format: date-time
          description: Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time).
        retry:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Retry'
        ringTimeout:
          type: integer
          format: int32
          description: 'Ringing duration, unless there are no operator limitations. Default value is `45`. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to `45` seconds.'
        sendingSpeed:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendingSpeed'
        parameters:
          type: object
          additionalProperties:
            type: string
          description: The parameters that should be passed to the scenario on execution.
        pause:
          type: integer
          format: int32
          description: Indicating period of time in seconds between end user answering the call and message starting to be played. Minimal value is `0` and maximum value is `10` seconds. Default value is `0`.
        deliveryTimeWindow:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTimeWindow'
        callTimeout:
          type: integer
          format: int32
          description: Maximum possible duration of the call to be set, shown in seconds.
      required:
      - destinations
      - scenarioId
      title: IvrMessage
    8a486cb9d74b424a2d3be79e8747a253b2d16548f487145eca2db9192c11dbe8.OmniResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          readOnly: true
        messages:
          type: array
          description: Array of sent message objects, one object per every message.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniResponseDetails'
          readOnly: true
      title: OmniResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationFailoverRegionalOptions:
      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:
        southKorea:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSouthKoreaOptions'
      title: MmsUnificationFailoverRegionalOptions
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryDay'
        from:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime'
        to:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ImageContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: ImageMessage
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest:
      type: object
      properties:
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        from:
          type: string
          description: Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers.
        fromDisplayName:
          type: string
          description: Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string.
        connectTimeout:
          type: integer
          format: int32
          description: Time to wait, in seconds, before the called party answers the call.
          maximum: 60
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data is used for storing call-specific data defined by the client.
      title: DialogCallRequest
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryCoverage:
      type: object
      description: Coverage information by country showing launch status for each provider.
      properties:
        countryCode:
          type: string
          description: Country code where the sender is being launched.
        providers:
          type: array
          description: List of providers in the country and their launch status.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderSenderLaunchStatus'
      required:
      - countryCode
      - providers
      title: CountryCoverage
    b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReportsResponse:
      type: object
      properties:
        results:
          type: array
          description: Arrays of delivery reports, one object for every message.
          items:
            $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReport'
          readOnly: false
          writeOnly: false
      title: VoiceReportsResponse
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences:
      type: object
      description: Voice preferences.
      properties:
        voiceGender:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Gender'
        voiceName:
          type: string
          description: Voice name in which text would be synthesized. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech-add-ons-and-options).
          enum:
          - Aadita
          - Aarohi (neural)
          - Aarushi (beta)
          - Aarya
          - Abbi (neural)
          - Abigail
          - Abrielle (beta)
          - Abril (neural)
          - Achara (neural)
          - Achernar ar-XA (generative)
          - Achernar bg (generative)
          - Achernar bn-IN (generative)
          - Achernar cmn-CN (generative)
          - Achernar cs (generative)
          - Achernar da-DK (generative)
          - Achernar el-GR (generative)
          - Achernar en-IN (generative)
          - Achernar en-US (generative)
          - Achernar es-US (generative)
          - Achernar et-EE (generative)
          - Achernar fi-FI (generative)
          - Achernar fr-CA (generative)
          - Achernar gu-IN (generative)
          - Achernar he-IL (generative)
          - Achernar hi-IN (generative)
          - Achernar hr-HR (generative)
          - Achernar hu-HU (generative)
          - Achernar id-ID (generative)
          - Achernar kn-IN (generative)
          - Achernar ko-KR (generative)
          - Achernar lt-LT (generative)
          - Achernar lv-LV (generative)
          - Achernar ml-IN (generative)
          - Achernar mr-IN (generative)
          - Achernar nb-NO (generative)
          - Achernar nl-BE (generative)
          - Achernar pa-IN (generative)
          - Achernar pl-PL (generative)
          - Achernar pt-BR (generative)
          - Achernar ro-RO (generative)
          - Achernar ru-RU (generative)
          - Achernar sk-SK (generative)
          - Achernar sl-SI (generative)
          - Achernar sr-RS (generative)
          - Achernar sv-SE (generative)
          - Achernar sw-KE (generative)
          - Achernar ta-IN (generative)
          - Achernar te-IN (generative)
          - Achernar th-TH (generative)
          - Achernar tr-TR (generative)
          - Achernar uk-UA (generative)
          - Achernar ur-IN (generative)
          - Achernar vi-VN (generative)
          - Achernar yue-HK (generative)
          - Achird ar-XA (generative)
          - Achird bg (generative)
          - Achird bn-IN (generative)
          - Achird cmn-CN (generative)
          - Achird cs (generative)
          - Achird da-DK (generative)
          - Achird el-GR (generative)
          - Achird en-IN (generative)
          - Achird en-US (generative)
          - Achird es-US (generative)
          - Achird et-EE (generative)
          - Achird fi-FI (generative)
          - Achird fr-CA (generative)
          - Achird gu-IN (generative)
          - Achird he-IL (generative)
          - Achird hi-IN (generative)
          - Achird hr-HR (generative)
          - Achird hu-HU (generative)
          - Achird id-ID (generative)
          - Achird kn-IN (generative)
          - Achird ko-KR (generative)
          - Achird lt-LT (generative)
          - Achird lv-LV (generative)
          - Achird ml-IN (generative)
          - Achird mr-IN (generative)
          - Achird nb-NO (generative)
          - Achird nl-BE (generative)
          - Achird pa-IN (generative)
          - Achird pl-PL (generative)
          - Achird pt-BR (generative)
          - Achird ro-RO (generative)
          - Achird ru-RU (generative)
          - Achird sk-SK (generative)
          - Achird sl-SI (generative)
          - Achird sr-RS (generative)
          - Achird sv-SE (generative)
          - Achird sw-KE (generative)
          - Achird ta-IN (generative)
          - Achird te-IN (generative)
          - Achird th-TH (generative)
          - Achird tr-TR (generative)
          - Achird uk-UA (generative)
          - Achird ur-IN (generative)
          - Achird vi-VN (generative)
          - Achird yue-HK (generative)
          - Aditi
          - Agathe (generative)
          - Agnieszka (neural)
          - Agota
          - Agustina (generative)
          - Ahmet (neural)
          - Aigul (neural)
          - Aisha (beta)
          - Akash (beta)
          - Akemi (beta)
          - Alain (neural)
          - Alba (neural)
          - Aled (neural)
          - Alfie (neural)
          - Alina (neural)
          - Alnilam ar-XA (generative)
          - Alnilam bg (generative)
          - Alnilam bn-IN (generative)
          - Alnilam cmn-CN (generative)
          - Alnilam cs (generative)
          - Alnilam da-DK (generative)
          - Alnilam el-GR (generative)
          - Alnilam en-IN (generative)
          - Alnilam en-US (generative)
          - Alnilam es-US (generative)
          - Alnilam et-EE (generative)
          - Alnilam fi-FI (generative)
          - Alnilam fr-CA (generative)
          - Alnilam gu-IN (generative)
          - Alnilam he-IL (generative)
          - Alnilam hi-IN (generative)
          - Alnilam hr-HR (generative)
          - Alnilam hu-HU (generative)
          - Alnilam id-ID (generative)
          - Alnilam kn-IN (generative)
          - Alnilam ko-KR (generative)
          - Alnilam lt-LT (generative)
          - Alnilam lv-LV (generative)
          - Alnilam ml-IN (generative)
          - Alnilam mr-IN (generative)
          - Alnilam nb-NO (generative)
          - Alnilam nl-BE (generative)
          - Alnilam pa-IN (generative)
          - Alnilam pl-PL (generative)
          - Alnilam pt-BR (generative)
          - Alnilam ro-RO (generative)
          - Alnilam ru-RU (generative)
          - Alnilam sk-SK (generative)
          - Alnilam sl-SI (generative)
          - Alnilam sr-RS (generative)
          - Alnilam sv-SE (generative)
          - Alnilam sw-KE (generative)
          - Alnilam ta-IN (generative)
          - Alnilam te-IN (generative)
          - Alnilam th-TH (generative)
          - Alnilam tr-TR (generative)
          - Alnilam uk-UA (generative)
          - Alnilam ur-IN (generative)
          - Alnilam vi-VN (generative)
          - Alnilam yue-HK (generative)
          - Alonso (neural)
          - Alvaro (generative)
          - Alvaro (neural)
          - Ama (generative)
          - Amal (beta)
          - Amala (neural)
          - Amalthea (generative)
          - Amber (neural)
          - Ameera
          - Amy
          - Andrew (neural)
          - Andromeda (generative)
          - Aneta
          - Angelo (neural)
          - Annette (neural)
          - Antoine (neural)
          - Antonia (generative)
          - Antonin (neural)
          - Antonio (neural)
          - Aoede ar-XA (generative)
          - Aoede bg (generative)
          - Aoede bn-IN (generative)
          - Aoede cmn-CN (generative)
          - Aoede cs (generative)
          - Aoede da-DK (generative)
          - Aoede el-GR (generative)
          - Aoede en-IN (generative)
          - Aoede en-US (generative)
          - Aoede es-US (generative)
          - Aoede et-EE (generative)
          - Aoede fi-FI (generative)
          - Aoede fr-CA (generative)
          - Aoede gu-IN (generative)
          - Aoede he-IL (generative)
          - Aoede hi-IN (generative)
          - Aoede hr-HR (generative)
          - Aoede hu-HU (generative)
          - Aoede id-ID (generative)
          - Aoede kn-IN (generative)
          - Aoede ko-KR (generative)
          - Aoede lt-LT (generative)
          - Aoede lv-LV (generative)
          - Aoede ml-IN (generative)
          - Aoede mr-IN (generative)
          - Aoede nb-NO (generative)
          - Aoede nl-BE (generative)
          - Aoede pa-IN (generative)
          - Aoede pl-PL (generative)
          - Aoede pt-BR (generative)
          - Aoede ro-RO (generative)
          - Aoede ru-RU (generative)
          - Aoede sk-SK (generative)
          - Aoede sl-SI (generative)
          - Aoede sr-RS (generative)
          - Aoede sv-SE (generative)
          - Aoede sw-KE (generative)
          - Aoede ta-IN (generative)
          - Aoede te-IN (generative)
          - Aoede th-TH (generative)
          - Aoede tr-TR (generative)
          - Aoede uk-UA (generative)
          - Aoede ur-IN (generative)
          - Aoede vi-VN (generative)
          - Aoede yue-HK (generative)
          - Aoi (neural)
          - Apollo (generative)
          - Aquila (generative)
          - Arcas (generative)
          - Ardi (neural)
          - Aria (neural)
          - Ariane (neural)
          - Aries (generative)
          - Arif (beta)
          - Arjun
          - Arnau (neural)
          - Asad (neural)
          - Ashley (neural)
          - Asteria (generative)
          - Astrid
          - Athena (generative)
          - Athina (neural)
          - Atlas (generative)
          - Aurelia (generative)
          - Aurora (generative)
          - Ava (neural)
          - Avri (neural)
          - Bashkar (neural)
          - Beatrix (generative)
          - Beatriz (neural)
          - Bella (neural)
          - Benigno (neural)
          - Bernd (neural)
          - Bianca
          - Blessica (neural)
          - BongJin (neural)
          - Borislav (neural)
          - Brandon (neural)
          - Brenda (neural)
          - Brian
          - Brian (neural)
          - Brigitte (neural)
          - Calimero (neural)
          - Callirrhoe ar-XA (generative)
          - Callirrhoe bg (generative)
          - Callirrhoe bn-IN (generative)
          - Callirrhoe cmn-CN (generative)
          - Callirrhoe cs (generative)
          - Callirrhoe da-DK (generative)
          - Callirrhoe el-GR (generative)
          - Callirrhoe en-IN (generative)
          - Callirrhoe en-US (generative)
          - Callirrhoe es-US (generative)
          - Callirrhoe et-EE (generative)
          - Callirrhoe fi-FI (generative)
          - Callirrhoe fr-CA (generative)
          - Callirrhoe gu-IN (generative)
          - Callirrhoe he-IL (generative)
          - Callirrhoe hi-IN (generative)
          - Callirrhoe hr-HR (generative)
          - Callirrhoe hu-HU (generative)
          - Callirrhoe id-ID (generative)
          - Callirrhoe kn-IN (generative)
          - Callirrhoe ko-KR (generative)
          - Callirrhoe lt-LT (generative)
          - Callirrhoe lv-LV (generative)
          - Callirrhoe ml-IN (generative)
          - Callirrhoe mr-IN (generative)
          - Callirrhoe nb-NO (generative)
          - Callirrhoe nl-BE (generative)
          - Callirrhoe pa-IN (generative)
          - Callirrhoe pl-PL (generative)
          - Callirrhoe pt-BR (generative)
          - Callirrhoe ro-RO (generative)
          - Callirrhoe ru-RU (generative)
          - Callirrhoe sk-SK (generative)
          - Callirrhoe sl-SI (generative)
          - Callirrhoe sr-RS (generative)
          - Callirrhoe sv-SE (generative)
          - Callirrhoe sw-KE (generative)
          - Callirrhoe ta-IN (generative)
          - Callirrhoe te-IN (generative)
          - Callirrhoe th-TH (generative)
          - Callirrhoe tr-TR (generative)
          - Callirrhoe uk-UA (generative)
          - Callirrhoe ur-IN (generative)
          - Callirrhoe vi-VN (generative)
          - Callirrhoe yue-HK (generative)
          - Callista (generative)
          - Camila
          - Candela (neural)
          - Carina (generative)
          - Carla
          - Carlota (neural)
          - Carly (neural)
          - Carmen
          - Cataldo (neural)
          - Cecilio (neural)
          - Celeste (generative)
          - Celeste (neural)
          - Celine
          - Cesare (generative)
          - Chantal
          - Chao
          - Charon
          - Chen (beta)
          - Christel (neural)
          - Christoph (neural)
          - Christopher (neural)
          - Cinzia (generative)
          - Clara (neural)
          - Claude (neural)
          - Colette (neural)
          - Conchita
          - Connor (neural)
          - Conrad (neural)
          - Cora (generative)
          - Cora (neural)
          - Coralie (neural)
          - Cordelia (generative)
          - Cornelia (generative)
          - Cristiano
          - Daichi (neural)
          - Dalia (neural)
          - Daman (beta)
          - Daphne (generative)
          - Darina
          - Dario (neural)
          - Dariya (neural)
          - Darren (neural)
          - Daudi (neural)
          - Daulet (neural)
          - David
          - Davis (neural)
          - Delia (generative)
          - Demetra (generative)
          - Denise (neural)
          - Despina
          - Dhwani (neural)
          - Diana (generative)
          - Diego (neural)
          - Dinesh (beta)
          - Dionisio (generative)
          - Divya (beta)
          - Dmitry (neural)
          - Donato (neural)
          - Dora
          - Draco (generative)
          - Duarte (neural)
          - Duncan (neural)
          - Ebisu (generative)
          - Elara (generative)
          - Electra (generative)
          - Elena (neural)
          - Elias (neural)
          - Elio (generative)
          - Elizabeth (neural)
          - Elke (neural)
          - Elliot (neural)
          - Elsa (neural)
          - Elsie (neural)
          - Elvira (neural)
          - Elza (neural)
          - Emel (neural)
          - Emil (neural)
          - Emily (neural)
          - Emma
          - Emma (neural)
          - Enric (neural)
          - Enrique
          - Eric (neural)
          - Estrella (generative)
          - Estrella (neural)
          - Ethan (neural)
          - Evelin (beta)
          - Ewa
          - Fabian (generative)
          - Fabio (neural)
          - Fabiola (neural)
          - Fabrice (neural)
          - Fang
          - Farooq (beta)
          - Fenna (neural)
          - Fenrir ar-XA (generative)
          - Fenrir bg (generative)
          - Fenrir bn-IN (generative)
          - Fenrir cmn-CN (generative)
          - Fenrir cs (generative)
          - Fenrir da-DK (generative)
          - Fenrir el-GR (generative)
          - Fenrir en-IN (generative)
          - Fenrir en-US (generative)
          - Fenrir es-US (generative)
          - Fenrir et-EE (generative)
          - Fenrir fi-FI (generative)
          - Fenrir fr-CA (generative)
          - Fenrir gu-IN (generative)
          - Fenrir he-IL (generative)
          - Fenrir hi-IN (generative)
          - Fenrir hr-HR (generative)
          - Fenrir hu-HU (generative)
          - Fenrir id-ID (generative)
          - Fenrir kn-IN (generative)
          - Fenrir ko-KR (generative)
          - Fenrir lt-LT (generative)
          - Fenrir lv-LV (generative)
          - Fenrir ml-IN (generative)
          - Fenrir mr-IN (generative)
          - Fenrir nb-NO (generative)
          - Fenrir nl-BE (generative)
          - Fenrir pa-IN (generative)
          - Fenrir pl-PL (generative)
          - Fenrir pt-BR (generative)
          - Fenrir ro-RO (generative)
          - Fenrir ru-RU (generative)
          - Fenrir sk-SK (generative)
          - Fenrir sl-SI (generative)
          - Fenrir sr-RS (generative)
          - Fenrir sv-SE (generative)
          - Fenrir sw-KE (generative)
          - Fenrir ta-IN (generative)
          - Fenrir te-IN (generative)
          - Fenrir th-TH (generative)
          - Fenrir tr-TR (generative)
          - Fenrir uk-UA (generative)
          - Fenrir ur-IN (generative)
          - Fenrir vi-VN (generative)
          - Fenrir yue-HK (generative)
          - Fernanda (neural)
          - Fiamma (neural)
          - Filiz
          - Finn (neural)
          - Flavio (generative)
          - Francisca (neural)
          - Freya (neural)
          - Fuaad
          - Fujin (generative)
          - Gabriela (beta)
          - Gabrijela (neural)
          - Gadis (neural)
          - Gagan (neural)
          - Ganesh (beta)
          - Geraint
          - Gerardo (neural)
          - Gianna (beta)
          - Gianni (neural)
          - Giorgio
          - Giovanna (neural)
          - Giuseppe (neural)
          - Gloria (generative)
          - GookMin (neural)
          - Gudrun (neural)
          - Gunnar (neural)
          - Guy (neural)
          - Gwyneth
          - Hamed (neural)
          - Hans
          - Harmonia (generative)
          - Harri (neural)
          - Hector (generative)
          - Helena (generative)
          - Henri (neural)
          - Henriques (beta)
          - Hera (generative)
          - Hermes (generative)
          - Hestia (generative)
          - Hila (neural)
          - Hillevi (neural)
          - Himchan (beta)
          - HiuGaai (neural)
          - HiuMaan (neural)
          - HoaiMy (neural)
          - Hollie (neural)
          - HsiaoChen (neural)
          - HsiaoYu (neural)
          - Huang (beta)
          - Humberto (neural)
          - Hussein (beta)
          - Hyperion (generative)
          - Hyunsu (neural)
          - Idan
          - Imelda (neural)
          - InJoon (neural)
          - Indah (beta)
          - Ines
          - Ingrid (neural)
          - Irene (neural)
          - Iris (generative)
          - Irma (neural)
          - Isabella (neural)
          - Iselin (neural)
          - Ivy
          - Izanami (generative)
          - Jacek
          - Jacinda (beta)
          - Jacob (neural)
          - Jacqueline (neural)
          - Jamal (neural)
          - Jan
          - Jan (neural)
          - Jane (neural)
          - Janus (generative)
          - Jason (neural)
          - Javier (generative)
          - Jean (neural)
          - Jennifer
          - Jenny (neural)
          - Jeppe (neural)
          - Jeraldo (beta)
          - Jerome (neural)
          - JiMin (neural)
          - Jina (beta)
          - Joana (neural)
          - Joanna
          - Joanne (neural)
          - Joey
          - Jonas (neural)
          - Jorge (neural)
          - Josephine (neural)
          - Julio (neural)
          - Julius (generative)
          - Juno (generative)
          - Jupiter (generative)
          - Justin
          - Kalina (neural)
          - Kara (generative)
          - Karl
          - Kasper (neural)
          - Katja (neural)
          - Keita (neural)
          - Ken (neural)
          - Kendra
          - Killian (neural)
          - Kim (neural)
          - Kimberly
          - Kirti (beta)
          - Klarissa (neural)
          - Klaus (neural)
          - Kore ar-XA (generative)
          - Kore bg (generative)
          - Kore bn-IN (generative)
          - Kore cmn-CN (generative)
          - Kore cs (generative)
          - Kore da-DK (generative)
          - Kore el-GR (generative)
          - Kore en-IN (generative)
          - Kore en-US (generative)
          - Kore es-US (generative)
          - Kore et-EE (generative)
          - Kore fi-FI (generative)
          - Kore fr-CA (generative)
          - Kore gu-IN (generative)
          - Kore he-IL (generative)
          - Kore hi-IN (generative)
          - Kore hr-HR (generative)
          - Kore hu-HU (generative)
          - Kore id-ID (generative)
          - Kore kn-IN (generative)
          - Kore ko-KR (generative)
          - Kore lt-LT (generative)
          - Kore lv-LV (generative)
          - Kore ml-IN (generative)
          - Kore mr-IN (generative)
          - Kore nb-NO (generative)
          - Kore nl-BE (generative)
          - Kore pa-IN (generative)
          - Kore pl-PL (generative)
          - Kore pt-BR (generative)
          - Kore ro-RO (generative)
          - Kore ru-RU (generative)
          - Kore sk-SK (generative)
          - Kore sl-SI (generative)
          - Kore sr-RS (generative)
          - Kore sv-SE (generative)
          - Kore sw-KE (generative)
          - Kore ta-IN (generative)
          - Kore te-IN (generative)
          - Kore th-TH (generative)
          - Kore tr-TR (generative)
          - Kore uk-UA (generative)
          - Kore ur-IN (generative)
          - Kore vi-VN (generative)
          - Kore yue-HK (generative)
          - Laia (neural)
          - Lara (generative)
          - Larissa (neural)
          - Lars (generative)
          - Lea
          - Leda (generative)
          - Leda ar-XA (generative)
          - Leda bg (generative)
          - Leda bn-IN (generative)
          - Leda cmn-CN (generative)
          - Leda cs (generative)
          - Leda da-DK (generative)
          - Leda el-GR (generative)
          - Leda en-IN (generative)
          - Leda en-US (generative)
          - Leda es-US (generative)
          - Leda et-EE (generative)
          - Leda fi-FI (generative)
          - Leda fr-CA (generative)
          - Leda gu-IN (generative)
          - Leda he-IL (generative)
          - Leda hi-IN (generative)
          - Leda hr-HR (generative)
          - Leda hu-HU (generative)
          - Leda id-ID (generative)
          - Leda kn-IN (generative)
          - Leda ko-KR (generative)
          - Leda lt-LT (generative)
          - Leda lv-LV (generative)
          - Leda ml-IN (generative)
          - Leda mr-IN (generative)
          - Leda nb-NO (generative)
          - Leda nl-BE (generative)
          - Leda pa-IN (generative)
          - Leda pl-PL (generative)
          - Leda pt-BR (generative)
          - Leda ro-RO (generative)
          - Leda ru-RU (generative)
          - Leda sk-SK (generative)
          - Leda sl-SI (generative)
          - Leda sr-RS (generative)
          - Leda sv-SE (generative)
          - Leda sw-KE (generative)
          - Leda ta-IN (generative)
          - Leda te-IN (generative)
          - Leda th-TH (generative)
          - Leda tr-TR (generative)
          - Leda uk-UA (generative)
          - Leda ur-IN (generative)
          - Leda vi-VN (generative)
          - Leda yue-HK (generative)
          - Leela (beta)
          - Leila (neural)
          - Leni (neural)
          - Leticia (neural)
          - Lia (neural)
          - Liam (neural)
          - Libby (neural)
          - Liberto (neural)
          - Lien (beta)
          - Lin (beta)
          - Linda
          - Lisandro (neural)
          - Liu (beta)
          - Liv
          - Livia (generative)
          - Lotte
          - Louisa (neural)
          - Luciano (generative)
          - Luciano (neural)
          - Lukas (neural)
          - Luna (generative)
          - Lupe
          - Maarten (neural)
          - Madhur (neural)
          - Madina (neural)
          - Mads
          - Mai (beta)
          - Maia (generative)
          - Maja
          - Maja (neural)
          - Manohar (neural)
          - Manuela (neural)
          - Marek (neural)
          - Marina (neural)
          - Marlene
          - Mars (generative)
          - Mathieu
          - Matthew
          - Mattias (neural)
          - Maurice (neural)
          - Maxim
          - Mayu (neural)
          - Meira
          - Melia (generative)
          - Mia
          - Michelle (neural)
          - Midhun (neural)
          - Miguel
          - Minerva (generative)
          - Ming
          - Minho (beta)
          - Mizuki
          - Mohan (neural)
          - Monica (neural)
          - Mouna (neural)
          - Naja
          - NamMinh (neural)
          - Namratha (beta)
          - Nanami (neural)
          - Nancy (neural)
          - Naoki (neural)
          - Natalia
          - Natasha (neural)
          - Natchaya (beta)
          - Neerja (neural)
          - Neil (neural)
          - Neptune (generative)
          - Nestor (generative)
          - Nestoras (neural)
          - Nia (neural)
          - Nicolau (neural)
          - Nicole
          - Nijat
          - Nil (neural)
          - Niranjan (neural)
          - Niwat (neural)
          - Noah (neural)
          - Noemi (neural)
          - Noora (neural)
          - Nuria (neural)
          - Nurin
          - Nurul (beta)
          - Odysseus (generative)
          - Oliver (neural)
          - Olivia (generative)
          - Olivia (neural)
          - Ophelia (generative)
          - Orion (generative)
          - Orpheus (generative)
          - Orus ar-XA (generative)
          - Orus bg (generative)
          - Orus bn-IN (generative)
          - Orus cmn-CN (generative)
          - Orus cs (generative)
          - Orus da-DK (generative)
          - Orus el-GR (generative)
          - Orus en-IN (generative)
          - Orus en-US (generative)
          - Orus es-US (generative)
          - Orus et-EE (generative)
          - Orus fi-FI (generative)
          - Orus fr-CA (generative)
          - Orus gu-IN (generative)
          - Orus he-IL (generative)
          - Orus hi-IN (generative)
          - Orus hr-HR (generative)
          - Orus hu-HU (generative)
          - Orus id-ID (generative)
          - Orus kn-IN (generative)
          - Orus ko-KR (generative)
          - Orus lt-LT (generative)
          - Orus lv-LV (generative)
          - Orus ml-IN (generative)
          - Orus mr-IN (generative)
          - Orus nb-NO (generative)
          - Orus nl-BE (generative)
          - Orus pa-IN (generative)
          - Orus pl-PL (generative)
          - Orus pt-BR (generative)
          - Orus ro-RO (generative)
          - Orus ru-RU (generative)
          - Orus sk-SK (generative)
          - Orus sl-SI (generative)
          - Orus sr-RS (generative)
          - Orus sv-SE (generative)
          - Orus sw-KE (generative)
          - Orus ta-IN (generative)
          - Orus te-IN (generative)
          - Orus th-TH (generative)
          - Orus tr-TR (generative)
          - Orus uk-UA (generative)
          - Orus ur-IN (generative)
          - Orus vi-VN (generative)
          - Orus yue-HK (generative)
          - Osman (neural)
          - Ostap (neural)
          - Pallavi (neural)
          - Palmira (neural)
          - Paloma (neural)
          - Pandora (generative)
          - Pelayo (neural)
          - Penelope
          - Pernille (neural)
          - Perseo (generative)
          - Petra (neural)
          - Phoebe (generative)
          - Pierina (neural)
          - Pluto (generative)
          - Polina (neural)
          - Prabhat (neural)
          - Premwadee (neural)
          - Quan (beta)
          - Rafiki (neural)
          - Ralf (neural)
          - Raquel (neural)
          - Raveena
          - Rehema (neural)
          - Renata (neural)
          - Revati
          - Reza (beta)
          - Rhea (generative)
          - Ricardo
          - Rinaldo (neural)
          - Roger (neural)
          - Rok (neural)
          - Roman (generative)
          - Ruben
          - Russell
          - Ryan (neural)
          - Sadaltager ar-XA (generative)
          - Sadaltager bg (generative)
          - Sadaltager bn-IN (generative)
          - Sadaltager cmn-CN (generative)
          - Sadaltager cs (generative)
          - Sadaltager da-DK (generative)
          - Sadaltager el-GR (generative)
          - Sadaltager en-IN (generative)
          - Sadaltager en-US (generative)
          - Sadaltager es-US (generative)
          - Sadaltager et-EE (generative)
          - Sadaltager fi-FI (generative)
          - Sadaltager fr-CA (generative)
          - Sadaltager gu-IN (generative)
          - Sadaltager he-IL (generative)
          - Sadaltager hi-IN (generative)
          - Sadaltager hr-HR (generative)
          - Sadaltager hu-HU (generative)
          - Sadaltager id-ID (generative)
          - Sadaltager kn-IN (generative)
          - Sadaltager ko-KR (generative)
          - Sadaltager lt-LT (generative)
          - Sadaltager lv-LV (generative)
          - Sadaltager ml-IN (generative)
          - Sadaltager mr-IN (generative)
          - Sadaltager nb-NO (generative)
          - Sadaltager nl-BE (generative)
          - Sadaltager pa-IN (generative)
          - Sadaltager pl-PL (generative)
          - Sadaltager pt-BR (generative)
          - Sadaltager ro-RO (generative)
          - Sadaltager ru-RU (generative)
          - Sadaltager sk-SK (generative)
          - Sadaltager sl-SI (generative)
          - Sadaltager sr-RS (generative)
          - Sadaltager sv-SE (generative)
          - Sadaltager sw-KE (generative)
          - Sadaltager ta-IN (generative)
          - Sadaltager te-IN (generative)
          - Sadaltager th-TH (generative)
          - Sadaltager tr-TR (generative)
          - Sadaltager uk-UA (generative)
          - Sadaltager ur-IN (generative)
          - Sadaltager vi-VN (generative)
          - Sadaltager yue-HK (generative)
          - Salli
          - Salma (neural)
          - Samantha (beta)
          - Sander (generative)
          - Sapna (neural)
          - Sara (neural)
          - Sardor (neural)
          - Saturn (generative)
          - Saul (neural)
          - Sayan (beta)
          - Selena (generative)
          - Selene (generative)
          - Selma (neural)
          - SeoHyeon (neural)
          - Seoyeon
          - Seraphina (neural)
          - Shakir (neural)
          - Shashank (beta)
          - Shiori (neural)
          - Shruti (beta)
          - Shruti (neural)
          - Silvia (generative)
          - Sirio (generative)
          - Sobhana (neural)
          - Sofie (neural)
          - Sonia (neural)
          - SoonBok (neural)
          - Sophia (beta)
          - Srecko (neural)
          - Steffan (neural)
          - Sumi (beta)
          - SunHi (neural)
          - Sushmita (beta)
          - Svetlana (neural)
          - Swara (neural)
          - Sylvie (neural)
          - Takumi
          - Tamas (neural)
          - Tanishaa (neural)
          - Tanja (neural)
          - Tatyana
          - Teo (neural)
          - Thalia (generative)
          - Thalita (neural)
          - Theia (generative)
          - Thierry (neural)
          - Thomas (neural)
          - Tim (neural)
          - Tina (neural)
          - Tomas (neural)
          - Tony (neural)
          - Triana (neural)
          - Tuan (beta)
          - Ulyana
          - Uzma (neural)
          - Uzume (generative)
          - Valerio (generative)
          - Valerio (neural)
          - Valluvar (neural)
          - Vera (neural)
          - Vesta (generative)
          - Vicki
          - Vijay (beta)
          - Viktoria (generative)
          - Viktoria (neural)
          - Vishnu (beta)
          - Vitoria
          - Vivienne (neural)
          - Vlasta (neural)
          - WanLung (neural)
          - Wang (beta)
          - William (neural)
          - Xiaochen (neural)
          - Xiaohan (neural)
          - Xiaomeng (neural)
          - Xiaomo (neural)
          - Xiaoqiu (neural)
          - Xiaorou (neural)
          - Xiaorui (neural)
          - Xiaoxiao (neural)
          - Xiaoyan (neural)
          - Xiaoyi (neural)
          - Xiaozhen (neural)
          - Ximena (neural)
          - Yago (neural)
          - Yara (neural)
          - Yasmin (neural)
          - Yosef
          - YuJin (neural)
          - YunJhe (neural)
          - Yunfeng (neural)
          - Yunhao (neural)
          - Yunjian (neural)
          - Yunjie (neural)
          - Yunxi (neural)
          - Yunxia (neural)
          - Yunyang (neural)
          - Yunye (neural)
          - Yunze (neural)
          - Yves (neural)
          - Yvette (neural)
          - Zariyah (neural)
          - Zeina
          - Zeus (generative)
          - Zhang (beta)
          - Zhiyu
          - Zofia (neural)
          - Zuri (neural)
      title: PublicVoicePreferences
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageData:
      allOf:
      - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageBase'
      - type: object
        properties:
          message:
            $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage'
          contact:
            allOf:
            - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ContactName'
            description: Information about recipient.
            readOnly: false
            writeOnly: true
      title: InboundMessageData
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateCategory:
      type: string
      description: Business category of the template, used for classification and approval routing.
      enum:
      - OTP
      - TRANSACTIONAL
      example: TRANSACTIONAL
      title: TemplateCategory
    fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.GcmData:
      type: object
      description: GCM data.
      properties:
        enabled:
          type: boolean
          description: Equals true if sending messages via Firebase is enabled for this application.
      title: GcmData
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveProductMessage
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignResponse:
      type: object
      description: List of campaigns.
      properties:
        id:
          type: string
          description: Campaign ID.
          example: '6938008105758'
        name:
          type: string
          description: Campaign name.
          example: Campaign Name
        dailyBudget:
          type: integer
          format: int64
          description: Daily budget in cents. Zero if a lifetime budget is set.
          example: 0
        lifetimeBudget:
          type: integer
          format: int64
          description: Lifetime budget in cents.
          example: 3000
        adAccountId:
          type: string
          description: Ad account ID.
          example: '3339405976215927'
        pageId:
          type: string
          description: Facebook Page ID.
          example: '975663645629834'
        startTime:
          type: string
          description: Campaign start time.
          example: 2026-04-20T01:08:10-0700
        endTime:
          type: string
          description: Campaign end time.
          example: 2026-05-20T01:08:09-0700
      title: GetCampaignResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQuality:
      type: object
      description: List of the quality information related to specific senders.
      properties:
        sender:
          type: string
          description: Sender to whom the information refers.
          example: '447796344125'
        qualityRating:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityRating'
        status:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderStatus'
        currentLimit:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderLimit'
        lastUpdated:
          type: string
          format: date-time
          description: Last modification date.
          example: '2023-02-18T08:12:26.422Z'
      required:
      - currentLimit
      - qualityRating
      - sender
      - status
      title: WhatsAppSenderQuality
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.TimeOfDay:
      type: object
      properties:
        hour:
          type: integer
          format: int32
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          maximum: 59
          minimum: 0
      title: TimeOfDay
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest:
      type: object
      properties:
        name:
          type: string
          description: Conference name, will be auto-generated if not provided.
        recording:
          $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
      title: ActionConferenceRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContentType:
      type: string
      enum:
      - FILE
      - URL
      - RECORDING
      - TEXT
      - TTY
      title: PublicPlayContentType
    1a32a5811401e5289f9edb3a3b051fee21e1ffff7ad179f3aead79d4a871821d.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.FileFormat:
      type: string
      description: File format.
      enum:
      - PNG
      - JPEG
      example: PNG
      title: FileFormat
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent:
      type: string
      description: Recording status delivered with the record callback.
      enum:
      - in-progress
      - completed
      example: in-progress
      title: RecordingStatusEvent
    d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventModel:
      type: object
      description: Conversion events collection.
      properties:
        ctwaClickId:
          type: string
          description: ctwaClickId is unique identifier of each click on the ad that clicks to WhatsApp. ctwaClickId is contained within the inbound message originating from the ad within the referral object. Check payload [here](https://www.infobip.com/docs/api/channels/whatsapp/whatsapp-inbound-messages/receive-whatsapp-inbound-messages).
          example: ARAkLkA8rmlFeiCktEJQ-QT
          minLength: 1
        type:
          $ref: '#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionType'
        details:
          type: object
          additionalProperties:
            type: object
            example:
              currency: USD
              value: 123
            required:
            - currency
            - value
          description: Details should contain value and currency information indicating exact value of the conversion that happened. Value can be 0. Currency has to be the same as it is set on ad account.
          example:
            currency: USD
            value: 123
          required:
          - currency
          - value
        conversionTime:
          type: string
          format: date-time
          description: Time when the conversion happened. Must be in the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Date must not be older than 7 days. If omitted then current time of submission is used.
          example: '2024-05-14T10:11:45.057Z'
      required:
      - ctwaClickId
      - type
      title: ConversionEventModel
    4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSayRequest:
      type: object
      properties:
        text:
          type: string
          description: Text to read.
        language:
          type: string
          description: Text language. Must be defined for correct pronunciation. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/getting-started#text-to-speech-add-ons-and-options).
          enum:
          - ar
          - ar-ma
          - ar_xa
          - bg
          - bn
          - bn-in
          - ca
          - cmn-cn
          - cs
          - da
          - de
          - de-at
          - de-ch
          - el
          - en
          - en-au
          - en-ca
          - en-gb
          - en-gb-wls
          - en-ie
          - en-in
          - en-ph
          - es
          - es-419
          - es-ar
          - es-co
          - es-mx
          - es-us
          - et-ee
          - fi
          - fil-ph
          - fr
          - fr-ca
          - fr-ch
          - gu
          - he
          - hi
          - hr
          - hu
          - id
          - is
          - it
          - ja
          - kk-kz
          - kn
          - ko
          - lt
          - lv
          - ml
          - mr-in
          - ms
          - nb-no
          - nl
          - nl-be
          - 'no'
          - pa-in
          - pl
          - pt-br
          - pt-pt
          - ro
          - ru
          - sk
          - sl
          - sr-rs
          - sv
          - sw-ke
          - sw-tz
          - ta
          - te
          - th
          - tr
          - uk
          - ur-in
          - ur-pk
          - uz-uz
          - vi
          - wls
          - yue-hk
          - zh-cn
          - zh-tw
        speechRate:
          type: number
          format: double
          description: Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`.
          maximum: 2
          minimum: 0.5
        loopCount:
          type: integer
          format: int32
          description: Number of times to read the text.
        preferences:
          $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences'
      required:
      - language
      - text
      title: ConferenceSayRequest
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - LOCATION
      - VIDEO
      - AUDIO
      - DOCUMENT
      - SENDER_ACTION
      - TEMPLATE
      - COMMENT
      - POST
      - OPT_IN_FOLLOWUP
      - MARKETING_MESSAGE
      title: FacebookOutboundContentType
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotification:
      type: object
      properties:
        from:
          type: string
          description: Number of the payer.
          minLength: 1
        type:
          type: string
          description: Type of the notification. It is always `payment`.
          minLength: 1
        referenceId:
          type: string
          description: Unique identifier generated by the payment service provider.
          minLength: 1
        paymentId:
          type: string
          description: Unique identifier of the payment.
          minLength: 1
        paymentStatus:
          type: string
          description: Status of the payment.
          enum:
          - NEW
          - PENDING
          - CAPTURED
          - CANCELED
          - FAILED
          - UNKNOWN
        currency:
          type: string
          description: Currency of the payment.
          enum:
          - INR
          - BRL
          - UNKNOWN
        totalAmountValue:
          type: integer
          description: Value of the payment amount multiplied by the offset.
          minimum: 1
        totalAmountOffset:
          type: integer
          description: Offset of the payment amount (100 for INR and BRL).
          minimum: 1
        callbackData:
          type: array
          description: List of custom parameters corresponding to the transaction. Available only for UPI Payments.
          items:
            type: string
            minLength: 0
          minItems: 0
        transactions:
          type: array
          description: Transactions of the payment.
          items:
            $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentTransactionNotification'
          minItems: 0
      title: whatsappPaymentNotification
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRate:
      type: object
      description: Call rate defined in number of calls created per second, minute, hour, or day.
      properties:
        maxCalls:
          type: integer
          format: int32
          description: Defines the number of calls scheduled per specified time unit.
        timeUnit:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeUnit'
      title: CallRate
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination'
        content:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContent'
        options:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: AppleMfbMessage
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogRequest:
      type: object
      properties:
        parentCallId:
          type: string
          description: Unique parent call ID.
          maxLength: 128
        childCallRequest:
          $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest'
        recording:
          $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
        propagationOptions:
          $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions'
      required:
      - parentCallId
      title: DialogRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioMediaProperties:
      type: object
      description: Audio media properties.
      properties:
        muted:
          type: boolean
          description: Indicates whether the end user can speak.
        userMuted:
          type: boolean
          description: Indicates whether the end user muted himself.
        deaf:
          type: boolean
          description: Indicates whether the end user can hear.
      title: AudioMediaProperties
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCardContent:
      type: object
      description: Carousel cards. Should be defined in the correct order. It can have between one and ten cards.
      properties:
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent'
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent'
        buttons:
          type: array
          description: Card buttons. Define buttons only for `quick reply` or `dynamic URL` buttons (in the required order). For static URL button, omit the buttons section.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent'
          maxItems: 2
          minItems: 1
      required:
      - header
      title: TemplateCardContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrData:
      type: object
      description: Fields representing details about IVR, if outbound IVR is being used. If the call was not IVR, the field will be null.
      properties:
        scenarioId:
          type: string
          description: The ID that uniquely identifies the IVR scenario.
        scenarioName:
          type: string
          description: Name of IVR scenario.
        collectedDtmfs:
          type: string
          description: JSON object showing the result of every CollectAction in IVR scenario in the form of key/value pairs, where the key is CollectAction variable and pair is collected DTMF.
        collectedMappedDtmfs:
          type: string
          description: JSON object showing the result of every CollectAction in IVR scenario with the mapped, meaningful, values you defined in CollectAction `mappedValues` option.
        spokenInput:
          type: string
          description: JSON object showing the result of every CaptureSpeech action with full text spoken by the user.
        matchedSpokenInput:
          type: string
          description: JSON object showing the result of every CaptureSpeech action with only the key phrases that matched user spoken input.
      title: IvrData
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineDetectionCallbackRequest:
      type: object
      description: Markup Language machine detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once machine detection has completed. Extends the instructions callback payload with the machine detection result and confidence ratings.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        machineDetectionResult:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus'
        confidenceRating:
          type: object
          additionalProperties:
            type: number
            format: double
          description: Confidence rating for the machine detection result.
          example:
            HUMAN: 0.92
            MACHINE: 0.08
      title: MachineDetectionCallbackRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryDay'
        from:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime'
        to:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationResponse:
      type: object
      description: List of configurations.
      properties:
        key:
          type: string
          description: Configuration key.
      required:
      - key
      title: ConfigurationResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus:
      type: string
      description: Indicates whether the route is enabled or not.
      enum:
      - ENABLED
      - DISABLED
      title: RouteStatus
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveOrderStatusMessage
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoWebhookResult:
      type: object
      properties:
        entityId:
          type: string
          description: The ID of the entity, if application and entity management is used.
        applicationId:
          type: string
          description: The ID of the application, if application and entity management is used.
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
        to:
          type: string
          description: Message destination address.
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the message.
        messageId:
          type: string
          description: ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Custom callback data can be inserted during the setup phase.
        userAgent:
          type: string
          description: Identifier of the device from which the message was sent.
        message:
          type: array
          description: All parts of the received message.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoMessageSegment'
        group:
          type: array
          description: Recipients of group MMS.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestination'
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price'
      title: MMSMoWebhookResult
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: DialogPage
    d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventRequest:
      type: object
      properties:
        sourceId:
          type: string
          description: Conversion events source identifier. In case of ads that click to WhatsApp, it should be the Facebook Page selected through Ads manager and through Exchange app. Could be omitted if only one page is connected through Exchange app.
        conversions:
          type: array
          description: Conversion events collection.
          items:
            $ref: '#/components/schemas/d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionEventModel'
          maxItems: 1000
          minItems: 1
      required:
      - conversions
      title: ConversionEventRequest
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogResponseLogKakaoSangdamOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogKakaoSangdamOutboundContent'
        cursor:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.CursorPageInfo'
      title: LogResponseLogKakaoSangdamOutboundContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromRecording:
      type: object
      description: Play from Recording Action plays audio recorded from the current or some other call.
      properties:
        playFromRecording:
          type: string
          description: Identifier of the recorded file. The parameter can be constructed using variables.
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - playFromRecording
      title: Play From Recording
    87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationUpdateRequest:
      type: object
      properties:
        name:
          type: string
          description: Calls configuration name.
          maxLength: 128
          minLength: 1
      title: CallsConfigurationUpdateRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSTextualMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        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](#channels/sms/get-outbound-sms-message-delivery-reports). The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
          writeOnly: true
        deliveryTimeWindow:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow'
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination'
          writeOnly: true
        flash:
          type: boolean
          default: false
          description: Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.
          writeOnly: true
        from:
          type: string
          description: The sender ID which 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).
          writeOnly: true
        intermediateReport:
          type: boolean
          description: The [real-time intermediate delivery report](#channels/sms/receive-outbound-sms-message-report) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
          writeOnly: true
        language:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language'
        notifyContentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
          writeOnly: true
        notifyUrl:
          type: string
          description: 'The URL on your call back server on to which a delivery report will be sent. The [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) for when your URL becomes unavailable uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
          externalDocs:
            description: Delivery report format
            url: '#channels/sms/receive-sent-sms-report'
          writeOnly: true
        regional:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.RegionalOptions'
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for [scheduled SMS](#channels/sms/get-scheduled-sms-messages). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
          writeOnly: true
        text:
          type: string
          description: Content of the message being sent.
          writeOnly: true
        transliteration:
          type: string
          description: The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int64
          description: The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.
          writeOnly: true
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 50
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 50
          minLength: 0
          writeOnly: true
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      required:
      - destinations
      title: SMSTextualMessage
    5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddressRequest:
      type: object
      description: SIP trunk service address request.
      properties:
        name:
          type: string
          description: SIP trunk service address name.
        street:
          type: string
          description: SIP trunk service address street.
        city:
          type: string
          description: SIP trunk service address city.
        postCode:
          type: string
          description: SIP trunk service address post code.
        suite:
          type: string
          description: SIP trunk service address suite.
        countryCode:
          type: string
          description: SIP trunk service address [country code](#get-countries).
        countryRegionCode:
          type: string
          description: SIP trunk service address [country region code](#get-regions). Mandatory for countries that have defined regions.
      required:
      - city
      - countryCode
      - name
      - postCode
      - street
      title: PublicSipTrunkServiceAddressRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Dial:
      type: object
      description: Dial action connects the call to one or more endpoints.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - dial
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        endpointCallback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        from:
          type: string
          description: Caller ID to use when dialing.
        connectTimeout:
          type: integer
          format: int32
          description: Connection timeout in seconds (1 to 30).
          maximum: 30
          minimum: 1
        hangupOn:
          type: string
          description: Digit to press to hang up the call.
          maxLength: 1
          minLength: 0
        answerBeforeConnecting:
          type: boolean
          default: false
          description: Whether to answer the call before connecting to endpoints.
        recording:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialRecording'
        maxDuration:
          type: integer
          format: int32
          description: Maximum call duration in seconds.
        ringTone:
          type: string
          description: Ring tone to play while connecting.
        endpoints:
          type: array
          description: List of endpoints to dial (1 to 10).
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint'
          maxItems: 10
          minItems: 1
        machineDetection:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection'
      required:
      - action
      - endpoints
      title: Dial
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FooterApiData:
      type: object
      description: Template footer.
      properties:
        text:
          type: string
          description: Plain text, up to 60 characters.
          maxLength: 60
          minLength: 0
      required:
      - text
      title: FooterApiData
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContentType:
      type: string
      enum:
      - MESSAGE
      - DELIVERED
      - SUBSCRIBED
      - UNSUBSCRIBED
      - CONVERSATION_STARTED
      title: ViberBotInboundContentType
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryOptions:
      type: object
      description: 'Used to determine whether to retry the delivery of a bulk call if the initial attempt fails. Additional retries will occur based on the schedule defined by the _minWaitPeriod_ and _maxWaitPeriod_ parameters, as well as the platform''s internal retry logic. If _minWaitPeriod_ differs from _maxWaitPeriod_, the delivery will be retried according to the following schedule: after 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours, or until _maxWaitPeriod_ is reached. Once the retry attempt for _maxWaitPeriod_ is reached, _maxWaitPeriod_ will be used for all subsequent retries. If _minWaitPeriod_ and _maxWaitPeriod_ are defined as equal values, the period between retries will be equal to this value. Bulk call delivery will be retried until successful delivery, call validity expiration, or reaching the _maxAttempts_ value.'
      properties:
        minWaitPeriod:
          type: integer
          format: int32
          description: Defines the minimum waiting time (in minutes) after the previous failed attempt before trying to establish the call again. Supported values are 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours. If entered a value that is not in the list but is smaller than 24 hours, the next bigger value from the list will be used. If a value larger than 24 hours is entered, 24 hours will be used.
        maxWaitPeriod:
          type: integer
          format: int32
          description: Defines the maximum waiting time (in minutes) after the previous failed attempt before trying to establish the call again. Supported values are 1 minute, 2 minutes, 5 minutes, 10 minutes, 20 minutes, 30 minutes, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, and 24 hours. If entered a value that is not in the list but is smaller than 24 hours, the next bigger value from the list will be used. If a value larger than 24 hours is entered, 24 hours will be used.
        maxAttempts:
          type: integer
          format: int32
          description: Defines the maximum number of retry attempts. The maximum value is `4`. If a value higher than `4` is entered, it will be set to `4`.
      title: RetryOptions
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateLang:
      type: string
      description: Language code for the template body.
      enum:
      - ar
      - hy
      - be
      - bs
      - bg
      - my
      - hr
      - cs
      - da
      - nl
      - en
      - fi
      - fr
      - ka
      - de
      - el
      - he
      - hu
      - id
      - it
      - ja
      - ne
      - 'no'
      - fa
      - pl
      - ro
      - ru
      - sr
      - sk
      - sl
      - es
      - sv
      - th
      - tr
      - uk
      - vi
      example: en
      title: TemplateLang
    6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.CallRecording:
      type: object
      description: Call recording metadata.
      properties:
        callId:
          type: string
          description: Call identifier.
        endpoint:
          type: string
          description: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
        direction:
          type: string
          description: Call direction.
          enum:
          - INBOUND
          - OUTBOUND
        status:
          type: string
          description: Status of call recording.
        reason:
          type: string
          description: Reason for recording failure.
        files:
          type: array
          description: Recording files.
          items:
            $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile'
      title: CallRecording
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.QuotaInfo:
      type: object
      description: Information about ZNS message quotas.
      properties:
        dailyQuota:
          type: integer
          format: int64
          description: Number of ZNS messages that the OA can send in a day.
        remainingDailyQuota:
          type: integer
          format: int64
          description: Remaining number of ZNS messages that the OA can send in a day.
        monthlyPromotionQuota:
          type: integer
          format: int64
          description: Number of ZNS promotional messages that the OA can send in a month.
        remainingMonthlyPromotionQuota:
          type: integer
          format: int64
          description: Remaining number of ZNS promotional messages that the OA can send in a month.
        estimatedNextMonthPromotionQuota:
          type: integer
          format: int64
          description: Estimated number of ZNS promotional messages that the OA can send in the next month.
      title: QuotaInfo
    a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenRequestModel:
      type: object
      properties:
        identity:
          type: string
          description: The identity used to present user on Infobip WebRTC platform. Must be unique. Must contain at least 3 and at most 64 unicode characters including -, _, ..
          pattern: ^[\p{L}\p{N}\-_+=/.]{3,64}$
        displayName:
          type: string
          description: Optional. A human-readable name for a given identity. Does not have to be unique. If set, it will be presented to all other users communicating with the identified user, along with identity. Must contain at least 5 and at most 50 characters.
        timeToLive:
          type: integer
          format: int64
          description: Optional. This field represents a number of seconds until the token expires. If not set, the token will last 8 hours. The maximum value is 24 hours.
      required:
      - identity
      title: TokenRequestModel
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the message within the bulk.
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the email is to be sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-01-02T01:00:00.123Z'
      required:
      - bulkId
      - sendAt
      title: BulkRescheduleResponse
    5e0af18dea7a9fe7fc7475b275c0dd721ec8be9556c5d111334ce121ba3ef90a.EndTagResponse:
      type: object
      properties:
        processKey:
          type: string
          description: Process key assigned to account ID.
          readOnly: false
          writeOnly: false
      title: EndTagResponse
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SendingSpeedLimit'
      title: RequestSchedulingSettings
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageInfo:
      type: object
      properties:
        to:
          type: string
          description: The destination address of the message.
          example: '385977666618'
        messageCount:
          type: integer
          format: int32
          description: Number of messages required to deliver.
          example: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.
          example: 06df139a-7eb5-4a6e-902e-40e892210455
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageStatus'
      title: SingleMessageInfo
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityResponse:
      type: object
      properties:
        results:
          type: array
          description: List of the quality information related to specific senders.
          items:
            $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQuality'
      required:
      - results
      title: WhatsAppSenderQualityResponse
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1TemplateStructureApiData:
      type: object
      description: Template structure.
      properties:
        header:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1HeaderApiData'
        body:
          type: string
          description: 'Template body. Can be registered as plain text or text with placeholders. Placeholders have to be correctly formatted and in the correct order, regardless of other sections. Example: {{1}}, {{2}}, {{3}}...'
          example: body {{1}} content
        footer:
          type: string
          description: Template footer. Plain text, up to 60 characters.
          example: footer
          maxLength: 60
          minLength: 0
        buttons:
          type: array
          description: Template buttons. Can be either up to 3 `quick reply` buttons or up to 2 `call to action` buttons. Call to action buttons must be unique in type.
          items:
            $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData'
          maxItems: 3
          minItems: 1
        type:
          type: string
          enum:
          - TEXT
          - MEDIA
          - UNSUPPORTED
          readOnly: true
      required:
      - body
      title: V1TemplateStructureApiData
    1a371cd8f3283b37bf4803906b01cdcf51f31ded659ebcfe44c8dbb3c4785a4e.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusActionContent:
      type: object
      description: Allows you to specify order status.
      properties:
        payment:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus'
        status:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus'
        description:
          type: string
          description: Description of the order status.
          maxLength: 120
          minLength: 0
      required:
      - payment
      - status
      title: InteractiveOrderStatusActionContent
    73e6f414ccb2e1e41274c061b50cf5765f69b642a3e0cca54b0248eb3baf086d.RecordingResponse:
      type: object
      properties:
        application:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkRecordingApplication'
        recording:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Recording'
      required:
      - application
      - recording
      title: RecordingResponse
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ToDestination'
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent'
        options:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessageOptions'
        webhooks:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.AdvancedWebhooksWithSeen'
      required:
      - content
      - destinations
      - sender
      title: ViberMessage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CustomRingback:
      type: object
      description: Custom ringback tones configuration. Allows specifying different audio files to play during ringing and when the call fails.
      properties:
        ringingAudio:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent'
        failedAudio:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent'
      required:
      - ringingAudio
      title: CustomRingback
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersRequest:
      type: object
      properties:
        data:
          type: array
          description: 'Array of SHA-256 hashed phone numbers. Phone values must be normalized before hashing: remove symbols, letters, and any leading zeroes, keeping only the country code and digits (e.g. "(+84) 091-2345678" becomes "84912345678" before hashing). Each hashed value must be a 64-character lowercase hexadecimal string.'
          example:
          - d6736136ea896c1bfdc553e0e86e702c70d060d805696ca3e4e9e0961353860a
          items:
            type: string
            description: 'Array of SHA-256 hashed phone numbers. Phone values must be normalized before hashing: remove symbols, letters, and any leading zeroes, keeping only the country code and digits (e.g. "(+84) 091-2345678" becomes "84912345678" before hashing). Each hashed value must be a 64-character lowercase hexadecimal string.'
            example: '["d6736136ea896c1bfdc553e0e86e702c70d060d805696ca3e4e9e0961353860a"]'
          maxItems: 10000
          minItems: 1
      required:
      - data
      title: AudienceUsersRequest
    4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.IosPushNotificationConfig:
      type: object
      description: Optional. Required if android is not set. Configuration used to enable iOS push notifications.
      properties:
        apnsCertificateFileName:
          type: string
          description: Name of the APNS certificate file used to enable iOS push notifications.
        apnsCertificateFileContent:
          type: string
          description: Base64 encoded content of the P12 APNS certificate file used to enable iOS push notifications.
        apnsCertificatePassword:
          type: string
          description: Password used for decryption of the APNS certificate.
      required:
      - apnsCertificateFileContent
      - apnsCertificateFileName
      title: IosPushNotificationConfig
    270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Price:
      type: object
      description: Message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
          example: 0.02
        currency:
          type: string
          description: The currency in which the price is expressed.
          example: EUR
      title: Price
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveButtonsMessage
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessage'
        options:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessageRequestOptions'
      required:
      - messages
      title: FacebookRequest
    2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkResponse:
      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.
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled SMS (see [Scheduled SMS endpoints](#channels/sms/get-scheduled-sms-messages) for more details). 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.'
      title: BulkResponse
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDlt:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
      required:
      - principalEntityId
      title: IndiaDlt
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlContent:
      type: object
      description: Array of urls information.
      properties:
        url:
          type: string
          description: Contact's url.
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlType'
      title: UrlContent
    ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FileResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique id of the file.
          example: 5f4e8861-8ed7-4521-b8c8-f26346726716
        name:
          type: string
          description: Name of the file.
          example: 5f4e8861-8ed7-4521-b8c8-f26346726716_alice_1680266280000.png
        fileFormat:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.FileFormat'
        size:
          type: integer
          format: int64
          description: Size in bytes of the file.
          example: 10780
        creationTime:
          type: string
          format: date-time
          description: 'Creation time of the file in UTC timezone. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
      title: FileResponse
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.EditTemplateResponse:
      type: object
      description: Response from Zalo API after editing a ZBS template.
      properties:
        templateId:
          type: string
          description: Unique identifier for the edited template.
        templateName:
          type: string
          description: Name of the template.
        templateType:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateType'
        status:
          type: string
          description: Current status of the template.
        tag:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateTag'
        appId:
          type: string
          description: Application ID associated with the template.
        oaId:
          type: string
          description: Official Account ID that owns the template.
        timeout:
          type: integer
          format: int64
          description: Template timeout.
        previewUrl:
          type: string
          description: URL to preview the template in Zalo's interface.
      required:
      - templateType
      title: EditTemplateResponse
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParam:
      type: object
      description: Variable parameter definition for template placeholders.
      properties:
        type:
          $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParamType'
        name:
          type: string
          description: Name or identifier of the parameter, used to reference it in the template. Must have the same name as the placeholder in the template content.
          example: orderId
          maxLength: 50
          minLength: 0
        example:
          type: string
          description: Example value for the parameter, used for template preview and validation.
          example: ORD-12345
          maxLength: 25
          minLength: 0
      required:
      - example
      - name
      - type
      title: TemplateParam
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.UpdateRcsTestNumberPrimaryApiRequest:
      type: object
      properties:
        primary:
          type: boolean
          default: false
          description: Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association.
      required:
      - primary
      title: UpdateRcsTestNumberPrimaryApiRequest
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - SHARE_POST
      title: TikTokOutboundContentType
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateWebhookResponse:
      type: object
      description: Webhook response containing RCS sender update events
      properties:
        results:
          type: array
          description: Collection of RCS sender update events
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateEvent'
      required:
      - results
      title: RcsSenderUpdateWebhookResponse
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogResponseLogFacebookOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.LogFacebookOutboundContent'
        cursor:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.CursorPageInfo'
      title: LogResponseLogFacebookOutboundContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Status:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        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.
        action:
          type: string
          description: Action that should be taken to eliminate the error.
      title: Status
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogPushOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessagePrice'
        status:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageStatus'
        error:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageError'
        platform:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Platform'
        content:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogPushOutboundContent
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DnsRecordResponse:
      type: object
      description: Records for the domain.
      properties:
        recordType:
          type: string
          description: Type of the record.
        name:
          type: string
          description: Name of the record.
        expectedValue:
          type: string
          description: Expected value to be set for the given record.
        verified:
          type: boolean
          description: Boolean value representing if the record is verified or not.
      title: DnsRecordResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppEventOptions:
      type: object
      description: Event options.
      properties:
        platform:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Platform'
        validityPeriod:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriod'
      title: WhatsAppEventOptions
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlPlayContent:
      type: object
      description: Plays an audio file fetched from a remote URL.
      properties:
        type:
          type: string
          description: Content type discriminator.
          enum:
          - URL
        fileUrl:
          type: string
          description: URL of the remote audio file to play.
        cacheDuration:
          type: integer
          format: int32
          description: How long, in seconds, the fetched file may be cached (1 to 86400).
          maximum: 86400
      required:
      - fileUrl
      - type
      title: UrlPlayContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
      writeOnly: true
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReport:
      type: object
      properties:
        bulkId:
          type: string
          description: Bulk ID.
        messageId:
          type: string
          description: Message ID.
        to:
          type: string
          description: Destination address.
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
        sentAt:
          type: string
          format: date-time
          description: 'Indicates whether the MMS was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Indicates whether the MMS was finished processing by Infobip (i.e., delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        mmsCount:
          type: integer
          format: int32
          description: The number of parts the sent MMS was split into.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through `callbackData` field in fully featured MMS message.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price'
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status'
        error:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Error'
        entityId:
          type: string
          description: Entity used in MMS request.
        applicationId:
          type: string
          description: Application used in MMS request.
      title: MmsReport
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogResponseLogRcsOutboundMessageContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.LogRcsOutboundMessageContent'
        cursor:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CursorPageInfo'
      title: LogResponseLogRcsOutboundMessageContent
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolResponse:
      type: object
      properties:
        id:
          type: string
          description: IP pool identifier.
        name:
          type: string
          description: IP pool name.
      required:
      - id
      - name
      title: IpPoolResponse
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TemplateRcsApiMtContent:
      type: object
      description: Rcs message contents.
      properties:
        templateName:
          type: string
          description: Unique template code as visible in the Vi RBM Portal
        templateData:
          type: object
          additionalProperties:
            type: string
            example: '{"name":"John Smith","city":"New York"}'
          description: Name-Value pairs of parameters included in the template, as defined in the Vi RBM Portal
          example:
            name: John Smith
            city: New York
      required:
      - templateName
      title: TemplateRcsApiMtContent
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowPreview:
      type: object
      properties:
        previewUrl:
          type: string
          description: Link for the preview page.
          example: https://example.com/
        expiresAt:
          type: string
          format: date-time
          description: 'Time when the link will expire and the developer needs to call the API again to get a new link. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          example: '2023-05-21T11:18:09Z'
      required:
      - expiresAt
      - previewUrl
      title: FlowPreview
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BlocklistConfigurationLevel:
      type: string
      description: 'Defines the level at which Infobip stores unsubscribe preferences.


        Note: When you change the unsubscribe configuration from a more global level (such as FROM_DOMAIN) to a more specific level (such as FROM_SENDER), remember that anyone who previously unsubscribed at the domain level chose to stop receiving all messages from your domain. These existing unsubscribe records will not automatically update to reflect the new sender-level setting. As a result, individuals who unsubscribed from your domain will continue to not receive messages, even after the change. To prevent confusion and respect user preferences, carefully manage and, if necessary, update these records when altering unsubscribe settings.'
      enum:
      - FROM_SENDER
      - FROM_DOMAIN
      example: FROM_SENDER
      title: BlocklistConfigurationLevel
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SouthKoreaOptions'
      title: RegionalOptions
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestMulti:
      type: object
      properties:
        messages:
          type: array
          description: List of push requests
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequest'
      required:
      - messages
      title: PushRequestMulti
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse:
      type: object
      description: List of found flows.
      properties:
        id:
          type: string
          description: ID of the flow.
          example: '123456'
        name:
          type: string
          description: Name of the flow.
          example: My first flow
        businessAccountId:
          type: integer
          format: int64
          description: WhatsApp business account ID.
          example: 987654
        categories:
          type: array
          description: Categories of the flow.
          example: SIGN_UP
          items:
            $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory'
        status:
          type: string
          description: Status of the flow.
          enum:
          - DRAFT
          - PUBLISHED
          - DEPRECATED
          - BLOCKED
          - THROTTLED
          example: DRAFT
        initialScreens:
          type: array
          description: IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.
          items:
            type: string
            description: IDs of the initial screens required to send a flow with flowAction set to 'NAVIGATE'. Only exists for flows after publishing.
          uniqueItems: true
      required:
      - businessAccountId
      - categories
      - id
      - name
      - status
      title: FlowDataResponse
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.SendingSpeedLimit'
      title: RequestSchedulingSettings
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiDetailedStatusResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus'
        name:
          type: string
          description: The unique name of the template.
        coverage:
          type: array
          description: Coverage information by country showing template status for each provider.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiCountryCoverage'
      required:
      - coverage
      - name
      - status
      title: RcsTemplateApiDetailedStatusResponse
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplate:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the email template.
          example: 1000000000000000001
        name:
          type: string
          description: Name of the email template.
          example: Welcome email
        from:
          type: string
          description: Email address with optional sender name.
          example: John Doe <john.doe@example.com
        replyTo:
          type: string
          description: Email address to which recipients of the email can reply.
          example: support@example.com
        subject:
          type: string
          description: Subject of the email template.
          example: Welcome to Infobip
        preheader:
          type: string
          description: Preheader of the email template.
          example: Welcome to Infobip
        html:
          type: string
          description: HTML content of the email template.
          example: <html><head></head><body><h2>Welcome to Infobip</h2></body></html>
        isHtmlEditable:
          type: boolean
          description: Flag indicating if the HTML content is editable.
          example: true
        attachments:
          type: array
          description: List of attachments.
          example:
          - id: 7BE07D39-C7DA-4ED4-9F45-33BDB8643AA1
            contentType: application/pdf
            filename: attachment.pdf
            size: 1024
            url: /email/1/templates/1000000000000000001/attachments/7BE07D39-C7DA-4ED4-9F45-33BDB8643AA1/download
          items:
            $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'
        landingPageId:
          type: string
          description: Unique identifier of the landing page.
          example: '1_2345'
        imagePreviewUrl:
          type: string
          description: URL of the image preview.
          example: /email/1/templates/1000000000000000001/preview.png
        createdAt:
          type: string
          format: date-time
          description: 'Date and time when the email template was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        updatedAt:
          type: string
          format: date-time
          description: 'Date and time when the email template was last updated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      required:
      - html
      - id
      - isHtmlEditable
      title: EmailTemplate
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.WhatsAppData:
      type: object
      description: WhatsApp-specific data used if the message is sent through a WhatsApp channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        templateNamespace:
          type: string
          description: Template namespace
          writeOnly: true
        templateName:
          type: string
          description: Template name
          writeOnly: true
        templateData:
          type: array
          description: Template parameters values ordered as registered in template
          items:
            type: string
            description: Template parameters values ordered as registered in template
            writeOnly: true
          writeOnly: true
        mediaTemplateData:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateData'
        language:
          type: string
          description: The code of the language or locale to use. Needs to be exactly the code with which the template was registered.
          writeOnly: true
        fileUrl:
          type: string
          description: URL of the file sent in the WhatsApp message. Max 2048 characters. Supported file types are PDF, DOC(X), PPT(X), XLS(X). Maximum file size is 100MB.
          maxLength: 2048
          minLength: 0
          writeOnly: true
        imageUrl:
          type: string
          description: 'URL of the image sent in the WhatsApp message. Max 2048 characters. Supported image types: JPG, JPEG, PNG. Maximum image size is 5MB.'
          maxLength: 2048
          minLength: 0
          writeOnly: true
        audioUrl:
          type: string
          description: URL of the audio file sent in the WhatsApp message. Max 2048 characters. Supported audio types are AAC, AMR, MP3, OPUS. Maximum audio size is 16MB.
          maxLength: 2048
          minLength: 0
          writeOnly: true
        videoUrl:
          type: string
          description: URL of the video sent in the WhatsApp message. Max 2048 characters. Supported video types are MP4, 3GPP. Maximum video size is 16MB.
          maxLength: 2048
          minLength: 0
          writeOnly: true
        locationName:
          type: string
          description: 'Name of the location. Optional value. '
          maxLength: 1000
          minLength: 0
          writeOnly: true
        address:
          type: string
          description: Address location. Optional value.
          maxLength: 1000
          minLength: 0
          writeOnly: true
        longitude:
          type: number
          format: double
          description: Longitude of a coordinate. The value must be between -180 and 180
          maximum: 180
          minimum: -180
          writeOnly: true
        latitude:
          type: number
          format: double
          description: Latitude of a coordinate. The value must be between -90 and 90.
          maximum: 90
          minimum: -90
          writeOnly: true
        previewUrl:
          type: boolean
          description: '`Options`: false (default), true <br/>Specifying previewUrl in the request is optional when not including a URL in your message. <br/>To include a URL preview, set previewUrl to true in the message body and make sure that URL begins with http:// or https:/'
          writeOnly: true
        contacts:
          type: array
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Contact'
      required:
      - mediaTemplateData
      - text
      title: WhatsAppData
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MessageDetection:
      type: object
      description: Message detection configuration
      properties:
        timeout:
          type: integer
          format: int32
          description: Timeout in seconds
          maximum: 60
          minimum: 1
      title: MessageDetection
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallRecording:
      type: object
      description: List of call recordings.
      properties:
        callId:
          type: string
          description: Call identifier.
          maxLength: 128
        endpoint:
          type: string
          description: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
        direction:
          type: string
          description: Call direction.
          enum:
          - INBOUND
          - OUTBOUND
        status:
          type: string
          description: Status of call recording.
          enum:
          - SUCCESSFUL
          - PARTIALLY_FAILED
          - FAILED
        reason:
          type: string
          description: Reason for recording failure. Empty if call did not fail.
        files:
          type: array
          description: Recording files.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingFile'
      title: CallRecording
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ToDestination'
        content:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundMessageContent'
        options:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageOptions'
        webhooks:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedWebhooksWithSeen'
      required:
      - content
      - destinations
      - sender
      title: TikTokMessage
    6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingFile:
      type: object
      description: Recorded file.
      properties:
        id:
          type: string
          description: File ID.
        name:
          type: string
          description: File name.
        fileFormat:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.FileFormat'
        size:
          type: integer
          format: int64
          description: File size in bytes.
        startTime:
          type: string
          format: date-time
          description: Date and time when the recording started.
          example: '2024-05-01T14:25:22.458Z'
        endTime:
          type: string
          format: date-time
          description: Date and time when the recording ended.
          example: '2024-05-01T14:30:22.458Z'
        creationTime:
          type: string
          format: date-time
          description: File creation time.
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
        location:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ProcessedLocation'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Client-defined data as key-value pairs, where both key and value are strings.
      title: RecordingFile
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.PhoneNumberRequest:
      type: object
      properties:
        countryCode:
          type: string
          description: Country code of the phone number.
          example: '44'
        phoneNumber:
          type: string
          description: Phone number to add.
          example: '7796344125'
        displayName:
          type: string
          description: Display name of the phone number.
          example: Infobip
        type:
          $ref: '#/components/schemas/30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.NumberType'
        locale:
          type: string
          default: en_US
          description: Locale which will be used to submit for verification.
          example: en_US
      required:
      - countryCode
      - displayName
      - locale
      - phoneNumber
      - type
      title: PhoneNumberRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReport'
      title: DeliveryReports
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: TextMessage
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogResponseLogPushOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.LogPushOutboundContent'
        cursor:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.CursorPageInfo'
      title: LogResponseLogPushOutboundContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderSenderLaunchStatus:
      type: object
      description: List of providers in the country and their launch status.
      properties:
        name:
          type: string
          description: Name of the provider.
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderLaunchStatus'
        rejectionReason:
          type: string
          description: Reason for rejection if the sender launch has been rejected by the provider.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the provider status was last updated.
      required:
      - name
      - status
      - updatedAt
      title: ProviderSenderLaunchStatus
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Numbers:
      type: object
      properties:
        number:
          type: string
          description: Must be a valid [E.164](https://en.wikipedia.org/wiki/E.164) number; the parameter can be constructed using variables
      required:
      - number
      title: Numbers
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendingSpeed:
      type: object
      description: Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic. Not setting a send speed limit can overwhelm your resources with incoming traffic. If this parameter is defined, _validityPeriod_ is ignored.
      properties:
        speed:
          type: integer
          format: int32
          description: Defines the number of messages that will be sent per specified time unit.
        timeUnit:
          type: string
          description: 'Defines time unit used for calculating sending speed.  Possible values: `second`, `minute`, `hour` and `day`.'
      title: SendingSpeed
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsReport:
      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.
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was [scheduled](#channels/sms/get-scheduled-sms-messages) to be sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        smsCount:
          type: integer
          format: int32
          description: The number of parts the message content was split into.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Price'
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Error'
        entityId:
          type: string
          description: The entity used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        applicationId:
          type: string
          description: The application used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        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.
      title: SmsReport
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint:
      type: object
      description: Endpoint involved in the call delivered to the Markup Language callback.
      discriminator:
        propertyName: type
        mapping:
          PHONE: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackPhoneEndpoint'
          SIP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackSipEndpoint'
          WEBRTC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebRtcEndpoint'
          VIBER: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackViberEndpoint'
          WHATSAPP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWhatsAppEndpoint'
          WEBSOCKET: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackWebsocketEndpoint'
      example:
        type: PHONE
        phoneNumber: '41793026834'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpointType'
      required:
      - type
      title: CallbackEndpoint
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsSenderApiRequest:
      type: object
      properties:
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform. It must be provided when submitting RCS traffic to Infobip platform. It must contain only alphanumeric characters, underscores and hyphens, and must contain at least one letter. It's not editable at any point of time after sender is created.
          maxLength: 40
          minLength: 3
          pattern: ^(?=.*[a-zA-Z])[a-zA-Z0-9_-]+$
        billingCategory:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory'
        useCase:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase'
        hostingRegion:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion'
        brand:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand'
        displayName:
          type: string
          description: The name of the sender displayed to the user on mobile device.
          maxLength: 40
          minLength: 1
        description:
          type: string
          description: The description of the sender displayed to the user on mobile device.
          maxLength: 100
          minLength: 1
        color:
          type: string
          description: Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.
          pattern: ^#?([A-Fa-f0-9]{6})$
        phones:
          type: array
          description: List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone'
        emails:
          type: array
          description: List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email'
        websites:
          type: array
          description: List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress'
        bannerUrl:
          type: string
          description: URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        logoUrl:
          type: string
          description: URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        privacy:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress'
        termsOfService:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress'
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - bannerUrl
      - billingCategory
      - brand
      - color
      - description
      - displayName
      - hostingRegion
      - logoUrl
      - privacy
      - senderName
      - termsOfService
      - useCase
      title: CreateRcsSenderApiRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Fetch:
      type: object
      description: Fetch action retrieves markup instructions from a URL at runtime.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - fetch
        url:
          type: string
          description: URL to fetch markup instructions from.
        method:
          type: string
          default: POST
          description: HTTP method for the fetch request (POST or GET).
      required:
      - action
      - url
      title: Fetch
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.TagIdentifierType:
      type: string
      description: Defines which identifier will be provided in the tags field. Possible values are ID and NAME. If not provided, default value of NAME is used.
      enum:
      - ID
      - NAME
      title: TagIdentifierType
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment:
      type: object
      properties:
        id:
          type: string
          description: Id of the attachment.
          example: 7BE07D39-C7DA-4ED4-9F45-33BDB8643AA1
        contentType:
          type: string
          description: Content type of the attachment.
          example: application/pdf
        fileName:
          type: string
          description: Name of the attachment.
          example: attachment.pdf
        size:
          type: integer
          format: int32
          description: Size of the attachment in bytes.
          example: 1024
          readOnly: true
        url:
          type: string
          description: URL of the attachment.
          example: /email/1/templates/1000000000000000001/attachments/7BE07D39-C7DA-4ED4-9F45-33BDB8643AA1/download
      required:
      - id
      title: Attachment
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReport'
      title: SeenReports
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResult:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. This ID is automatically generated and will be included in the API response.
        messageId:
          type: string
          description: A unique message ID. This ID is automatically generated and will be included in the API response.
        phoneNumber:
          type: string
          description: The recipient's phone number that was checked for RCS capability.
        code:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2'
      required:
      - bulkId
      - code
      - messageId
      - phoneNumber
      title: CapabilityCheckResult
      xml:
        name: CapabilityCheckResult
    17bf4973053f0fd3d8ac737d4e4f0aca51beba611d8f8dda63e2fbc35b478ef9.ScenariosResponse:
      type: object
      properties:
        scenarios:
          type: array
          description: Array of OMNI scenarios
          items:
            $ref: '#/components/schemas/9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario'
          readOnly: true
      title: ScenariosResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ResponseDetails:
      type: object
      description: List of message response details.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies a message response.
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SingleMessageStatus'
      required:
      - messageId
      - status
      - to
      title: ResponseDetails
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationResponse:
      type: object
      description: Validation response
      properties:
        to:
          type: string
          description: The validated email address.
        validMailbox:
          type: string
          description: Indicates whether email address is valid.
        validSyntax:
          type: boolean
          description: Indicates whether email address syntax is valid.
        catchAll:
          type: boolean
          description: Indicates catch all status of email address.
        didYouMean:
          type: string
          description: Suggests similar alternate address that may be valid.
        disposable:
          type: boolean
          description: 'Indicates whether email address is disposable.

            A disposable email address is a temporary address that is often used for short-term purposes and can be discarded after use.

            '
        roleBased:
          type: boolean
          description: 'Indicates whether email address is role-based.

            A role-based email address is one that is associated with a specific function or group within an organization,

            such as marketing@example.org, rather than an individual person.

            '
        reason:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationReason'
        risk:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiRisk'
        detailedReasons:
          type: string
          description: 'This field is provided when the validMailbox status is ''unknown'' or ''false'',

            offering specific explanations for why the email address has been assigned that status.

            '
      required:
      - catchAll
      - disposable
      - risk
      - roleBased
      - to
      - validMailbox
      - validSyntax
      title: ValidationResponse
    9ac20aaa973a4193ff0ca88a25f8778624dcef15967a470e5d05a9222eb15517.Scenario:
      type: object
      properties:
        key:
          type: integer
          format: int64
          description: Key used to uniquely identify OMNI scenario.
          readOnly: true
        name:
          type: string
          description: OMNI scenario name.
        flow:
          type: array
          description: Sender used in OMNI scenario’s step for sending message.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step'
        default:
          type: boolean
          description: Indicates if created scenario should be set as a default.
      title: Scenario
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogError:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
          readOnly: true
        groupName:
          type: string
          description: Error group name.
          readOnly: true
        id:
          type: integer
          format: int32
          description: Error ID.
          readOnly: true
        name:
          type: string
          description: Error name.
          readOnly: true
        description:
          type: string
          description: Human-readable description of the error..
          readOnly: true
        permanent:
          type: boolean
          description: Tells if the error is permanent.
          readOnly: true
      title: LogError
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Referral:
      type: object
      description: Information about the referral which is either a Facebook ad or a post that triggered the message.
      properties:
        sourceType:
          type: string
          description: Indicates the source of the referral. Takes the value of `UNKNOWN` if there's no value or the value is different from `AD` or `POST`.
          enum:
          - AD
          - POST
          - UNKNOWN
          readOnly: false
          writeOnly: true
        sourceId:
          type: string
          description: Facebook ID of an ad or a post.
          readOnly: false
          writeOnly: true
        sourceUrl:
          type: string
          description: The URL that leads to a Facebook ad or a post.
          readOnly: false
          writeOnly: true
        headline:
          type: string
          description: Headline used in the ad that generated the message.
          readOnly: false
          writeOnly: true
        body:
          type: string
          description: Body from the ad that generated the message.
          readOnly: false
          writeOnly: true
        ctwaClickId:
          type: string
          description: Unique per click identifier exposed when the end user entering the conversation originated from a Click to WhatsApp (CTWA) ad.
          readOnly: false
          writeOnly: true
        referralMedia:
          $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMedia'
      title: Referral
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsResponse:
      type: object
      properties:
        apiId:
          type: string
          description: The first part of the generate Authorization header.
        key:
          type: string
          description: Used to generate the second part of the Authorization header.
      title: CredentialsResponse
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ToDestination'
        content:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent'
        options:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoMessageOptions'
        webhooks:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedWebhooks'
      required:
      - content
      - destinations
      - sender
      title: KakaoChinguMessage
    8c0d480c425c41d88986e9a339e209ff8333292c731a8b410c00a517bc3a95fb.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenStatus:
      type: string
      description: Status of user token.
      enum:
      - REFRESHED
      - NOT_REFRESHED
      - UNKNOWN
      example: REFRESHED
      title: UserTokenStatus
    febb9d147c03fd2fbfd3c2210892c186364d60568040914121c07343344b284b.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step:
      type: object
      description: Sender used in OMNI scenario’s step for sending message.
      properties:
        from:
          type: string
          description: Sender used in OMNI scenario’s step for sending message.
        channel:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel'
      required:
      - channel
      title: Step
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveProductActionContent'
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      title: InteractiveProductContent
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudiencesResponse:
      type: object
      properties:
        audiences:
          type: array
          description: List of custom audiences.
          items:
            $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudienceResponse'
      title: GetAudiencesResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegmentType:
      type: string
      enum:
      - TEXT
      - LINK
      - SMIL
      - UPLOADED_REFERENCE
      title: MmsOutboundSegmentType
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback:
      type: object
      description: Clients callback where markup language is hosted.
      properties:
        url:
          type: string
          description: URL where markup language is hosted
        errorUrl:
          type: string
          description: URL where errors will be sent
        method:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod'
      required:
      - errorUrl
      - method
      - url
      title: Callback
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LanguageCode:
      type: string
      description: Code for language character set of a message text.
      enum:
      - NONE
      - TR
      - ES
      - PT
      - AUTODETECT
      title: LanguageCode
      writeOnly: true
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint:
      type: object
      description: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
      discriminator:
        propertyName: type
        mapping:
          PHONE: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PhoneEndpoint'
          SIP: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipEndpoint'
          WEBRTC: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebRtcEndpoint'
          VIBER: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ViberEndpoint'
          WHATSAPP: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WhatsAppEndpoint'
          WEBSOCKET: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpoint'
      example:
        phoneNumber: '41792030000'
        type: PHONE
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType'
      title: CallEndpoint
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PublicKeyResponse:
      type: object
      properties:
        publicKey:
          type: string
          description: Public key. The value is *Base64 encoded*!
          example: MIICIjANB***hidden***Mvb0CAwEAAQ==
      required:
      - publicKey
      title: PublicKeyResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DayOfWeek:
      type: string
      description: Days when scheduling call establishment will be attempted.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DayOfWeek
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidation:
      type: object
      description: Validation get response.
      properties:
        destination:
          type: string
          description: The validated email address.
        validMailbox:
          type: string
          description: Indicates whether email address is valid.
          example: true|false|unknown
          pattern: ^(true|false|unknown)$
        validSyntax:
          type: boolean
          description: Indicates whether email address syntax is valid.
        catchAll:
          type: boolean
          description: Indicates catch all status of email address.
        didYouMean:
          type: string
          description: Suggests similar alternate address that may be valid.
        disposable:
          type: boolean
          description: 'Indicates whether email address is disposable.

            A disposable email address is a temporary address that is often used for short-term purposes and can be discarded after use.

            '
        roleBased:
          type: boolean
          description: 'Indicates whether email address is role-based.

            A role-based email address is one that is associated with a specific function or group within an organization,

            such as marketing@example.org, rather than an individual person.

            '
        risk:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiRisk'
        reason:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationReason'
        detailedReasons:
          type: string
          description: 'This field is provided when the validMailbox status is ''unknown'' or ''false'',

            offering specific explanations for why the email address has been assigned that status.

            '
        bulkValidationDate:
          type: string
          format: date-time
          description: Date and time when email address was validated.
        validationRequestId:
          type: string
          description: 'Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.

            '
      required:
      - bulkValidationDate
      - catchAll
      - destination
      - disposable
      - risk
      - roleBased
      - validMailbox
      - validSyntax
      title: GetValidation
    d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEventResponse:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number.
        content:
          allOf:
          - $ref: '#/components/schemas/d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEvent'
          description: Content of the event.
        createdAt:
          type: string
          format: date-time
          description: 'Tells when the event occurred. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      title: whatsappSystemReportsSystemEventResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StopRecording:
      type: object
      description: StopRecording action stops an ongoing recording.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - stopRecording
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
      required:
      - action
      - callback
      title: StopRecording
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantSession:
      type: object
      description: List of participant sessions.
      properties:
        callId:
          type: string
          description: Unique call ID.
          maxLength: 128
        joinTime:
          type: string
          format: date-time
          description: Date and time for when the participant joined the conference.
        leaveTime:
          type: string
          format: date-time
          description: Date and time for when the participant left the conference.
      title: ParticipantSession
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkStatus:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID of the bulk request.
          example: 46ab0413-448f-4153-ada9-b68b14242dc3
        startTime:
          type: string
          format: date-time
          description: Bulk request handling start time.
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status'
      title: BulkStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaAttachment:
      type: object
      description: File attachments.
      discriminator:
        propertyName: type
        mapping:
          uploadedReference: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaUploadedReference'
          binary: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaBinaryAttachment'
      properties:
        type:
          type: string
      required:
      - type
      title: EmailMediaAttachment
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTextMessage:
      type: object
      description: An array of messages being sent.
      properties:
        from:
          type: string
          description: Registered Viber Sender name.
          maxLength: 20
          minLength: 2
        to:
          type: string
          description: 'Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).'
          pattern: ^[0-9]{1,15}$
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 50
          minLength: 1
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TextContent'
        callbackData:
          type: string
          description: Custom client's data that will be included in Delivery Report.
          maxLength: 4000
          minLength: 1
        trackingData:
          type: string
          description: Custom client's data that will be passed back with user's reply.
          maxLength: 100
          minLength: 1
        applySessionRate:
          type: boolean
          description: Defines if the message should be charged using Viber's session rate if applicable. The session rate is not supported for text messages with buttons.
        toPrimaryDeviceOnly:
          type: boolean
          description: Defines if the message should be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet).
        label:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label'
        smsFailover:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover'
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
      required:
      - content
      - from
      - to
      title: ViberTextMessage
    2f772c02a4c3391667bfa54680f8db54477fb2b9100309bf0d515e4ee848facc.SetupBody:
      type: object
      properties:
        name:
          type: string
          description: Unique configuration name. Alphanumeric, max length 100.
          pattern: '[a-zA-Z0-9 ]+'
        callbackUrl:
          type: string
          description: Client's URL that will be called on each inbound call to related Number masking Voice number in order to get instructions of how to handle incoming calls. Instructions are a result of mapping logic implemented on your side according to your business case.
        statusUrl:
          type: string
          description: Client's URL for status report delivery after the call is finished.
        backupCallbackUrl:
          type: string
          description: If callbackUrl is unavailable this one will be called instead.
        backupStatusUrl:
          type: string
          description: If statusUrl is unavailable this one will be called instead.
        description:
          type: string
          description: Masking configuration description.
          pattern: '[a-zA-Z0-9 ]*'
      required:
      - callbackUrl
      - name
      title: SetupBody
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.LogKakaoAlimOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice'
        status:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus'
        error:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageError'
        platform:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform'
        content:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogKakaoAlimOutboundContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent:
      type: object
      description: Footer of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      properties:
        text:
          type: string
          description: Content of the message footer.
          maxLength: 60
          minLength: 1
      required:
      - text
      title: InteractiveFooterContent
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    77db2635bc301813b34d9bf25b46b5eb0b93ccf4142ac82fa2d80980d0455beb.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolCreateApiRequest:
      type: object
      properties:
        name:
          type: string
          description: IP pool name.
          maxLength: 100
          minLength: 1
      required:
      - name
      title: IpPoolCreateApiRequest
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderLimit:
      type: string
      description: Current limit of the Business Portfolio.
      enum:
      - LIMIT_NA
      - LIMIT_250
      - LIMIT_2K
      - LIMIT_10K
      - LIMIT_100K
      - UNLIMITED
      example: LIMIT_10K
      title: WhatsAppSenderLimit
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Collect:
      type: object
      description: Collect action reads the DTMF input from the user’s phone and saves it into a variable. Saved variable can be used within the IVR in any other action that allows variable usage. (e.g. switch/case)
      properties:
        collectInto:
          type: string
          description: The name of the variable to set.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CollectOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - collectInto
      title: Collect
    9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadResponse:
      type: object
      properties:
        fileId:
          type: string
          description: Id of the uploaded audio file.
      title: UploadResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundMessageContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundTextContent'
          IMAGE: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundImageContent'
          SHARE_POST: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundSharePostContent'
      properties:
        type:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundContentType'
      required:
      - type
      title: TikTokOutboundMessageContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KoreaOptions:
      type: object
      description: Specific parameters required for sending SMS to phone numbers registered in Korea.
      properties:
        title:
          type: string
          description: Title of the message that will be sent.
          maxLength: 66
          minLength: 0
      title: KoreaOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCarouselContent:
      type: object
      description: Template carousel. Should be defined only when template contains carousel.
      properties:
        cards:
          type: array
          description: Carousel cards. Should be defined in the correct order. It can have between one and ten cards.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCardContent'
          maxItems: 10
          minItems: 1
      required:
      - cards
      title: TemplateCarouselContent
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Gender:
      type: string
      description: Voice gender in which text would be synthesized.
      enum:
      - FEMALE
      - MALE
      title: Gender
    fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.ApiReport:
      type: object
      description: List of API reports
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        messageId:
          type: string
          description: The ID of the individual message for which the report is requested.
        to:
          type: string
          description: The message destination address.
        sentAt:
          type: string
          format: date-time
          description: 'Indicates when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)
        messageCount:
          type: integer
          format: int32
          description: The number of sent message segments.
        price:
          $ref: '#/components/schemas/fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Price'
        status:
          $ref: '#/components/schemas/fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Status'
        error:
          $ref: '#/components/schemas/fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Error'
        channel:
          $ref: '#/components/schemas/999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.OMNIChannel'
        mccMnc:
          type: string
          description: Information about country and network of the mobile device
        callbackData:
          type: string
          description: Callback data sent through callbackData field in Send PUSH notifications or Send bulk PUSH notifications API methods.
      title: ApiReport
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedWebhooksWithSeen:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SeenStatusReporting'
      title: AdvancedWebhooksWithSeen
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Colors:
      type: object
      description: Colors settings. If not specified, the default colors will be used.
      properties:
        primary:
          type: string
          default: '148997'
          description: Primary color of a theme in the hexadecimal format.
        primaryText:
          type: string
          default: '242424'
          description: Primary color of a text in the hexadecimal format.
        background:
          type: string
          default: F9F9F9
          description: Background color in the hexadecimal format.
      title: Colors
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessage'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequestOptions'
      required:
      - messages
      title: RcsMessageRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.WebhookDLRPayload:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Result'
      title: WebhookDLRPayload
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SouthKoreaOptions'
      title: RegionalOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2:
      type: string
      description: 'The result of the RCS capability check for the specified phone number. Following codes are available:

        * `ENABLED`: The number can receive RCS messages from the specified sender.

        * `UNREACHABLE`: The number cannot receive RCS messages from the specified sender.

        * `REJECTED_NETWORK`: Message not sent, network not allowed.

        * `REJECTED_ROUTE_NOT_AVAILABLE`: Route not available for that sender.

        * `REQUEST_FAILED`: External problems during capability check

        * `PROCESSING_ERROR`: The results for the number couldn’t be processed. Please try again.

        * `INVALID_DESTINATION_ADDRESS`: Number provided in wrong format.

        * `UNKNOWN_CODE`: Unknown error. Contact with support.

        '
      enum:
      - ENABLED
      - UNREACHABLE
      - REJECTED_NETWORK
      - REJECTED_ROUTE_NOT_AVAILABLE
      - REQUEST_FAILED
      - PROCESSING_ERROR
      - INVALID_DESTINATION_ADDRESS
      - UNKNOWN_CODE
      title: CapabilityCheckResponseCodeV2
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateTag:
      type: string
      description: Template tag for classification.
      enum:
      - TRANSACTION
      - CUSTOMER_CARE
      - PROMOTION
      title: TemplateTag
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact:
      type: object
      properties:
        name:
          type: string
          description: Display name of the end user.
          readOnly: false
          writeOnly: true
        phoneNumber:
          type: string
          description: Sender's phone number. May be absent if the user has enabled the Meta username feature and you have not exchanged messages with them in the last 30 days.
          readOnly: false
          writeOnly: true
        userId:
          type: string
          description: Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business.
          readOnly: false
          writeOnly: true
        parentUserId:
          type: string
          description: Business-scoped user ID valid across all phone numbers in a linked business portfolio. Present only for managed businesses with portfolio linking enabled.
          readOnly: false
          writeOnly: true
        username:
          type: string
          description: Meta username of the end user. Present only if the user has a Meta username.
          readOnly: false
          writeOnly: true
      title: DlrContact
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - FILE
      - LIST
      - CAROUSEL
      - TEMPLATE
      title: ViberOutboundContentType
    42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReportsResponse:
      type: object
      properties:
        results:
          type: array
          description: Arrays of delivery reports, one object for every message.
          items:
            $ref: '#/components/schemas/42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReport'
          readOnly: false
          writeOnly: false
      title: VoiceReportsResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessagePrice'
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageStatus'
        error:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ApplicationType:
      type: string
      enum:
      - WEBRTC
      title: ApplicationType
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GroupDestination:
      type: object
      properties:
        group:
          type: array
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationSingle'
          maxItems: 200
          minItems: 1
      required:
      - group
      title: Group Destination
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice'
        status:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus'
        error:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase:
      type: object
      properties:
        from:
          type: string
          description: Number which sent the message.
          readOnly: false
          writeOnly: true
        to:
          type: string
          description: Sender provided during the activation process.
          readOnly: false
          writeOnly: true
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the message.
          readOnly: false
          writeOnly: true
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
          readOnly: false
          writeOnly: true
        pairedMessageId:
          type: string
          description: ''
          readOnly: false
          writeOnly: true
        callbackData:
          type: string
          description: ''
          readOnly: false
          writeOnly: true
        price:
          allOf:
          - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price'
          description: Message price.
          readOnly: false
          writeOnly: true
      title: MoReportBase
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingLocation:
      type: string
      enum:
      - SAO_PAULO
      - BOGOTA
      - FRANKFURT
      - JOHANNESBURG
      - JOHANNESBURG_1
      - NEW_YORK
      - PORTLAND
      - MOSCOW
      - SINGAPORE
      - ISTANBUL
      - KUALA_LUMPUR
      - JAKARTA
      - MUMBAI
      - HONG_KONG_1
      - HONG_KONG
      - RIYADH
      - CHENNAI
      title: RecordingLocation
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.InboundMessageViberInboundMessageContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContent'
        price:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageViberInboundMessageContent
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.DialogLogPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogLogResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: DialogLogPage
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AllDomainsResponse:
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Paging'
        results:
          type: array
          description: List of domains that belong to the account.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse'
      title: AllDomainsResponse
    fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Error:
      type: object
      description: Indicates whether the error occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error [group ID](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).
        groupName:
          type: string
          description: Error [group name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).
        id:
          type: integer
          format: int32
          description: Error [ID](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).
        name:
          type: string
          description: Error [name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).
        description:
          type: string
          description: Human-readable [description](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) of the error.
        permanent:
          type: boolean
          description: Tells if the error [is permanent](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).
      title: Error
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusInfo:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the message within the bulk.
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus'
      required:
      - bulkId
      - status
      title: BulkStatusInfo
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StartRecording:
      type: object
      description: StartRecording action starts recording the call.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - startRecording
        recordingStatusCallbackUrl:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        recordingStatusCallbackEvents:
          type: array
          description: Set of recording status events that trigger the recording status callback.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent'
          uniqueItems: true
        playBeep:
          type: boolean
          default: true
          description: Whether to play a beep when recording starts.
      required:
      - action
      title: StartRecording
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusWebhookResponse:
      type: object
      description: Webhook response containing RCS sender launch status update events
      properties:
        results:
          type: array
          description: Collection of RCS sender launch status update events
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent'
      required:
      - results
      title: RcsSenderLaunchStatusWebhookResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the message within the bulk.
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus'
      required:
      - bulkId
      - status
      title: BulkUpdateStatusResponse
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferRequest:
      type: object
      properties:
        destinationCallsConfigurationId:
          type: string
          description: ID of the calls configuration to which the call is to be transferred.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        timeout:
          type: integer
          format: int32
          default: 30
          description: Time to wait, in seconds, for the receiving application to accept the transfer.
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
        propagationOptions:
          $ref: '#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferPropagationOptions'
      required:
      - destinationCallsConfigurationId
      title: ApplicationTransferRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportSingle:
      type: object
      properties:
        bulkId:
          type: string
          description: Bulk ID.
        messageId:
          type: string
          description: Message ID.
        to:
          type: string
          description: Destination address.
        sentAt:
          type: string
          format: date-time
          description: 'Indicates whether the MMS was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Indicates whether the MMS was finished processing by Infobip (i.e., delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        smsCount:
          type: integer
          format: int32
          description: The number of parts the sent MMS was split into.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through `callbackData` field in fully featured MMS message.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price'
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status'
        error:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ErrorMmsReport'
        entityId:
          type: string
          description: Entity used in MMS request.
        applicationId:
          type: string
          description: Application used in MMS request.
      title: MmsReportSingle
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionStatus:
      type: string
      description: The current status of sender's calling permission.<br>`NO_PERMISSION` - The end user has not granted calling permission to the sender.<br>`TEMPORARY` - The end user has granted a temporary calling permission to the sender.<br>`PERMANENT` - The end user has granted permanent calling permission to the sender.
      enum:
      - NO_PERMISSION
      - TEMPORARY
      - PERMANENT
      example: NO_PERMISSION
      title: CallingPermissionStatus
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundTextContent'
          IMAGE: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundImageContent'
          CAROUSEL: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundCarouselContent'
          RICH_CARD: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundRichCardContent'
      properties:
        type:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContentType'
      title: InstagramDmOutboundContent
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform'
        validityPeriod:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DefaultSmsFailover'
      title: MsisdnMessageFailoverOptions
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.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
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressType:
      type: string
      description: Type of the address. Can be `HOME` or `WORK`.
      enum:
      - HOME
      - WORK
      title: AddressType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.LocationContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: LocationMessage
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsRequestEnvelope:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessage'
        options:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageRequestOptions'
      required:
      - messages
      title: SmsRequestEnvelope
    808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendRequest:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest'
      title: RcsBulkSendRequest
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
      title: CapabilityCheckOptions
      xml:
        name: CapabilityCheckOptions
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.ApplicationTransferPropagationOptions:
      type: object
      description: Options that should be propagated while transferring the call.
      properties:
        recordingTransferOptions:
          $ref: '#/components/schemas/be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.RecordingTransferOptions'
      title: ApplicationTransferPropagationOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameter:
      type: object
      description: Template parameters for dynamic content.
      properties:
        type:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameterType'
        name:
          type: string
          description: Name of the parameter. Only letters, digits, hyphen and underscore are allowed.
          maxLength: 20
          minLength: 1
          pattern: ^[A-Za-z0-9_-]+$
        sampleValue:
          type: string
          description: Sample data for the parameter.
          maxLength: 200
          minLength: 1
      required:
      - name
      - sampleValue
      - type
      title: TemplateParameter
    3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Error:
      type: object
      properties:
        description:
          type: string
          description: Human-readable description of the error.
          readOnly: false
          writeOnly: true
        permanent:
          type: boolean
          description: Indicates whether the error is permanent.
          readOnly: false
          writeOnly: true
        name:
          type: string
          description: Error name.
          readOnly: false
          writeOnly: true
        id:
          type: integer
          format: int32
          description: Error ID.
          readOnly: false
          writeOnly: true
        groupName:
          type: string
          description: Error group name.
          readOnly: false
          writeOnly: true
        groupId:
          type: integer
          format: int32
          description: Error group ID.
          readOnly: false
          writeOnly: true
      title: Error
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessage'
        options:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DefaultMessageRequestOptions'
      required:
      - messages
      title: MmsUnificationRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsActionContent:
      type: object
      description: Allows you to specify order details.
      properties:
        payment:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails'
        paymentConfiguration:
          type: string
          description: Name of the WhatsApp payment configuration to be used for this order. Can be omitted for Brazil PIX, UPI Link and must be omitted for Brazil link, Brazil Boleto, Brazil Payments and UPI Intent payment.
          maxLength: 60
          minLength: 1
        orderCurrency:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency'
        orderType:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType'
        totalAmount:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount'
        order:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder'
      required:
      - order
      - orderCurrency
      - orderType
      - payment
      - totalAmount
      title: InteractiveOrderDetailsActionContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvents:
      type: object
      properties:
        results:
          type: array
          description: Collection of conversation started events.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvent'
        eventCount:
          type: integer
          format: int32
          description: The number of events returned in the results array.
        pendingEventCount:
          type: integer
          format: int32
          description: The number of events that have not been pulled in.
      required:
      - eventCount
      - pendingEventCount
      - results
      title: RcsConversationStartedEvents
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryReport'
      title: DeliveryReports
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountResponse:
      type: object
      description: List of ad accounts.
      properties:
        id:
          type: string
          description: Ad account ID.
          example: act_3339405976215927
        status:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountStatus'
        currency:
          type: string
          description: Currency used by the ad account.
          example: USD
        totalSpent:
          type: integer
          format: int64
          description: Total amount spent.
          example: 186
      title: AdAccountResponse
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.ModifiedTemplateResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TemplateResult'
      title: ModifiedTemplateResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.FilePlayContent:
      type: object
      description: Plays an audio file previously uploaded to Infobip storage.
      properties:
        type:
          type: string
          description: Content type discriminator.
          enum:
          - FILE
        fileId:
          type: string
          description: Identifier of the audio file stored in Infobip storage.
      required:
      - fileId
      - type
      title: FilePlayContent
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice'
        status:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageStatus'
        error:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus:
      type: string
      description: 'The status of a specified RCS template. Possible values:

        * `PENDING`: Status indicating that the template has still not been approved by any provider and that there is at least one more provider reviewing the template.

        * `APPROVED`: Status indicating that the template has been approved by all required providers.

        * `REJECTED`: Status indicating that the template has been rejected by all required providers.

        * `SUSPENDED`: Status indicating that the template has been suspended by all required providers.

        * `APPROVED_IN_PROGRESS`: Status indicating that the template has been approved by at least one provider and that there is at least one more provider reviewing the template.

        * `APPROVED_PARTIALLY`: Status indicating that the template has been approved by at least one provider and that there is no more providers reviewing the template.


        Please note that the template must be approved by the provider before it can be used for messaging. For detailed status per provider please check [Get RCS template status](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-get-status) endpoint.'
      enum:
      - PENDING
      - APPROVED
      - REJECTED
      - SUSPENDED
      - APPROVED_IN_PROGRESS
      - APPROVED_PARTIALLY
      title: RcsTemplateApiStatus
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateBodyContent:
      type: object
      description: Media template body
      properties:
        placeholders:
          type: array
          description: Media template body placeholders. The value must not be null, but can be an empty array. Values within the array must not be null or empty.
          items:
            type: string
            description: Media template body placeholders. The value must not be null, but can be an empty array. Values within the array must not be null or empty.
            writeOnly: true
          writeOnly: true
      required:
      - placeholders
      title: MediaTemplateBodyContent
      writeOnly: true
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Pause:
      type: object
      description: Pause action pauses execution of the IVR scenario for the provided duration.
      properties:
        pause:
          type: number
          format: double
          description: the amount to wait in seconds, from 0 (exclusive) to 5 (inclusive)
          exclusiveMinimum: 0
          maximum: 5
          minimum: 0
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - pause
      title: Pause
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultEventRequestOptions:
      type: object
      description: Options applicable to all events in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings'
      title: DefaultEventRequestOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderItem:
      type: object
      description: An array of items in the order.
      properties:
        retailerId:
          type: string
          description: Product-unique identifier, as defined in catalog.
        name:
          type: string
          description: Name of the item.
          maxLength: 60
          minLength: 1
        amount:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount'
        saleAmount:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount'
        quantity:
          type: integer
          format: int32
          description: The number of items.
        originCountry:
          type: string
          description: Country of origin. Required when catalogId is not provided. It's supported only for UPI PayU payments.
        importerName:
          type: string
          description: Importer name. Required when catalogId is not provided. It's supported only for UPI PayU payments.
        importerAddress:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImporterAddress'
      required:
      - amount
      - name
      - quantity
      - retailerId
      title: InteractiveOrderDetailsOrderItem
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditRcsSenderApiRequest:
      type: object
      properties:
        billingCategory:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory'
        useCase:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase'
        displayName:
          type: string
          description: The name of the sender displayed to the user on mobile device.
          maxLength: 40
          minLength: 1
        description:
          type: string
          description: The description of the sender displayed to the user on mobile device.
          maxLength: 100
          minLength: 1
        color:
          type: string
          description: Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.
          pattern: ^#?([A-Fa-f0-9]{6})$
        phones:
          type: array
          description: List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone'
        emails:
          type: array
          description: List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email'
        websites:
          type: array
          description: List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress'
        bannerUrl:
          type: string
          description: URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        logoUrl:
          type: string
          description: URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        privacy:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress'
        termsOfService:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress'
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - bannerUrl
      - billingCategory
      - color
      - description
      - displayName
      - logoUrl
      - privacy
      - termsOfService
      - useCase
      title: EditRcsSenderApiRequest
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ToDestination'
        content:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent'
        options:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.AdvancedWebhooksWithSeen'
        quickReplies:
          type: array
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply'
      required:
      - content
      - destinations
      - sender
      title: FacebookMessage
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailToDestination:
      type: object
      description: List of BCC recipient email addresses.
      properties:
        destination:
          type: string
          description: Email address of the recipient in a form of `john.smith@somecompany.com`
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to a recipient.
          maxLength: 200
          minLength: 0
        placeholders:
          type: string
          description: 'As optional feature, a specific placeholder can be defined whose value will apply only for this destination. Value should be defined as: `{"name": "John"}`.'
      required:
      - destination
      title: EmailToDestination
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MultiChannel:
      type: object
      description: Multi-channel configuration. If enabled, audio of each participant will be in a separate channel in the composed file. Otherwise, audio of all participants will be mixed into a single channel in the composed file.
      properties:
        enabled:
          type: boolean
      required:
      - enabled
      title: MultiChannel
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CollectOptions:
      type: object
      properties:
        maxInputLength:
          type: integer
          format: int32
          description: Maximum acceptable number of digits. Stops reading after maxdigits have been entered (without requiring the user to press '#' key).
          maximum: 64
          minimum: 1
        timeout:
          type: integer
          format: int32
          description: Timeout in seconds for user to press both first DTMF and all other inter-digit DTMFs. Default value is 5. Max value is 30. The parameter can be constructed using variables.
          maximum: 30
        sendToReports:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports'
        mappedValues:
          type: object
          additionalProperties:
            type: string
            description: 'Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter "English" menu, you can define {"1":"English"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Mapped values can contain only numbers and multiple asterisk (*) symbols.'
          description: 'Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter "English" menu, you can define {"1":"English"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your collect action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Mapped values can contain only numbers and multiple asterisk (*) symbols.'
      title: CollectOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEvent:
      type: object
      description: An array of event objects of the events to be sent.
      properties:
        content:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContent'
        options:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventOptions'
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where the event is being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ToDestination'
      required:
      - destinations
      - sender
      title: AppleMfbEvent
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfig:
      type: object
      description: Security settings object holding the authentication settings necessary to access your webhook.
      discriminator:
        propertyName: type
        mapping:
          BASIC: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.BasicSecurityConfig'
          HMAC: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.HmacSecurityConfig'
      properties:
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfigType'
      title: SecurityConfig
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberFileMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered Viber Sender name.
          maxLength: 20
          minLength: 2
        to:
          type: string
          description: 'Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).'
          pattern: ^[0-9]{1,15}$
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 50
          minLength: 1
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.FileContent'
        callbackData:
          type: string
          description: Custom client's data that will be included in Delivery Report.
          maxLength: 4000
          minLength: 1
        trackingData:
          type: string
          description: Custom client's data that will be passed back with user's reply.
          maxLength: 100
          minLength: 1
        applySessionRate:
          type: boolean
          description: Defines if the message should be charged using Viber's session rate if applicable.
        label:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label'
        smsFailover:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover'
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
      required:
      - content
      - from
      - to
      title: ViberFileMessage
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SouthKoreaOptions'
      title: RegionalOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory:
      type: string
      description: Business category of the template, used for classification and approval routing.
      enum:
      - OTP
      - TRANSACTIONAL
      example: TRANSACTIONAL
      title: TemplateCategory
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory:
      type: string
      description: Categories of the flow.
      enum:
      - SIGN_UP
      - SIGN_IN
      - APPOINTMENT_BOOKING
      - LEAD_GENERATION
      - CONTACT_US
      - CUSTOMER_SUPPORT
      - SURVEY
      - OTHER
      - SHOPPING
      - UNKNOWN
      example: SIGN_UP
      title: FlowCategory
    b28487c847ed2327e816f04e75efdaf507ffcf1d938d91963e2ce7298453183f.BulkStatusResponse:
      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.
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus'
      title: BulkStatusResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiAddSuppressionType:
      type: string
      description: Type of suppression.
      enum:
      - BOUNCE
      - COMPLAINT
      title: ApiAddSuppressionType
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    977e3573b6848c404863a30ecae06e08186a75a9070af48acc4b4f99a371a9b7.ClickToCallApiRequest:
      type: object
      description: Click-to-call request object.
      properties:
        bulkId:
          type: string
          description: The ID which uniquely identifies the request.
        messages:
          type: array
          description: Array of click to call messages to be sent.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ClickToCallApiMessage'
      required:
      - messages
      title: ClickToCallApiRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResult:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultTo'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultCc'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultBcc'
      description: Array of sent message objects, one object per every message.
      properties:
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status'
      title: MessageResult
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.StandardVoiceResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        messages:
          type: array
          description: Array of sent messages, one object per every message.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceResponseDetails'
      title: StandardVoiceResponse
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatusContent:
      type: object
      description: Array of order statuses information.
      discriminator:
        propertyName: type
        mapping:
          ORDER_STATUS: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusActionContent'
      properties:
        type:
          type: string
      required:
      - type
      title: OrderStatusContent
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundContent:
      type: object
      description: Content of the message.
      discriminator:
        propertyName: type
        mapping:
          TYPING_INDICATOR: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTypingIndicatorContent'
          RICH_LINK: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundRichLinkContent'
          VIDEO: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundVideoContent'
          FORM: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundFormContent'
          TEXT: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTextContent'
          PAY_REQUEST: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundPayRequestContent'
          AUTHENTICATION_REQUEST: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAuthRequestContent'
          LIST_PICKER: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundListPickerContent'
          INVITATION: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundInvitationContent'
          APP_CLIP: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAppClipContent'
          IMAGE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundImageContent'
          DOCUMENT: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundDocumentContent'
          MEDIA: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMediaContent'
          TIME_PICKER: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTimePickerContent'
          QUICK_REPLY: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundQuickReplyContent'
      properties:
        type:
          type: string
          enum:
          - LOCATION
          - VIDEO
          - TEXT
          - AUDIO
          - LIST_PICKER
          - APPLE_TEXT_WITH_QUICK_REPLY_CONTENT
          - APPLE_FORM_CONTENT
          - IMAGE
          - APPLE_TIME_PICKER_CONTENT
          - DOCUMENT
          - MEDIA
          - TIME_PICKER
          - APPLE_LIST_PICKER_CONTENT
          - TYPING_INDICATOR
          - APPLE_AUTH_REQUEST_CONTENT
          - APPLE_PAY_REQUEST_CONTENT
          - RICH_LINK
          - FORM
          - APPLE_TYPING_INDICATOR_CONTENT
          - APPLE_QUICK_REPLY_CONTENT
          - PAY_REQUEST
          - AUTHENTICATION_REQUEST
          - TEXT_WITH_QUICK_REPLY
          - BUSINESS_UPDATE
          - INVITATION
          - APP_CLIP
          - MULTIPART
          - APPLE_RICH_LINK_CONTENT
          - APPLE_CUSTOM_INTERACTIVE_CONTENT
          - QUICK_REPLY
      title: AppleMfbOutboundContent
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.InAppStyle:
      type: string
      description: Set to `MODAL` to use in app dialog for actionable message, or `BANNER` to show a standard banner view. `MODAL` is supported on iOS from 3.6.0, on Android from 1.13.0 and on Cordova from 0.7.0. `BANNER` is supported from iOS 5.0.0, Android 2.0.0 and Cordova 1.0.0
      enum:
      - BANNER
      - MODAL
      title: InAppStyle
      writeOnly: true
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsActionContent:
      type: object
      description: Allows you to specify buttons sent in the message.
      properties:
        buttons:
          type: array
          description: An array of buttons sent in a message. It can have up to three buttons.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent'
          maxItems: 3
          minItems: 1
      required:
      - buttons
      title: InteractiveButtonsActionContent
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordCallbackRequest:
      type: object
      description: Markup Language record callback request object. Sent to the callback URL configured on the Record instruction when a recording is started, stopped, or fully processed. Extends the instructions callback payload with the recorded file identifier and the current recording status.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        recordingFileId:
          type: string
          description: Identifier of the recorded audio file.
          example: b83f049e-6b2a-4111-bbeb-32426fe0a737
        recordingStatus:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent'
      title: RecordCallbackRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailType:
      type: string
      description: Type of the email. Can be `HOME` or `WORK`.
      enum:
      - HOME
      - WORK
      title: EmailType
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus:
      type: string
      description: 'Status of the sender. It''ll be updated by Infobip platform automatically and notification about sender status update will be sent to client''s webhook. Following statuses are available:

        * `DRAFT`: Status returned when the Sender is created in Draft state via the UI.

        * `PENDING`: Status returned while the creation or update of the Sender is being processed.

        * `READY_FOR_TESTING`: Status indicating that the Sender has been created, is unlocked for editing, and testing is allowed on any device. If the launch process finishes unsuccessfully (i.e., all Providers have REJECTED), the Sender reverts to this status.

        * `PENDING_LAUNCH`: Status indicating that a launch has been requested through the Account Manager, RR (future), or CUP UI (future). The Sender is locked and cannot be edited.

        * `SENDER_UPDATE_REQUIRED`: Status indicating that after PENDING_LAUNCH, an update to the Sender is required. The Sender is unlocked for editing.

        * `LAUNCHED_IN_PROGRESS`: Status indicating that at least one Provider has successfully COMPLETED the launch of the Sender. The Sender is locked and ready for sending traffic, but the launch process with all Providers is not yet complete.

        * `LAUNCHED_PARTIAL_SUCCESS`: Status indicating that all Providers have completed their launch process with mixed results — some Providers have COMPLETED successfully, and others have REJECTED. The Sender remains locked and can be used for sending traffic.

        * `LAUNCHED`: Status indicating that all selected Providers have successfully COMPLETED the launch of the Sender.'
      enum:
      - DRAFT
      - PENDING
      - READY_FOR_TESTING
      - PENDING_LAUNCH
      - SENDER_UPDATE_REQUIRED
      - LAUNCHED_IN_PROGRESS
      - LAUNCHED_PARTIAL_SUCCESS
      - LAUNCHED
      title: RcsSenderStatus
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.SenderPublicKeyResponse:
      type: object
      description: WhatsApp sender public key information
      properties:
        publicKey:
          type: string
          description: PEM-formatted customer public key
          example: '-----BEGIN RSA PUBLIC KEY-----

            MIIBIjANBgkqhkiG...

            -----END RSA PUBLIC KEY-----'
        publicKeySignatureStatus:
          type: string
          description: Status of the customer public key signature
          example: VALID
      required:
      - publicKey
      - publicKeySignatureStatus
      title: SenderPublicKeyResponse
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.AndroidPushNotificationConfig:
      type: object
      description: Optional. Required if ios is not set. Configuration used to enable Android push notifications.
      properties:
        privateKeyJson:
          type: string
          description: Private key JSON file used to enable Android push notifications.
      required:
      - privateKeyJson
      title: AndroidPushNotificationConfig
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingServiceException:
      type: object
      properties:
        cause:
          type: object
          properties:
            stackTrace:
              type: array
              items:
                type: object
                properties:
                  classLoaderName:
                    type: string
                  moduleName:
                    type: string
                  moduleVersion:
                    type: string
                  methodName:
                    type: string
                  fileName:
                    type: string
                  lineNumber:
                    type: integer
                    format: int32
                  className:
                    type: string
                  nativeMethod:
                    type: boolean
            message:
              type: string
            localizedMessage:
              type: string
        stackTrace:
          type: array
          items:
            type: object
            properties:
              classLoaderName:
                type: string
              moduleName:
                type: string
              moduleVersion:
                type: string
              methodName:
                type: string
              fileName:
                type: string
              lineNumber:
                type: integer
                format: int32
              className:
                type: string
              nativeMethod:
                type: boolean
        message:
          type: string
        suppressed:
          type: array
          items:
            type: object
            properties:
              stackTrace:
                type: array
                items:
                  type: object
                  properties:
                    classLoaderName:
                      type: string
                    moduleName:
                      type: string
                    moduleVersion:
                      type: string
                    methodName:
                      type: string
                    fileName:
                      type: string
                    lineNumber:
                      type: integer
                      format: int32
                    className:
                      type: string
                    nativeMethod:
                      type: boolean
              message:
                type: string
              localizedMessage:
                type: string
        localizedMessage:
          type: string
      title: RecordingServiceException
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendRequestSchema:
      type: object
      properties:
        from:
          type: string
          description: 'Email address with optional sender name.


            Note: This field is required if `templateId` is not present.'
        to:
          type: array
          description: 'Email address of the recipient in a form of `To="john.smith@somecompany.com"`.

            As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Given `To` value should look like:

            `To= {"to": "john.smith@somecompany.com","placeholders": {"name": "John"}}`

            `To= {"to": "alice.grey@somecompany.com","placeholders": {"name": "Alice"}}`.


            Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
          items:
            type: string
            description: 'Email address of the recipient in a form of `To="john.smith@somecompany.com"`.

              As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination. Given `To` value should look like:

              `To= {"to": "john.smith@somecompany.com","placeholders": {"name": "John"}}`

              `To= {"to": "alice.grey@somecompany.com","placeholders": {"name": "Alice"}}`.


              Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
            maximum: 1000
          maximum: 1000
        cc:
          type: array
          description: 'CC recipient email address.

            As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination.


            Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
          items:
            type: string
            description: 'CC recipient email address.

              As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination.


              Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
            maximum: 1000
          maximum: 1000
        bcc:
          type: array
          description: 'BCC recipient email address.

            As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination.


            Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
          items:
            type: string
            description: 'BCC recipient email address.

              As optional feature on this field, a specific placeholder can be defined whose value will apply only for this destination.


              Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
            maximum: 1000
          maximum: 1000
        subject:
          type: string
          description: 'Message subject.


            Note: This field is required if `templateId` is not present.'
          maximum: 1000
          minimum: 1
        text:
          type: string
          description: Body of the message.
        html:
          type: string
          description: HTML body of the message. If `html` and `text` fields are present, the `text` field will be ignored and `html` will be delivered as a message body.
        ampHtml:
          type: string
          description: Amp HTML body of the message. If `ampHtml` is present, `html` is mandatory. Amp HTML is not supported by all the email clients. Please check this link for configuring gmail client https://developers.google.com/gmail/ampemail/.
        templateId:
          type: integer
          format: int64
          description: 'Template ID used for generating email content. The template is created over Infobip web interface or via the [Infobip Templates API](https://www.infobip.com/docs/api/channels/email/templates). If `templateId` is present, then `html` and `text` values are ignored.


            Note: `templateId` only supports the value of `Broadcast`. `Content` and `Flow` are not supported.'
        attachment:
          type: array
          format: binary
          description: File attachment.
          items:
            type: string
            format: binary
            description: File attachment.
        inlineImage:
          type: array
          format: binary
          description: Allows for inserting an image file inside the HTML code of the email by using `cid:FILENAME` instead of providing an external link to the image.
          items:
            type: string
            format: binary
            description: Allows for inserting an image file inside the HTML code of the email by using `cid:FILENAME` instead of providing an external link to the image.
        intermediateReport:
          type: boolean
          description: The real-time Intermediate delivery report that will be sent on your callback server.
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional client data that will be sent on the notifyUrl.
          maximum: 4000
          minimum: 0
        track:
          type: boolean
          description: Enable or disable open and click tracking. Passing true will only enable tracking and the statistics would be visible in the web interface alone. This can be explicitly overridden by `trackClicks` and `trackOpens`.
        trackClicks:
          type: boolean
          description: 'This parameter enables or disables track click feature.


            Note: Option to disable click tracking per URL is available. For detailed usage, please refer to the [documentation](https://www.infobip.com/docs/email/email-tracking-and-analytics/email-tracking-types#disable-click-tracking-on-urls-url-clicks).'
        trackOpens:
          type: boolean
          description: This parameter enables or disables track open feature.
        trackingPixelPosition:
          type: string
          description: 'This parameter specifies the position of the open tracking pixel within the email content.

            Allowed values are `TOP` and `BOTTOM`. If no value is provided, the default is `TOP`.'
        trackingUrl:
          type: string
          description: The URL on your callback server on which the open and click notifications will be sent. See [Tracking Notifications](https://www.infobip.com/docs/email/email-over-api/tracking-notifications) for details.
        bulkId:
          type: string
          description: The ID that uniquely identifies the sent bulk. This filter will enable you to query delivery reports for all the messages using just one request. You will receive a `bulkId` in the response after sending an email request. If you don't set your own `bulkId`, unique ID will be generated by our system and returned in the API response. (Optional Field)
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to a recipient. (Optional Field)
        campaignReferenceId:
          type: string
          description: The ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns.
        replyTo:
          type: string
          description: Email address to which recipients of the email can reply.
        defaultPlaceholders:
          type: string
          description: 'General placeholder, given in a form of json example: `defaultPlaceholders={"ph1": "Success"}`, which will replace given key `{{ph1}}` with given value `Success` anywhere in the email (subject, text, html...). In case of more destinations in `To` field, this placeholder will resolve the same value for key `ph1`.'
        preserveRecipients:
          type: boolean
          default: false
          description: If set to `true`, the `to` recipients will see the list of all other recipients to get the email and the response will return only one `messageId`. Otherwise, each recipient will see just their own email and the response will return a unique `messageId` for each email recipient.
        sendAt:
          type: string
          format: date-time
          description: 'To schedule message at a given time. Time provided should be in UTC in the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ` and cannot exceed 30 days in the future.

            '
          example: '2021-01-02T01:00:00.123Z'
        landingPagePlaceholders:
          type: string
          description: Personalize opt out landing page by inserting placeholders. Insert placeholder or tag while designing landing page.
        landingPageId:
          type: string
          description: The ID of an opt out landing page to be used and displayed once an end user clicks the unsubscribe link. If not present, default opt out landing page will be displayed. Create a landing page in your Infobip account and use its ID, e.g., `1_23456`.
        templateLanguageVersion:
          type: string
          default: '1'
          description: 'Specifies template language version that will be used in the current message template. Use version 1 for previous version of template language. Use version 2 for features of the new template language. If not present version 1 will be used as default version. '
        clientPriority:
          type: string
          default: STANDARD
          description: 'Adds a priority rating to this email message.

            Allowed values are `HIGH`, `STANDARD` and `LOW`.

            Messages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account.

            If no priority value is provided, messages will be treated with `STANDARD` priority by default.

            '
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events.
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events.
        headers:
          type: string
          description: 'Additional email headers for customization that can be provided in a form of JSON. For example, you can override List-Unsubscribe header and provide your own custom one: `headers={"List-Unsubscribe": "your unsubscribe link", "X-CustomHeader": "Header value"}`.


            There are a few exceptions of headers which are not adjustable through this option: `To`, `Cc`, `Bcc`, `From`, `Subject`,`Content-Type`, `DKIM-Signature`, `Content-Transfer-Encoding`, `Return-Path`, `MIME-Version`'
        ipPoolId:
          type: string
          description: The ID of the IP Pool which will be used for sending.
        skipPassiveStorage:
          type: boolean
          description: 'Set to true to skip [passive email storage](https://www.infobip.com/docs/email/email-storage-and-retrieval/passive-email-storage) (long-term storage used for compliance, legal, or audit purposes).

            If `false` or not set, the account-level setting is used.

            '
        skipActiveStorage:
          type: boolean
          description: 'Set to true to skip [active email storage](https://www.infobip.com/docs/email/email-storage-and-retrieval/active-email-storage) (short-term storage used for troubleshooting or support).

            If `false` or not set, the account-level setting is used.

            '
      required:
      - to
      title: SendRequestSchema
    74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ExtendedSipTrunkStatusResponse:
      type: object
      properties:
        adminStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus'
        actionStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatusResponse'
        registrationStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkRegistrationStatus'
        activeCalls:
          type: integer
          format: int32
          description: Number of active calls.
      title: ExtendedSipTrunkStatusResponse
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CaseObject:
      type: object
      properties:
        __default:
          type: array
          description: Array of actions to execute if none of the conditions above are met.
          items:
            type: object
            description: Array of actions to execute if none of the conditions above are met.
      title: CaseObject
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogKakaoChinguOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice'
        status:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus'
        error:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageError'
        platform:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform'
        content:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogKakaoChinguOutboundContent
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PlaceholderMasking:
      type: object
      description: Options to full or partially mask placeholders.
      properties:
        name:
          type: string
          description: The placeholder name that needs to be masked.
          example: ph1
        side:
          type: string
          default: L
          description: The side from which characters should be hidden. Options are `L` (left) or `R` (right).
        maskChar:
          type: string
          default: '*'
          description: The character used to replace the masked placeholders, e.g., `*`, `+`.
        visibleChars:
          type: integer
          format: int32
          default: 0
          description: The number of characters to leave visible. Ignored if a delimiter is specified. Defaults to 0 (i.e., all characters hidden) if not specified.
        delimiter:
          type: string
          description: Optional delimiter character (e.g., `@`, `/`). When specified, masking applies only to the part of the placeholder before or after the delimiter, depending on the `side` value. If this is set, the `visibleChars` field is ignored.
        skipChars:
          type: array
          description: A list of characters that should not be masked, even if they fall within the masked region. For example, if we want to mask `(385)-9134849` into `(***)-********`, we should include the characters `(`,`)` and `-` in this list to preserve the formatting. In this case, only digits will be masked while parentheses and dashes remain visible.
          items:
            type: string
            description: A list of characters that should not be masked, even if they fall within the masked region. For example, if we want to mask `(385)-9134849` into `(***)-********`, we should include the characters `(`,`)` and `-` in this list to preserve the formatting. In this case, only digits will be masked while parentheses and dashes remain visible.
      required:
      - name
      title: PlaceholderMasking
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DayOfWeek:
      type: string
      description: Specify the days a link can be used. It is every day of the week, by default.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DayOfWeek
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJson:
      type: object
      additionalProperties:
        type: object
        description: Flow JSON file content. The size is limited to 10 MB.
      title: AddFlowJson
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.WebhookTrackingPayload:
      type: object
      properties:
        notificationType:
          type: string
          description: 'Tells the type of user event that took place. Possible events: `OPENED`, `CLICKED`, `COMPLAINED`, `LATE_BOUNCE`, `UNSUBSCRIBED`.'
        eventId:
          type: string
          description: Unique ID of the event. This ID can be used for deduplication purposes.
        domain:
          type: string
          description: The sending domain used to send the email to the recipient.
        recipient:
          type: string
          description: Recipient of the email.
        sender:
          type: string
          description: Sender of the email. This attribute will only be present if the event is of the type `COMPLAINED` or `LATE_BOUNCE`.
        url:
          type: string
          description: The link the recipient has clicked. This attribute will only be present if the event is of the type `CLICKED`.
        sendDateTime:
          type: number
          description: The time at which the email was sent. Time is in milliseconds.
        messageId:
          type: number
          description: The ID that uniquely identifies the message sent to the recipient.
        bulkId:
          type: string
          description: The ID that uniquely identifies a list of email messages. This is either defined by user in the request or auto generated.
        callbackData:
          type: string
          description: The callback data sent through the callbackData field in your fully featured Email message.
        recipientInfo:
          $ref: '#/components/schemas/49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.RecipientInfo'
        geoLocation:
          $ref: '#/components/schemas/49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.GeoLocation'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
        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).
        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).
      title: WebhookTrackingPayload
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState:
      type: string
      description: Call state.
      enum:
      - CALLING
      - RINGING
      - PRE_ESTABLISHED
      - ESTABLISHED
      - FINISHED
      - FAILED
      - CANCELLED
      - NO_ANSWER
      - BUSY
      title: CallState
    ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SingleMessageStatus:
      type: object
      description: Indicates the message status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        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: Status description.
      required:
      - description
      - groupId
      - groupName
      - id
      - name
      title: SingleMessageStatus
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit:
      type: string
      default: MINUTES
      description: The message validity period time unit, allowing finer time granulation.
      enum:
      - NANOSECONDS
      - MICROSECONDS
      - MILLISECONDS
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      title: TimeUnit
      writeOnly: true
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListActionContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveListHeaderContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      title: InteractiveListContent
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationResponse:
      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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: PushUnificationResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatusResponse:
      type: object
      description: SIP trunk action status.
      properties:
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatus'
        reason:
          type: string
          description: Description of the `FAILED` or `RESET` action.
      title: SipTrunkActionStatusResponse
    4171c7b532e904c90fa2d755f583a0120bed3adbb383ab2309fddb57ee41f476.SingleTtsApiRequest:
      type: object
      description: Single voice message request object.
      properties:
        audioFileUrl:
          type: string
          description: An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are mp3 and wav. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
        text:
          type: string
          description: Message to be converted to speech and played to subscribers. Message text can be up to 1400 characters long and cannot contain only punctuation. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.
          externalDocs:
            description: SSML support
            url: https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages
        language:
          type: string
          description: If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.
          externalDocs:
            description: Voice Text-To-Speech Languages
            url: https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages
        voice:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice'
        from:
          type: string
          description: 'Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable.'
        to:
          type: string
          description: 'Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727).'
      required:
      - from
      - to
      title: SingleTtsApiRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Error:
      type: object
      description: Indicates whether an error occurred during the query execution.
      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.
      title: Error
    02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateCallRequest:
      type: object
      properties:
        muted:
          type: boolean
          description: Indicates whether to mute or unmute the end user. This action prevents the user from talking.
        deaf:
          type: boolean
          description: Indicates whether to deaf or undeaf the end user. This action prevents the user from hearing the call.
        blind:
          type: boolean
          description: Indicates whether to blind or unblind the end user. This action prevents the user from seeing any remote video in the call. Only applicable for WebRTC endpoints.
        role:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role'
      title: UpdateCallRequest
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsTextHeaderContent'
          VIDEO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsVideoHeaderContent'
          IMAGE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsImageHeaderContent'
          DOCUMENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonsDocumentHeaderContent'
      properties:
        type:
          type: string
          description: Type of the header content. Select the type from the dropdown to view its parameters.
      required:
      - type
      title: InteractiveButtonsHeaderContent
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolUpdateApiRequest:
      type: object
      properties:
        priority:
          type: integer
          format: int32
          description: IP pool sending priority.
          maximum: 49
          minimum: 0
      required:
      - priority
      title: DomainIpPoolUpdateApiRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactContent:
      type: object
      description: An array of contacts sent in a WhatsApp message.
      properties:
        addresses:
          type: array
          description: Array of addresses information.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressContent'
        birthday:
          type: string
          description: Date of birth in `YYYY-MM-DD` format.
        emails:
          type: array
          description: Array of emails information.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailContent'
        name:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.NameContent'
        org:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrganizationContent'
        phones:
          type: array
          description: Array of phones information.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneContent'
        urls:
          type: array
          description: Array of urls information.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlContent'
      required:
      - name
      title: ContactContent
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SeenStatusReporting:
      type: object
      description: Provides options for configuring the seen report behavior.
      properties:
        url:
          type: string
          description: The URL on your call back server where a seen report will be sent.
      title: SeenStatusReporting
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CardApiData:
      type: object
      description: List of cards.
      properties:
        header:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData'
        body:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData'
        buttons:
          type: array
          description: Card buttons. Can contain 1 to 2 buttons.
          items:
            $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData'
          maxItems: 2
          minItems: 1
      required:
      - body
      - buttons
      - header
      title: CardApiData
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInAppExpirationTimeUnit:
      type: string
      description: Time unit mirrored push notification expiration.
      enum:
      - MINUTES
      - HOURS
      title: PushOutboundContentOptionsInAppExpirationTimeUnit
    2f1f086f3fbc952749e03dadc7759cfc932ca2898a0c5e5b77a8bc2d84bd5c48.BulkRequest:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID of the bulk request. If it's not set, a unique ID will be assigned to the bulk request.
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        items:
          type: array
          description: Bulk item list.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkItem'
          minLength: 1
      required:
      - callsConfigurationId
      - items
      title: BulkRequest
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData:
      type: object
      description: Structure of the created template. Can consist of body (mandatory), header, footer, buttons, carousel, limited time offer, call permission request and shortening options.
      properties:
        header:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData'
        body:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.BodyApiData'
        footer:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FooterApiData'
        buttons:
          type: array
          description: Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one `copy code` button and one `flow` button. `quick reply` and non `quick reply` buttons have to be grouped together.
          items:
            $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData'
        carousel:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CarouselApiData'
        limitedTimeOffer:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LimitedTimeOfferApiData'
        callPermissionRequest:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CallPermissionRequestApiData'
        shorteningOptions:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ShorteningOptionsApiData'
        type:
          type: string
          description: Template structure type.
          enum:
          - TEXT
          - MEDIA
          - UNSUPPORTED
          readOnly: true
      required:
      - body
      title: DefaultTemplateStructureApiData
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryDay'
        from:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTime'
        to:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.CallLinkPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLink'
        paging:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo'
      title: CallLinkPage
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTtyOptions:
      type: object
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the message will be played.
          maximum: 10
          minimum: 1
      title: PlayTtyOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Capture:
      type: object
      description: Capture action performs speech recognition of a specified duration. The recognized text can be used in other actions of the scenario. Speech capture will start after the beep tone.
      properties:
        capture:
          type: string
          description: Variable name. If speech recognition matches one of the specified keyPhrases, a variable with this name will be set to match the keyphrase. Otherwise, this variable will be an empty string. Together with this variable, an implicit variable that contains the full text of the captured speech will be created. The name of this variable is constructed by adding _Full suffix to the variable name.
        timeout:
          type: integer
          format: int32
          description: Number of seconds used for capturing speech or digits failover. Minimum value is 1 and maximum value is 30. Can be overriden with speechOptions.maxSilence.
          maximum: 30
          minimum: 1
        beep:
          type: boolean
          default: true
          description: Flag indicating whether a beep sound should play at the start of capture.
        speechOptions:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SpeechOptions'
        dtmfOptions:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DtmfOptions'
        sendToReports:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - capture
      - speechOptions
      - timeout
      title: Capture
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CarouselApiData:
      type: object
      description: Template carousel. Applicable only for MARKETING category.
      properties:
        cards:
          type: array
          description: List of cards.
          items:
            $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CardApiData'
          maxItems: 10
          minItems: 1
      required:
      - cards
      title: CarouselApiData
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint:
      type: object
      description: Call establishment attempt end time.
      properties:
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
      title: TimeWindowPoint
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.LocalizationType:
      type: string
      enum:
      - BROWSER_DETECTED
      - PRESET
      title: LocalizationType
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.BulkTextMessage:
      type: object
      properties:
        messages:
          type: array
          description: An array of messages being sent.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTextMessage'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          maxLength: 100
          minLength: 0
      required:
      - messages
      title: BulkTextMessage
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: ContactsMessage
    afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestError:
      type: object
      properties:
        serviceException:
          allOf:
          - $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestErrorDetails'
      title: ApiRequestError
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderCurrency:
      type: string
      description: Order currency.
      enum:
      - INR
      - BRL
      title: OrderCurrency
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: AudioMessage
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Language:
      type: object
      description: By setting the `languageCode` parameter you can send your language specific characters
      properties:
        languageCode:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LanguageCode'
      title: Language
      writeOnly: true
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ErrorCode:
      type: object
      description: Error code.
      properties:
        id:
          type: integer
          format: int32
          description: Id of the error code.
        name:
          type: string
          description: Name of the error code.
        description:
          type: string
          description: Description of the error code.
      title: ErrorCode
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.LogResponseEmailUnificationLog:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUnificationLog'
        cursor:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.CursorPageInfo'
      title: LogResponseEmailUnificationLog
    eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.WebhookCallbackResponse:
      type: object
      description: Response from the markup language callback containing instructions to execute.
      properties:
        script:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CmlScript'
      title: WebhookCallbackResponse
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentText:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters.
        text:
          type: string
          description: Message text.
      title: Text segment
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveRequestContactInfoMessage
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateButtonContent:
      type: object
      description: Media template buttons
      properties:
        urlPlaceholder:
          type: string
          description: URL placeholder. Required for URL buttons that have a parameterized URL.
          maxLength: 1500
          minLength: 0
          writeOnly: true
        quickReplyPayload:
          type: string
          description: QuickReply payload. Required for quick reply buttons.
          maxLength: 128
          minLength: 0
          writeOnly: true
      title: MediaTemplateButtonContent
      writeOnly: true
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTty:
      type: object
      description: Play TTY action converts the provided text into Baudot tones and plays the generated audio, enabling the message to be displayed on a connected TTY device. This action is designed to support IVR scenarios adapted for users with hearing impairments.
      properties:
        playTty:
          type: string
          description: Text that will be played in Baudot tones. The parameter can be constructed using variables.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayTtyOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - playTty
      title: Play TTY
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo:
      type: object
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryDay'
        from:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime'
        to:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus:
      type: string
      description: The status of the message(s).
      enum:
      - PENDING
      - PAUSED
      - PROCESSING
      - CANCELED
      - FINISHED
      - FAILED
      title: BulkStatus
    18a8b746d2b3a8fcfed338bade07f6facb992e3867826d141a0e0ae5a3ba5642.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    42b3068683a04f02f0303cd880adeb4415571c6aad33d9a3c6850123c94c9889.VoiceReport:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the bulk of messages.
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          readOnly: false
          writeOnly: false
        to:
          type: string
          description: Destination address of the voice message.
          readOnly: false
          writeOnly: false
        sentAt:
          type: string
          description: 'Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        doneAt:
          type: string
          description: 'Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        startTime:
          type: string
          description: 'Date and time when the voice message was established and started ringing. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        answerTime:
          type: string
          description: 'Date and time when the voice message was answered. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        endTime:
          type: string
          description: 'Date and time when the voice message was ended. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        duration:
          type: integer
          format: int32
          description: Duration of the voice message call, in seconds.
          readOnly: false
          writeOnly: false
        fileDuration:
          type: number
          format: double
          description: Duration of the voice message audio file, in seconds.
          readOnly: false
          writeOnly: false
        mccMnc:
          type: string
          description: Mobile country and network codes.
          readOnly: false
          writeOnly: false
        callbackData:
          type: string
          description: Custom data sent over to the notifyUrl.
          readOnly: false
          writeOnly: false
        dtmfCodes:
          type: string
          description: DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.
          readOnly: false
          writeOnly: false
        dtmfCodesAsJson:
          type: string
          description: DTMF code entered by user, but in JSON form - including DTMF variable names.
          readOnly: false
          writeOnly: false
        transcribedAudioFileUrl:
          type: string
          description: Url to retrieve call transcription that were made by voice messages with the transcribe feature activated.
          readOnly: false
          writeOnly: false
        scenarioId:
          type: string
          description: The ID that uniquely identifies the IVR scenario.
          readOnly: false
          writeOnly: false
        scenarioName:
          type: string
          description: Name of IVR scenario.
          readOnly: false
          writeOnly: false
        price:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price'
          description: Sent voice message price.
          readOnly: false
          writeOnly: false
        status:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status'
          description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
          externalDocs:
            description: Response status and error codes
            url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#status-object-example
          readOnly: false
          writeOnly: false
        error:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error'
          description: Indicates whether the error occurred during the query execution.
          externalDocs:
            description: Response status and error codes
            url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#error-object-example
          readOnly: false
          writeOnly: false
      title: VoiceReport
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.Paging:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: Paging
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice'
        status:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus'
        error:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    ab7498b77a5058e37557279988a806092938b5b30ecbfd39229d94cbcf4bdc07.IdentityConfirmation:
      type: object
      properties:
        hash:
          type: string
          description: Identity hash
          example: eU2Fdi4EMUw=
      required:
      - hash
      title: IdentityConfirmation
    f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateEditPublicApiRequest:
      type: object
      properties:
        category:
          type: string
          description: Category of the template. Approved template category cannot be edited.
          enum:
          - MARKETING
          - AUTHENTICATION
          - UTILITY
          example: MARKETING
        structure:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editStructure'
        validityPeriod:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editValidityPeriod'
        platform:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform'
        subCategory:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editSubCategory'
      title: TemplateEditRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Platform'
        validityPeriod:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.NonMsisdnSmsFailover'
        encrypted:
          type: boolean
          description: Set to *true* when you want to send encrypted Zalo messages! In that case, you need to send encrypted values in templateData property! If the encrypted field is set to *true*, URL shortening within Zalo message will be disabled and unavailable. Ensure this configuration aligns with your use case before enabling encryption.
        sendingMode:
          type: string
          description: Mode for sending Zalo messages. `REGULAR` - Zalo messages are sent in the usual manner. `OVER_THE_LIMIT` - Allows OA to send Zalo tag 3 messages exceeding the limit (more expensive). `AUTO` - use `REGULAR` with fallback to `OVER_THE_LIMIT` if needed. Over limit sending mode is not supported for sending messages tagged as CUSTOMER_CARE or TRANSACTION.
          enum:
          - REGULAR
          - OVER_THE_LIMIT
          - AUTO
      title: ZaloMessageOptions
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundTextContent'
          IMAGE: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundImageContent'
      properties:
        type:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentType'
      required:
      - type
      title: PushOutboundContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderDetailsType:
      type: string
      description: A quick payment option bypassing the review step. Applicable for PG PayU and PG Razorpay.
      enum:
      - QUICK_PAY
      title: OrderDetailsType
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SouthKoreaOptions'
      title: RegionalOptions
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.HeaderApiData:
      type: object
      description: Template header. Can be `image`, `document`, `video`, `location` or `text`.
      discriminator:
        propertyName: format
        mapping:
          TEXT: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TextHeaderApiData'
          IMAGE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ImageHeaderApiData'
          VIDEO: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VideoHeaderApiData'
          GIF: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.GifHeaderApiData'
          DOCUMENT: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DocumentHeaderApiData'
          LOCATION: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.LocationHeaderApiData'
      properties:
        format:
          type: string
          enum:
          - TEXT
          - IMAGE
          - VIDEO
          - GIF
          - DOCUMENT
          - LOCATION
      title: HeaderApiData
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.HttpMethod:
      type: string
      description: Http method
      enum:
      - GET
      - POST
      - PUT
      - DELETE
      - PATCH
      title: HttpMethod
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageInfo:
      type: object
      properties:
        to:
          type: string
          description: The destination address of the message.
          example: '385977666618'
        messageCount:
          type: integer
          format: int32
          description: Number of messages required to deliver.
          example: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.
          example: 06df139a-7eb5-4a6e-902e-40e892210455
        status:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SingleMessageStatus'
      title: SingleMessageInfo
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Status:
      type: string
      description: Status of the call recording.
      enum:
      - SUCCESSFUL
      - PARTIALLY_FAILED
      - FAILED
      title: Status
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.UrlDeletionRequest:
      type: object
      properties:
        url:
          type: string
          description: URL of the WhatsApp media to be deleted.
          example: https://www.infobip.com/infobip-logo.png
      required:
      - url
      title: UrlDeletionRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContentType:
      type: string
      enum:
      - TEXT
      - FILE
      - SUGGESTION
      - LOCATION
      title: RcsInboundMessageContentType
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiException:
      type: object
      properties:
        requestError:
          allOf:
          - $ref: '#/components/schemas/afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestError'
      title: ApiException
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequest:
      type: object
      description: List of push requests
      properties:
        from:
          type: string
          description: PUSH Application Code you are using to send messages. Application Code is the application identifier which links your mobile application to the [application profile](https://www.infobip.com/docs/mobile-push/get-started/mobile-application-profile#copy-application-code-create-and-enable-a-mobile-application-profile) created in Infobip Platform. It is required to insert the Application Code in Mobile Messaging SDK configuration once you implement it in your mobile application.
          maxLength: 80
          minLength: 1
        to:
          type: object
          additionalProperties:
            type: object
          description: Recipient destination address. [Check examples](https://www.infobip.com/docs/mobile-push/mobile-push-over-api) how to work with recipients
        text:
          type: string
          description: Text of the message that will be sent.
          maxLength: 4000
          minLength: 1
        validityPeriod:
          type: integer
          format: int64
          description: The message validity period. Unless specified differently in `validityPeriodTimeUnit`, it is expressed in hours. Once the period expires, messages that haven't left the Infobip platform or the Cloud (APNS or FCM) will be canceled and won't get delivered. Default value is 48h. Minimum value is 30 sec. Maximum value is 72h.
          minimum: 0
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriodTimeUnit'
        sendAt:
          type: string
          format: date-time
          description: 'Used for scheduled Push notifications. Message will be sent at scheduled time. Date and time when the message is to be sent. 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.'
        customPayload:
          type: object
          additionalProperties:
            type: object
          description: Additional data that can be delivered with the Push message. customPayload must be formatted as JSON object.
        notificationOptions:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestNotificationOptions'
        notifyUrl:
          type: string
          description: 'The URL on your call back server on to which a delivery report will be sent. The retry cycle for when your URL becomes unavailable uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        notifyContentType:
          type: string
          description: 'Preferred Delivery report content type. Supported content types: application/json, application/xml.'
        callbackData:
          type: string
          description: Additional client's data that will be sent onto `notifyUrl`. The maximum value is 200 characters.
        targetOnlyPrimaryDevices:
          type: boolean
          description: Set to true to only send messages to push devices which are marked as primary devices. By default, messages will be sent to all targeted devices, including both primary and non-primary.
      required:
      - from
      - text
      - to
      title: PushRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversations:
      type: object
      description: Dial to Conversations action performs a call redirection to the [Infobip Conversations platform](https://www.infobip.com/docs/conversations), joining the user’s call with an agent. Dial to Conversations must be the last action.
      properties:
        dialToConversations:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsData'
      required:
      - dialToConversations
      title: Dial To Conversations
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsReport:
      type: object
      description: Array of voice message logs, one object per each message.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the bulk of messages.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          type: string
          description: Destination address of the voice message.
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        text:
          type: string
          description: Content of the voice message that was sent.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the voice message was initiated. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: Date and time when the Infobip services finished processing the voice message (i.e. delivered to the destination, delivered to the destination network, etc.).
        duration:
          type: integer
          format: int32
          description: Voice message duration in seconds.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        price:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price'
        status:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus'
        error:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError'
      title: LogsReport
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTerminationType:
      type: string
      enum:
      - DTMF
      title: PublicTerminationType
    a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType'
        url:
          type: string
          description: URL that leads to the image that end user saw and clicked.
          readOnly: false
          writeOnly: true
      title: ReferralMediaImage
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEvent:
      type: object
      description: An array of event objects of the events to be sent.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where the event is being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ToDestination'
        content:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContent'
        options:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventOptions'
      required:
      - content
      - destinations
      - sender
      title: TikTokEvent
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoTargeting:
      type: string
      default: TARGETED_FRIENDS
      description: 'Sets the target audience that will receive the message. Targeting types: `ALL_CONSENT` is for messages to marketing-opted users with opt-out notice to non-friends and direct delivery to friends; `NON_FRIENDS` is for messages exclusively to non-friends with opt-out; `TARGETED_FRIENDS` is for channel friends via phone number or list upload (without template variables for uploads).'
      enum:
      - ALL_CONSENT
      - NON_FRIENDS
      - TARGETED_FRIENDS
      title: KakaoTargeting
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveFlowMessage
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageOrderingOptions:
      type: object
      properties:
        respectOrder:
          type: boolean
          default: true
          description: 'If set to `true`, messages will be sent in the same order as they are provided in the request. Following rules must be respected in that case:

            * The `messages` array can contain either 2 messages, where only the first message has failover defined, or between 2 and 10 messages, none of which has failover defined.

            * Following properties must be the same for all messages in the request: `sender`, `destinations`, `options.platform`, `options.deliveryTimeWindow`, `options.campaignReferenceId`, `webhooks.delivery`, `webhooks.contentType`, `webhooks.callbackData`, `webhooks.seen`.

            For best experience, if message ordering is used, it''s recommended to have list of suggestions defined for last message only or have it the same for all messages in the request.'
          example: true
        stopOnFailure:
          type: boolean
          default: true
          description: It can be used in combination with `respectOrder` to stop sending messages if any message fails. It will be respected only if none of the messages from the request has failover defined. If failover is used, the system will, by default, send only the failover message and will not send the second message from the request.
          example: true
      title: RcsMessageOrderingOptions
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.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
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice'
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus'
        error:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentBinary:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers.
          writeOnly: true
        contentType:
          type: string
          description: Content type for media, for example `image/png`.
          writeOnly: true
        contentBase64:
          type: string
          description: Content in Base64 format.
          writeOnly: true
      required:
      - contentType
      title: Binary segment
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReport'
      title: DeliveryReports
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RoleType:
      type: string
      enum:
      - DEFAULT
      - ADVISOR
      - MONITOR
      - LISTENER
      - AUDITOR
      title: RoleType
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Record:
      type: object
      description: Record action records audio from the call.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - record
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        recordingStatusCallbackUrl:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl'
        recordingStatusCallbackEvents:
          type: array
          description: Set of recording status events that trigger the recording status callback.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent'
          uniqueItems: true
        timeout:
          type: integer
          format: int32
          description: Maximum recording duration in seconds.
        maxSilence:
          type: integer
          format: int32
          description: Maximum silence duration in seconds before stopping recording.
        escapeDtmf:
          type: string
          description: DTMF digit to escape recording.
        playBeep:
          type: boolean
          default: true
          description: Whether to play a beep before recording starts.
      required:
      - action
      - callback
      title: Record
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus:
      type: string
      description: Indicates current status of the recording file being uploaded via SFTP.
      enum:
      - UPLOADING
      - UPLOADED
      - FAILED
      title: SftpUploadStatus
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultCc:
      type: object
      allOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResult'
      - type: object
        properties:
          cc:
            type: string
            description: The message destination address.
            example: '41793026728'
          messageId:
            type: string
            description: The ID that uniquely identifies the message sent.
            example: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
      required:
      - status
      title: Message result as cc
    b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceData:
      type: object
      properties:
        feature:
          type: string
          description: Name of the Infobip Voice service or feature.
          readOnly: false
          writeOnly: false
        startTime:
          type: string
          description: 'Date and time when the voice message was established and started ringing. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          readOnly: false
          writeOnly: false
        answerTime:
          type: string
          description: 'Date and time when the voice message was answered. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          readOnly: false
          writeOnly: false
        endTime:
          type: string
          description: 'Date and time when the voice message was ended. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
          readOnly: false
          writeOnly: false
        duration:
          type: integer
          format: int32
          description: Duration of the voice message, in seconds.
          readOnly: false
          writeOnly: false
        chargedDuration:
          type: integer
          format: int32
          description: Charged duration of the voice message, in seconds.
          readOnly: false
          writeOnly: false
        fileDuration:
          type: number
          format: double
          description: Duration of the voice message audio file, in seconds.
          readOnly: false
          writeOnly: false
        dtmfCodes:
          type: string
          description: DTMF code entered by user. Can be empty string, if user did not press anything, or `null` in case of IVR if user did not participate in Collect action.
          readOnly: false
          writeOnly: false
        answeredBy:
          type: string
          description: If machine detection is used, contains the result of the machine detection (`HUMAN` or `MACHINE`). Currently, populated only if the call was IVR.
          readOnly: false
          writeOnly: false
        callRecordingFileId:
          type: string
          description: Call recording file identification, if the call was recorded. Currently, populated only if the call was IVR. The file can be downloaded using [calls api](https://www.infobip.com/docs/api/channels/voice/calls/files-and-recordings/download-recording-file).
          readOnly: false
          writeOnly: false
        direction:
          type: string
          description: Call direction.
          readOnly: false
          writeOnly: false
        ivr:
          allOf:
          - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.IvrData'
          description: Fields representing details about IVR, if outbound IVR is being used. If the call was not IVR, the field will be null.
          readOnly: false
          writeOnly: false
      title: VoiceData
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Platform'
        validityPeriod:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      title: EmailMessageOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedWebhooksWithSeen:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenStatusReporting'
      title: AdvancedWebhooksWithSeen
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.CallType:
      type: string
      description: Call type of the recorded call.
      enum:
      - WEBRTC_CALL
      - PHONE_CALL
      - VIBER_CALL
      - ROOM_CALL
      title: CallType
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsOptions:
      type: object
      properties:
        tagIdentifierType:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.TagIdentifierType'
        tags:
          type: array
          description: An array of [conversation tag](https://www.infobip.com/docs/conversations/get-to-know-conversations#tags-templates-and-tags) names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value.
          items:
            type: string
            description: An array of [conversation tag](https://www.infobip.com/docs/conversations/get-to-know-conversations#tags-templates-and-tags) names or ids that are assigned to this conversation for better categorization of the topics or customer intent. Value can be an array of tag names/ids, empty array, or null value.
      required:
      - tags
      title: DialToConversationsOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundTextContent'
          FILE: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundFileContent'
          CARD: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCardContent'
          CAROUSEL: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundCarouselContent'
          PROVIDER_TEMPLATE: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundProviderTemplateContent'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundMessageContentType'
      required:
      - type
      title: RcsOutboundMessageContent
    b41d7b140d24800c94ddcc7df92e32ab37fc7d5f310ce1050b04561c5e59a3b7.LogsResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of logs.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Log'
          readOnly: true
      title: LogsResponse
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.InboundMessageKakaoSangdamInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundContent'
        price:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageKakaoSangdamInboundContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation:
      type: string
      description: Location of recording file after processing.
      enum:
      - SFTP
      - HOSTED
      title: RecordingFileLocation
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.MachineDetection:
      type: string
      description: Machine Detection action detects answering machines at the beginning of the call. This action sets `machineAnswered` variable upon completion to `true`  or `false`. Machine Detection introduces a delay of approximately 4s. This is the minimum time needed for machine detection. Machine Detection action has to be followed by a condition action that uses the value of `machineAnswered` for branching into the 'human answered' block and the 'answering machine answered' block. The 'answering machine' block can have a Say/Play/PlayFromRecording action or a Hangup action.
      enum:
      - machineDetection
      required:
      - machineDetection
      title: Machine Detection (Simple)
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberTemplateResponse:
      type: object
      description: Viber message template response containing template details and current status.
      properties:
        templateId:
          type: string
          description: Unique identifier of the template.
          example: 00000000-0000-0000-0000-000000000000
        version:
          type: string
          description: Template version number.
          example: '1'
        sender:
          type: string
          description: Sender for which the template is registered.
          example: CompanyName
        createdAt:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds when the template was created.
          example: 1677628800000
        category:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory'
        status:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateStatus'
        lastModified:
          type: integer
          format: int64
          description: Unix timestamp in milliseconds when the template was last modified.
          example: 1677628800000
        params:
          type: array
          description: List of variable parameters defined in the template.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam'
        body:
          type: array
          description: List of template bodies per language containing the actual message text.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody'
      title: ViberTemplateResponse
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType:
      type: string
      description: Type of audio content
      enum:
      - FILE
      - URL
      title: AudioContentType
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    2e05f28ea1ad0c8ab6683b6adca8c2dc53bf0d4883946379aef59ba8417e5029.BulkRequest:
      type: object
      properties:
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled SMS (see [Scheduled SMS endpoints](#channels/sms/get-scheduled-sms-messages) for more details). 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.'
      required:
      - sendAt
      title: BulkRequest
    f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatesApiResponse:
      type: object
      properties:
        templates:
          type: array
          description: List of all templates for given sender.
          items:
            $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse'
      title: TemplatesResponse
    04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.OmniAdvancedRequest:
      type: object
      properties:
        scenarioKey:
          type: string
          description: Scenario key that uniquely identifies the scenario which will be used when sending message. If this field is not set, the default scenario will be used.
          writeOnly: true
        bulkId:
          type: string
          description: The ID which uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          writeOnly: true
        destinations:
          type: array
          description: Destinations to which you are sending a message, such as phone number, email address, or unique ID.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Destination'
          writeOnly: true
        sms:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SmsData'
        whatsApp:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.WhatsAppData'
        viber:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ViberData'
        voice:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VoiceData'
        email:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.EmailData'
        push:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PushData'
        line:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineData'
        kakaoChingu:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguData'
        kakaoAlim:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimData'
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notifyUrl:
          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)`.'
        notifyContentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled OMNI messaging (first message in the OMNI flow not sent immediately, but at scheduled time). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. Must be sooner than 180 days from now.'
        vKontakte:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VKontakteData'
      title: OmniAdvancedRequest
    dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityPageResponse:
      type: object
      properties:
        identity:
          type: string
          description: Identity associated with the requested activities.
        results:
          type: array
          description: List of results for the requested page.
          items:
            $ref: '#/components/schemas/dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityResponse'
        pageInfo:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo'
      title: UserActivityPageResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrder:
      type: object
      description: The order details.
      properties:
        catalogId:
          type: string
          description: The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to.
        items:
          type: array
          description: An array of items in the order.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderItem'
        subtotal:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount'
        tax:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount'
        shipping:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount'
        discount:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDiscount'
        orderExpiration:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderExpiration'
        orderDetailsType:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderDetailsType'
      required:
      - items
      - subtotal
      - tax
      title: InteractiveOrderDetailsOrder
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenReport:
      type: object
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
          readOnly: false
          writeOnly: true
        from:
          type: string
          description: Number which sent the message.
          readOnly: false
          writeOnly: true
        to:
          type: string
          description: Registered WhatsApp business number.
          readOnly: false
          writeOnly: true
        sentAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
          readOnly: false
          writeOnly: true
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
          readOnly: false
          writeOnly: true
        applicationId:
          type: string
          description: Application id that the message is linked to.
          readOnly: false
          writeOnly: true
        entityId:
          type: string
          description: Entity id that the message is linked to.
          readOnly: false
          writeOnly: true
        contact:
          allOf:
          - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact'
          description: End user contact.
          readOnly: false
          writeOnly: true
      title: SeenReport
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ErrorReport:
      type: object
      description: Indicates whether the error occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
          example: 0
        groupName:
          type: string
          description: Error group name.
          example: OK
        id:
          type: integer
          format: int32
          description: Error ID.
          example: 0
        name:
          type: string
          description: Error name.
          example: NO_ERROR
        description:
          type: string
          description: Human-readable description of the error.
          example: No Error
        permanent:
          type: boolean
          description: Indicator of whether the error is permanent.
          example: false
      required:
      - description
      - groupId
      - groupName
      - id
      - name
      - permanent
      title: ErrorReport
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncRequest:
      type: object
      properties:
        sender:
          type: string
          description: Identifier of an RCS sender that will be used to send message.
        phoneNumbers:
          type: array
          description: A list of phone numbers to check for RCS capability (for example, `["441134960001", "441134960002"]`).
          items:
            type: string
            xml:
              name: phoneNumbers
          maxItems: 10000
          minItems: 1
        notifyUrl:
          type: string
          description: The URL of your callback server where the RCS capability check report will be sent. The schema for this endpoint is documented at [Receive Capability Check result](#channels/rcs/receive-capability-check-result).If notifyUrl is empty, events will be sent to the URL you added via Subscription API. The event name is CapCheck.
        notifyContentType:
          type: string
          description: 'The preferred content type for the RCS capability check report. Options are: `application/json` or `application/xml`.'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions'
      required:
      - phoneNumbers
      - sender
      title: CapabilityCheckAsyncRequest
      xml:
        name: CapabilityCheckAsyncRequest
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguData:
      type: object
      description: Kakao ChinguTalk-specific data used if the message is sent through a Kakao ChinguTalk channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        buttons:
          type: array
          description: Buttons to include in the message. Optional value. Max 5 buttons.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton'
          maxItems: 5
          minItems: 1
          writeOnly: true
        imageUrl:
          type: string
          description: URL of the image sent in the message. Optional value. Max 250 characters.
          maxLength: 250
          minLength: 1
          writeOnly: true
        imageLink:
          type: string
          description: Link of the image sent in the message. Optional value. Max 250 characters.
          maxLength: 250
          minLength: 1
          writeOnly: true
        isPromotional:
          type: boolean
          description: Flag that defines the message as promotional or not. Optional value.
          writeOnly: true
      required:
      - imageUrl
      - text
      title: KakaoChinguData
      writeOnly: true
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DefaultMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Platform'
        validityPeriod:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      title: DefaultMessageOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    31df1a57142f86aa8caefaa914e5a897a1c5c119e96ae8d3d5f19b12a525e2b7.Report:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
          readOnly: false
          writeOnly: true
        price:
          allOf:
          - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price'
          description: Sent message price.
          readOnly: false
          writeOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Status'
          description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
          readOnly: false
          writeOnly: true
        error:
          allOf:
          - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Error'
          description: Indicates whether the error occurred during the query execution.
          readOnly: false
          writeOnly: true
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          readOnly: false
          writeOnly: true
        doneAt:
          type: string
          format: date-time
          description: Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.).
          readOnly: false
          writeOnly: true
        messageCount:
          type: integer
          format: int32
          description: The number of sent message segments.
          readOnly: false
          writeOnly: true
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: true
        to:
          type: string
          description: The message destination address.
          readOnly: false
          writeOnly: true
        contact:
          allOf:
          - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DlrContact'
          description: End user contact.
          readOnly: false
          writeOnly: true
      title: Report
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextFreeFormContent'
          IMAGE_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageFreeFormContent'
          IMAGE_WIDE_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideFreeFormContent'
          ITEM_LIST_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListFreeFormContent'
          COMMERCE_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCommerceFreeFormContent'
          CAROUSEL_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselFreeFormContent'
          CAROUSEL_COMMERCE_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundCarouselCommerceFreeFormContent'
          PREMIUM_VIDEO_FREE_FORM: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundPremiumVideoFreeFormContent'
          TEXT_VARIABLE: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundTextVariableContent'
          IMAGE_VARIABLE: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageVariableContent'
          IMAGE_WIDE_VARIABLE: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundImageWideVariableContent'
          ITEM_LIST_VARIABLE: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundItemListVariableContent'
      properties:
        type:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContentType'
      required:
      - type
      title: KakaoChinguOutboundContent
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SouthKoreaOptions'
      title: RegionalOptions
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType:
      type: string
      description: Template content type.
      enum:
      - TEXT
      - CARD
      - CAROUSEL
      - TEXT_WITH_PDF
      title: RcsTemplateContentType
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SortDirection:
      type: string
      enum:
      - ASC
      - DESC
      title: SortDirection
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          RESPONSE_BUTTON: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundResponseButtonContent'
          USER_FEEDBACK: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundUserFeedbackContent'
          FOLLOW: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundFollowContent'
          UNFOLLOW: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundUnfollowContent'
          TEXT: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundTextContent'
          USER_SUBMIT_INFO: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundUserSubmitInfoContent'
          IMAGE: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundImageContent'
          VIDEO: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundVideoContent'
          AUDIO: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundAudioContent'
          FILE: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundFileContent'
          GIF: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundGifContent'
          LINK: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundLinkContent'
          STICKER: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundStickerContent'
          LOCATION: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundLocationContent'
          BUSINESS_CARD: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundBusinessCardContent'
          UNKNOWN: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundUnknownContent'
      properties:
        type:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContentType'
      title: ZaloInboundContent
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus:
      type: string
      description: New status of the bulk.
      enum:
      - PENDING
      - PAUSED
      - PROCESSING
      - CANCELED
      - FINISHED
      - FAILED
      title: BulkStatus
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReportsResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ApiReport'
      title: ApiReportsResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType:
      type: string
      enum:
      - TEXT
      - FILE
      title: ViberInboundMessageContentType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsOrderExpiration:
      type: object
      description: Expiration of the order.
      properties:
        expirationSeconds:
          type: integer
          format: int64
          description: Order expiration time in seconds, at least 360.
          minimum: 360
        description:
          type: string
          description: Text explanation of expiration.
          maxLength: 120
          minLength: 0
      required:
      - description
      - expirationSeconds
      title: InteractiveOrderDetailsOrderExpiration
    a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile:
      type: object
      properties:
        id:
          type: string
          description: File ID.
          example: 65f0b3d7c8b6a00001a2b3c4
        name:
          type: string
          description: File name.
          example: example-audio.wav
        fileFormat:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat'
        size:
          type: integer
          format: int64
          description: File size in bytes.
          example: 292190
        creationTime:
          type: string
          format: date-time
          description: File creation time.
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
          example: 3
        startTime:
          type: string
          format: date-time
          description: Date and time when the recording started.
        endTime:
          type: string
          format: date-time
          description: Date and time when the recording ended.
        location:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingFileLocation'
        sftpUploadStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SftpUploadStatus'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
      required:
      - fileFormat
      - name
      title: PublicRecordingFile
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonValidationError:
      type: object
      description: Errors found during validation of the uploaded file.
      properties:
        error:
          type: string
          description: Error.
          example: INVALID_PROPERTY
        errorType:
          type: string
          description: Error type.
          example: JSON_SCHEMA_ERROR
        message:
          type: string
          description: Message.
          example: The property "initial-text" cannot be specified at "$root/screens/0/layout/children/2/children/0".
        lineStart:
          type: integer
          format: int32
          description: Line that mark beginning of error.
          example: 46
        lineEnd:
          type: integer
          format: int32
          description: Line that mark end of error.
          example: 46
        columnStart:
          type: integer
          format: int32
          description: Column that mark beginning of error.
          example: 17
        columnEnd:
          type: integer
          format: int32
          description: Column that mark end of error.
          example: 30
      title: AddFlowJsonValidationError
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.DeliveryReport:
      type: object
      description: Collection of reports.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          type: string
          description: The message destination address.
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.).
        messageCount:
          type: integer
          format: int32
          description: The number of sent message segments.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        price:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price'
        status:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status'
        error:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Error'
        channel:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel'
        callbackData:
          type: string
        contact:
          $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact'
      title: DeliveryReport
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo:
      type: object
      properties:
        to:
          type: string
          description: The destination address of the message.
          example: '385977666618'
        messageCount:
          type: integer
          format: int32
          description: Number of messages required to deliver.
          example: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. If not passed, it will be automatically generated and returned in a response.
          example: 06df139a-7eb5-4a6e-902e-40e892210455
        status:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageStatus'
      title: SingleMessageInfo
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateBody:
      type: object
      description: Template body containing the actual message text for a specific language.
      properties:
        language:
          $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateLang'
        template:
          type: string
          description: Template message text with optional placeholders for variables (e.g., {{1}}, {{2}}). Maximum 875 characters. Last word in the template text cannot be a placeholder.
          example: Your order {{orderId}} has been confirmed.
          maxLength: 875
          minLength: 1
      required:
      - language
      - template
      title: TemplateBody
    87fdb606ad2c440ed89e04f515deb90150ccd79b7e43f8b50549f5895d6c3429.CallsConfigurationResponse:
      type: object
      properties:
        id:
          type: string
          description: Calls configuration ID.
        name:
          type: string
          description: Calls configuration name.
      title: CallsConfigurationResponse
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkServiceAddressPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: SipTrunkServiceAddressPage
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform'
        validityPeriod:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        regional:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RegionalOptions'
        flash:
          type: boolean
          description: Allows for sending a [flash SMS](https://www.infobip.com/docs/sms/message-types#flash-sms) to automatically appear on recipient devices without interaction. Set to `true` to enable flash SMS, or leave the default value, `false` to send a standard SMS.
      title: SmsMessageOptions
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber:
      type: object
      properties:
        testNumber:
          type: string
          description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when test number has been updated last time.
        primary:
          type: boolean
          description: Set this test number as primary for this sender. A test number can only be primary for one sender, although a sender may have multiple numbers marked as primary; selecting it here will remove the primary flag from any sender where it is already marked as such. Relevant when multiple senders share the same Application and Entity via Resource Association.
      required:
      - primary
      - status
      - testNumber
      - updatedAt
      title: RcsTestNumber
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint:
      type: object
      description: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
      discriminator:
        propertyName: type
        mapping:
          PHONE: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneEndpoint'
          SIP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipEndpoint'
          WEBRTC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRtcEndpoint'
          VIBER: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ViberEndpoint'
          WHATSAPP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppEndpoint'
          WEBSOCKET: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebsocketEndpoint'
      example:
        phoneNumber: '41792030000'
        type: PHONE
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpointType'
      title: CallEndpoint
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo:
      type: object
      description: Information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendRequest:
      type: object
      properties:
        from:
          type: string
          description: Message sender.
          example: myRcsSender
        to:
          type: string
          description: Message destination.
          example: '385977666618'
        validityPeriod:
          type: integer
          format: int32
          description: Message validity period.
          example: 15
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent'
        smsFailover:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest'
        notifyUrl:
          type: string
          description: The URL on your call back server on which the Delivery report will be sent.
        callbackData:
          type: string
          description: Custom client data that will be included in Delivery Report.
        messageId:
          type: string
          description: MessageId data that will be included in Delivery Report.
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      required:
      - content
      - to
      title: RcsSendRequest
    2d9ba0ce97cbc02fae57e41d1bc0e149a861cca6355f94de8d80841221b66e06.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfoPageResponse:
      type: object
      description: Suppression get response.
      properties:
        results:
          type: array
          description: Suppressed addresses for requested paging information.
          items:
            $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfo'
        paging:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiPageDetails'
      required:
      - paging
      - results
      title: SuppressionInfoPageResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentUploadReference:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers.
          writeOnly: true
        uploadedContentId:
          type: string
          description: ID of previously uploaded binary content.
          externalDocs:
            description: Upload binary content.
            url: https://www.infobip.com/docs/api/channels/mms/upload-binary
          writeOnly: true
      title: Uploaded reference segment
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SouthKoreaOptions'
      title: RegionalOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlType:
      type: string
      description: Type of the url. Can be `HOME` or `WORK`.
      enum:
      - HOME
      - WORK
      title: UrlType
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvent:
      type: object
      description: Collection of typing indicator events.
      properties:
        sender:
          type: string
          description: Number which sent the event.
          example: '441134960001'
        to:
          type: string
          description: Sender provided during the activation process.
          example: DemoSender
        receivedAt:
          type: string
          description: 'Date and time when Infobip received the event. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: 2025-02-06T15:35:12.123+0000
        event:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventContent'
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      required:
      - event
      - receivedAt
      - sender
      - to
      title: RcsIsTypingEvent
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ImageContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        text:
          type: string
          description: Text to be displayed alongside the image. It is required when sending a message with a button and an image.
          maxLength: 1000
          minLength: 1
        mediaUrl:
          type: string
          description: 'URL of the image being sent. Must be a valid URL starting with https:// or http://. Supported image types are .jpg, .jpeg, .png.Recommended resolution: 800 px x 800 px.'
        button:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction'
      required:
      - mediaUrl
      title: ImageContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceOptions:
      type: object
      properties:
        name:
          type: string
          description: Name of the voice in which the text would be synthesized. The parameter can be constructed using variables.
        gender:
          type: string
          description: Gender in which the text would be synthesized. The parameter can be constructed using variables.
      title: VoiceOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Provider:
      type: string
      default: AZURE
      description: Speech-to-text provider to use. Defaults to `AZURE`.
      enum:
      - GOOGLE
      - AZURE
      - DEEPGRAM
      title: Provider
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Status:
      type: object
      description: Indicates whether the initiated email has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        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.
        action:
          type: string
          description: Action name.
      title: Status
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMmsFailover:
      type: object
      description: Failover MMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        validityPeriod:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundContent'
      required:
      - content
      title: RcsMmsFailover
    ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.MmsAdvancedRequest:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients via a single API request. If not provided, it will be autogenerated and returned in the API response. Typically, used to fetch [delivery reports](https://www.infobip.com/docs/api/channels/mms/receive-outbound-mms-message-report).
        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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessage'
      required:
      - messages
      title: MmsAdvancedRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
          maxLength: 64
          minLength: 0
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        networkId:
          type: integer
          format: int32
          description: Available in US and Canada only if networkId is known for Network Operator of the destination. Returned in [SMS message delivery reports](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports) and [Inbound SMS](https://www.infobip.com/docs/api/channels/sms/sms-messaging/inbound-sms); contact Infobip Support to enable.
      required:
      - to
      title: Destination
    7c9f96abfad3f4dcf2c0a97ec8d627a73c6fe4ecaf776deaddf2ab2888baddbf.InstagramDmRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessage'
        options:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessageRequestOptions'
      required:
      - messages
      title: InstagramDmRequest
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallRequest:
      type: object
      description: Call request list.
      minLength: 1
      properties:
        externalId:
          type: string
          description: Custom ID assigned by the client.
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint'
      required:
      - endpoint
      title: BulkCallRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductTextHeaderContent'
      properties:
        type:
          type: string
          description: Type of the header content. Select the type from the dropdown to view its parameters.
      required:
      - type
      title: InteractiveMultiProductHeaderContent
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTextContent'
          IMAGE: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundImageContent'
          TEMPLATE: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundTransactionalTemplateContent'
          FILE: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundFileContent'
          VIDEO: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundVideoContent'
          LIST: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundListContent'
          CAROUSEL: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundCarouselContent'
      properties:
        type:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberOutboundContentType'
      required:
      - type
      title: ViberOutboundContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.LogsResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of logs.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Log'
      title: LogsResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UploadBinaryResult:
      type: object
      properties:
        uploadedContentId:
          type: string
          description: The ID that uniquely identifies the uploaded content.
          example: B44419205B27012D82F3BAD7B7EB37BAC884DBC91685390C3232D2191DC9D5EAF32F119D3530679F9B251AB689B4A60D7C2EB5A5EBB75C305367140D512E6B5D04200E7FFA5E84EAF37590C33F22B973514126755981CB170D86A7506CB38265280478A5B4EF2A7D11E9F24F286E7E315DFB1FF9BFEE08E036584074A1B76F097D9EC77E3FDD0FCC08362243E306F99F
      title: UploadBinaryResult
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: DocumentMessage
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: IP pool identifier.
        name:
          type: string
          description: IP pool name.
        ips:
          type: array
          description: Dedicated IPs assigned to the provided IP pool.
          items:
            $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpResponse'
          minItems: 0
          uniqueItems: true
      required:
      - id
      - ips
      - name
      title: IpPoolDetailResponse
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContentType:
      type: string
      enum:
      - TEXT
      - TYPING_INDICATOR
      - LIST_PICKER_RESPONSE
      - TIME_PICKER_RESPONSE
      - AUTHENTICATION_RESPONSE
      - APPLE_PAY_RESPONSE
      - CUSTOM_INTERACTIVE_RESPONSE
      - CLOSE_CONVERSATION
      - QUICK_REPLY
      - FORM_RESPONSE
      - INVITATION_RESPONSE
      - ROADSIDE_ASSISTANCE
      title: AppleMfbInboundContentType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailContent:
      type: object
      description: Array of emails information.
      properties:
        email:
          type: string
          description: Contact's email.
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.EmailType'
      title: EmailContent
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpPoolAssignApiRequest:
      type: object
      properties:
        poolId:
          type: string
          description: IP pool identifier.
        priority:
          type: integer
          format: int32
          description: IP pool sending priority.
          maximum: 49
          minimum: 0
      required:
      - poolId
      - priority
      title: DomainIpPoolAssignApiRequest
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateRequest:
      type: object
      description: Request to create or register a new Viber message template.
      properties:
        category:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateCategory'
        body:
          type: array
          description: List of template bodies per language. Currently limited to one body per template.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody'
          maxItems: 1
          minItems: 0
        params:
          type: array
          description: List of variable parameters used in the template. Maximum 8 parameters allowed. For OTP category, at least one parameter with name '{{pin}}' is required.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam'
          maxItems: 8
          maxLength: 8
          minItems: 0
      required:
      - body
      - category
      title: TemplateRequest
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.EditPlatformParametersApiRequest:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - platform
      title: EditPlatformParametersApiRequest
    ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkRequest:
      type: object
      description: Enable calls between users that have an Infobip account and users that don't.
      properties:
        identity:
          type: string
          description: Identity of a user that will use a call link. Must not be set if the destination type of a call link is ROOM.
          pattern: ^[\p{L}\p{N}\-_+=/.]{3,64}$
        displayName:
          type: string
          description: Display name of a user that will use a call link to initiate a call. Must not be set if the destination type of a call link is ROOM. For other destination types, if you want to set a display name, also set identity.
        showIdentity:
          type: boolean
          default: true
          description: Show identity or displayName on before a call.
        destination:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Destination'
        customData:
          type: object
          additionalProperties:
            type: string
            description: Custom attributes sent in a call once it has started.
          description: Custom attributes sent in a call once it has started.
        validityWindow:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ValidityWindow'
        callLinkConfigId:
          type: string
          description: Identifier of a call link configuration. You can use your existing configuration. If this parameter is not sent and there are call link configurations available, the default one will be used. If there are no configurations, the one with system default values will be used.
      required:
      - destination
      title: CallLinkRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentSmil:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters. Using other characters (e.g. spaces) may cause your message to be rejected by some mobile carriers.
          writeOnly: true
        contentType:
          type: string
          description: Content type for media, for example `application/smil`.
          writeOnly: true
        smil:
          type: string
          description: Message segment as SMIL format. Be aware that some devices and/or operating systems ignore SMIL, so there is no guarantee that segments will be displayed as specified in SMIL format.
          writeOnly: true
      required:
      - contentType
      title: SMIL segment
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction'
      required:
      - action
      - body
      title: InteractiveMediaCarouselContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderStatus:
      type: string
      description: Status of the order.
      enum:
      - PENDING
      - PROCESSING
      - PARTIALLY_SHIPPED
      - SHIPPED
      - COMPLETED
      - CANCELED
      title: OrderStatus
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AudioContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        mediaUrl:
          type: string
          description: URL of an audio sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported audio types are `AAC`, `AMR`, `MP3`, `MP4`, `OPUS`. Maximum audio size is 16MB.
          maxLength: 2048
          minLength: 1
        voice:
          type: boolean
          description: When set to true, the audio message is displayed as a voice note. Voice notes require OGG format with OPUS codec. Maximum size is 16MB.
      required:
      - mediaUrl
      title: AudioContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultBcc:
      type: object
      allOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResult'
      - type: object
        properties:
          bcc:
            type: string
            description: The message destination address.
            example: '41793026729'
          messageId:
            type: string
            description: The ID that uniquely identifies the message sent.
            example: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
      required:
      - status
      title: Message result as bcc
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.UpdateFlowRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the flow.
          example: Flow new name
          maxLength: 200
          minLength: 1
        categories:
          type: array
          description: Categories of the flow.
          items:
            $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowCategory'
      title: UpdateFlowRequest
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingLocation:
      type: string
      enum:
      - SAO_PAULO
      - BOGOTA
      - FRANKFURT
      - JOHANNESBURG
      - JOHANNESBURG_1
      - NEW_YORK
      - PORTLAND
      - MOSCOW
      - SINGAPORE
      - ISTANBUL
      - KUALA_LUMPUR
      - JAKARTA
      - MUMBAI
      - HONG_KONG_1
      - HONG_KONG
      - RIYADH
      - CHENNAI
      title: RecordingLocation
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateUpdateEvent:
      type: object
      properties:
        name:
          type: string
          description: Name of the template being updated.
          example: demo_template
        templateStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TemplateStatus'
        comment:
          type: string
          description: Additional comment or notes about the update.
          example: Approved for testing
        updatedAt:
          type: string
          description: 'Template''s last update date and time. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: 2025-02-06T15:35:12.123+0000
      required:
      - comment
      - name
      - templateStatus
      - updatedAt
      title: TemplateUpdateEvent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStatus:
      type: object
      description: Indicates whether the email is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      properties:
        id:
          type: integer
          format: int32
          description: Status ID.
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          type: string
          description: Group name for the status.
        name:
          type: string
          description: Status name.
        description:
          type: string
          description: Human-readable description of the status.
      title: EmailStatus
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TextContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        text:
          type: string
          description: Content of the message being sent.
          maxLength: 4096
          minLength: 1
        previewUrl:
          type: boolean
          default: false
          description: Allows for URL preview from within the message. If set to `true`, the message content must contain a URL starting with `https://` or `http://` and the flag removeProtocol must be set to `false`.
      required:
      - text
      title: TextContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress:
      type: object
      description: Terms and conditions associated with the sender.
      properties:
        url:
          type: string
          description: A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        label:
          type: string
          description: Label for the URI. Currently accepted but not in use by RCS providers.
          maxLength: 25
          minLength: 1
      required:
      - url
      title: TermsWebAddress
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogSayRequest:
      type: object
      properties:
        text:
          type: string
          description: Text to read.
        language:
          type: string
          description: Text language. Must be defined for correct pronunciation. For more details on available languages and voices, see our [documentation](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast).
          enum:
          - ar
          - ar-ma
          - ar_xa
          - bg
          - bn
          - bn-in
          - ca
          - cmn-cn
          - cs
          - da
          - de
          - de-at
          - de-ch
          - el
          - en
          - en-au
          - en-ca
          - en-gb
          - en-gb-wls
          - en-ie
          - en-in
          - en-ph
          - es
          - es-419
          - es-ar
          - es-co
          - es-mx
          - es-us
          - et-ee
          - fi
          - fil-ph
          - fr
          - fr-ca
          - fr-ch
          - gu
          - he
          - hi
          - hr
          - hu
          - id
          - is
          - it
          - ja
          - kk-kz
          - kn
          - ko
          - lt
          - lv
          - ml
          - mr-in
          - ms
          - nb-no
          - nl
          - nl-be
          - 'no'
          - pa-in
          - pl
          - pt-br
          - pt-pt
          - ro
          - ru
          - sk
          - sl
          - sr-rs
          - sv
          - sw-ke
          - sw-tz
          - ta
          - te
          - th
          - tr
          - uk
          - ur-in
          - ur-pk
          - uz-uz
          - vi
          - wls
          - yue-hk
          - zh-cn
          - zh-tw
        speechRate:
          type: number
          format: double
          description: Speech rate. Must be within `[0.5 - 2.0]` range, default value is `1`.
        loopCount:
          type: integer
          format: int32
          description: Number of times to read the text.
        preferences:
          $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicVoicePreferences'
      required:
      - language
      - text
      title: DialogSayRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselAction:
      type: object
      description: Allows you to specify cards of the carousel.
      discriminator:
        propertyName: type
        mapping:
          QUICK_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.QuickReplyMediaCarouselAction'
          URL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlMediaCarouselAction'
      properties:
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MediaCarouselActionType'
      required:
      - type
      title: InteractiveMediaCarouselAction
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InboundMessageViberBotInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: ViberBotInboundResponse
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReport'
      title: DeliveryReports
    b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfig:
      type: object
      description: Call link configuration.
      properties:
        id:
          type: string
          description: Configuration ID. Once a call link is created, this value might be sent in the request as one specific call link configuration to be used by the call link.
        name:
          type: string
          description: Configuration name or description. It doesn't have to be unique.
        isDefault:
          type: boolean
          default: false
          description: 'When you create call link without callLinkConfigId, the one marked as default will be used. Only one configuration can be default.If you don''t have a configuration, the basic Infobip theme with default values and minimal options will be used.If you want to set another configuration as default, specify its value when adding or updating it. '
        initialOptions:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.InitialOptions'
        callOptions:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallOptions'
        theme:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Theme'
        subdomainId:
          type: string
          description: Id of the subdomain that will be set on every call link generated with this configuration. If undefined, call links will be generated without a subdomain.
        webhook:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Webhook'
      title: CallLinkConfig
    56fc13d85fd8c7d40ac0157103bb5ccebc0bb2862850603cc2c5a808276f4742.CredentialsBody:
      type: object
      properties:
        apiId:
          type: string
          description: The first part of the generate Authorization header.
          pattern: '[a-zA-Z0-9-]+'
        key:
          type: string
          description: Used to generate the second part of the Authorization header.
          pattern: '[a-zA-Z0-9-]+'
      required:
      - apiId
      - key
      title: CredentialsBody
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingRequest:
      type: object
      properties:
        recordingType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType'
        maxSilence:
          type: integer
          format: int32
          description: Silence duration, in seconds, before the recording stops. (If this field is set the recording can't be stopped by the [stop recording endpoint](#call-stop-recording).)
        beep:
          type: boolean
          default: false
          description: Flag indicating if a beep sound should be played before recording.
        maxDuration:
          type: integer
          format: int32
          description: Maximum recording duration in seconds.  (If this field is set the recording can't be stopped by the [stop recording endpoint](#call-stop-recording).)
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
        filePrefix:
          type: string
          description: 'Custom name for the recording''s zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).

            Using the same `filePrefix` will override the files on the SFTP server.'
      required:
      - recordingType
      title: RecordingRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DefaultMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.UrlOptions'
      title: DefaultMessageRequestOptions
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContentType:
      type: string
      enum:
      - LINE_NOTIFICATION
      title: LineOnOutboundContentType
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Type:
      type: string
      description: Type of the message content. Select the type from the dropbox to view their parameters.
      enum:
      - TEXT
      - IMAGE
      - DOCUMENT
      - STICKER
      - LOCATION
      - CONTACT
      - VIDEO
      - VOICE
      - AUDIO
      - BUTTON
      - INTERACTIVE_BUTTON_REPLY
      - INTERACTIVE_LIST_REPLY
      - INTERACTIVE_PAYMENT_CONFIRMATION
      - ORDER
      - UNSUPPORTED
      title: Type
    c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference:
      type: object
      properties:
        id:
          type: string
          description: Unique conference ID.
          example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
          maxLength: 128
        name:
          type: string
          description: Conference name, requested or autogenerated on creation.
          example: Example conference
        participants:
          type: array
          description: The list of conference participants.
          items:
            $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant'
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
          example: dc5942707c704551a00cd2ea
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
      title: Conference
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.Tracking:
      type: object
      description: Sets up tracking parameters to track conversion metrics and type. This is a legacy feature not compatible with the `tracking` feature in latest [Send SMS message](#channels/sms/send-sms-messages) API.
      properties:
        baseUrl:
          type: string
          description: Custom base URL for shortened links in messages when tracking URL conversions. Legacy - use `urlOptions` instead.
          writeOnly: true
        processKey:
          type: string
          description: The process key which uniquely identifies conversion tracking.
          writeOnly: true
        track:
          type: string
          description: 'Indicates if a message has to be tracked for conversion rates. Values are: `SMS` and `URL`. `URL` is a legacy value. Use `urlOptions` instead. For more details on SMS Conversion, see: [Track Conversion](https://www.infobip.com/docs/sms/api#track-conversion).'
          writeOnly: true
        type:
          type: string
          description: Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`.
          writeOnly: true
      title: Tracking
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.EventDetails:
      type: object
      description: Email platform event data.
      discriminator:
        propertyName: type
        mapping:
          HIGH_BOUNCE_RATE_WARNING: '#/components/schemas/ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.HighDomainBounceWarnEvent'
          HIGH_BOUNCE_RATE_BLOCKED: '#/components/schemas/ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.HighDomainBounceBlockEvent'
      properties:
        type:
          $ref: '#/components/schemas/ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.WebhookNotificationType'
      required:
      - type
      title: EventDetails
    450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.Type:
      type: string
      enum:
      - TEXT
      - FILE
      title: Type
    1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteOrderRequest:
      type: object
      description: Route request object.
      properties:
        order:
          type: integer
          format: int32
          description: Route order.
          minimum: 1
      required:
      - order
      title: RouteOrderRequest
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryDay'
        from:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime'
        to:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.FailoverDestinationPair:
      type: object
      description: The SMS failover destination matching.
      properties:
        initial:
          type: string
          description: The initial destination address specified in the request.
        failover:
          type: string
          description: 'The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)'
      required:
      - failover
      - initial
      title: FailoverDestinationPair
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.Platform'
        validityPeriod:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnSmsFailover'
      title: NonMsisdnMessageFailoverOptions
    1bf84e5ebfeebf0839825dcb3ba7bdfe29e9008eef02919c0c668629628db19e.OmniLogsResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of logs.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniLog'
          readOnly: true
      title: OmniLogsResponse
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType:
      type: string
      enum:
      - SEEN
      - TYPING_INDICATOR
      title: RcsOutboundEventContentType
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.FailoverDestinationPair:
      type: object
      description: The SMS failover destination matching.
      properties:
        initial:
          type: string
          description: The initial destination address specified in the request.
        failover:
          type: string
          description: 'The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)'
      required:
      - failover
      - initial
      title: FailoverDestinationPair
    329f726ae6e36d1a92786c502bebf028e5aa08cc32a3a8e9f0bed0d82dbc7157.AdvancedTtsApiRequest:
      type: object
      description: Advanced voice message request object.
      properties:
        bulkId:
          type: string
          description: The ID which uniquely identifies the request.
        messages:
          type: array
          description: Array of messages to be sent, one object per every message
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage'
      required:
      - messages
      title: AdvancedTtsApiRequest
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.FileContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        filename:
          type: string
          description: Name of the file being sent (file extension included).
          maxLength: 25
          minLength: 0
          pattern: .*\.(docx?|dotx?|xlsx?|f?ods|f?odt|rtf|odf|txt|info|pdf|xps|pdax|eps|csv|xlsm|xltx)$
        mediaUrl:
          type: string
          description: 'URL of the file being sent. Must be a valid URL starting with https:// or http://. Supported file types are .doc, .docx, .rtf, .dot, .dotx, .odt ,.odf, .fodt, .txt, .info, .pdf, .xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx. Maximum file size is 200 MB. '
      required:
      - filename
      - mediaUrl
      title: FileContent
    27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089.RingbackGeneration:
      type: object
      description: Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference participants, provided they are present before the remote ringback of the new participant starts.
      properties:
        enabled:
          type: boolean
          default: false
          description: Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`.
      title: RingbackGeneration
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.FailoverDestinationPair:
      type: object
      description: The SMS failover destination matching.
      properties:
        initial:
          type: string
          description: The initial destination address specified in the request.
        failover:
          type: string
          description: 'The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)'
      required:
      - failover
      - initial
      title: FailoverDestinationPair
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpointType:
      type: string
      enum:
      - PHONE
      - SIP
      - WEBRTC
      - VIBER
      - WHATSAPP
      - WEBSOCKET
      title: CallbackEndpointType
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message template validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      title: ValidityPeriodTimeUnit
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessage'
        options:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessageRequestOptions'
      required:
      - messages
      title: KakaoSangdamRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegmentLink:
      type: object
      properties:
        contentId:
          type: string
          description: Unique identifier within single message. `[a-zA-Z]` up to 20 characters.
        contentType:
          type: string
          description: Content type for media, for example 'image/png'.
        contentUrl:
          type: string
          description: URL of hosted content. URL will be available for 48 hours. If hosted externally (by client) make sure it is available for 48 hours
      title: Link segment
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Play:
      type: object
      description: Play action plays an audio file or stream to the caller.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - play
        content:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent'
        loopCount:
          type: integer
          format: int32
          description: Number of times to loop the content.
      required:
      - action
      - content
      title: Play
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SouthKoreaOptions'
      title: RegionalOptions
    a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType'
        url:
          type: string
          description: URL that leads to the video that end user saw and clicked.
          readOnly: false
          writeOnly: true
      title: ReferralMediaVideo
    999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.DeliveryInfo:
      type: object
      description: Delivery information about the bulk sending of messages.
      properties:
        rate:
          type: number
          description: Delivery rate. Ratio between total delivered and total sent messages in a specific bulk sending process.
        time:
          type: integer
          format: int64
          description: Delivery time.
      required:
      - rate
      - time
      title: DeliveryInfo
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogResponseLogViberOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.LogViberOutboundContent'
        cursor:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.CursorPageInfo'
      title: LogResponseLogViberOutboundContent
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppression:
      type: object
      description: Suppression.
      properties:
        domainName:
          type: string
          description: Domain name from which suppressions will be deleted.
        emailAddress:
          type: array
          description: Email addresses that need to be deleted.
          items:
            type: string
            description: Email addresses that need to be deleted.
          maxItems: 1000
          minItems: 1
        type:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiSuppressionType'
      required:
      - domainName
      - emailAddress
      - type
      title: DeleteSuppression
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaInlineImage:
      type: object
      description: Allows for inserting an image file inside the HTML code of the email by using `cid:FILENAME` instead of providing an external link to the image.
      discriminator:
        propertyName: type
        mapping:
          uploadedReference: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaUploadedReference'
          binary: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaBinaryImage'
      properties:
        type:
          type: string
      required:
      - type
      title: EmailMediaInlineImage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.PhoneType:
      type: string
      description: Type of the phone number. Can be `CELL`, `MAIN`, `IPHONE`, `HOME` or `WORK`.
      enum:
      - CELL
      - MAIN
      - IPHONE
      - HOME
      - WORK
      title: PhoneType
    a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest:
      type: object
      properties:
        from:
          type: string
          description: Message sender.
          example: myRcsSender
        to:
          type: string
          description: Message destination.
          example: '385977666618'
        validityPeriod:
          type: integer
          format: int32
          description: Message validity period.
          example: 15
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TemplateRcsApiMtContent'
        smsFailover:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SmsFailoverRequest'
        notifyUrl:
          type: string
          description: The URL on your call back server on which the Delivery report will be sent.
        callbackData:
          type: string
          description: Custom client data that will be included in Delivery Report.
        messageId:
          type: string
          description: MessageId data that will be included in Delivery Report.
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      required:
      - content
      - to
      title: RcsSendTemplateRequest
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.SimpleReport:
      allOf:
      - $ref: '#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.IntegrationType'
      - properties:
          message:
            type: object
            properties:
              type:
                type: string
                description: Message type.
                enum:
                - TEXT
                readOnly: false
                writeOnly: true
              text:
                type: string
                description: Incoming message text.
                readOnly: false
                writeOnly: true
      - $ref: '#/components/schemas/32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.MoReportBase'
      title: SimpleReport
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventContent:
      type: object
      description: Event content.
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventType'
      required:
      - type
      title: RcsIsTypingEventContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.SouthKoreaOptions'
      title: RegionalOptions
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushBulkResponse:
      type: object
      description: Array of push bulk responses
      properties:
        to:
          type: object
          additionalProperties:
            type: object
          description: Recipient destination address.
        status:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushStatusResponse'
        messageCount:
          type: integer
          format: int64
          description: Number of recipients for targeted segment.
        bulkId:
          type: string
          description: The ID which uniquely identifies the request.
      required:
      - bulkId
      - messageCount
      - status
      - to
      title: PushBulkResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status:
      type: object
      description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery, or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          example: 1
        groupName:
          type: string
          description: Status group name.
          example: PENDING
        id:
          type: integer
          format: int32
          description: Status ID.
          example: 26
        name:
          type: string
          description: Status name.
          example: PENDING_ACCEPTED
        description:
          type: string
          description: Status description.
          example: Message accepted, pending for delivery.
      required:
      - description
      - groupId
      - groupName
      - id
      - name
      title: Status
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover:
      type: object
      description: SMS message to be sent if the Viber message could not be delivered.
      properties:
        from:
          type: string
          description: SMS sender number. Must be in international format.
          maxLength: 24
          minLength: 1
        text:
          type: string
          description: Content of the SMS that will be sent.
          maxLength: 4096
          minLength: 1
        validityPeriod:
          type: integer
          format: int32
          description: Message failover validity period. Required, if 'validityPeriodTimeUnit' is set. Validity period must be between 30 seconds and 2 days.
          example: 15
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit'
      required:
      - from
      - text
      title: SmsFailover
    73f6910bb0f0a3f1f6a9e6796ff94e4b37e388cd86d56d7e974197854e7020f7.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price:
      type: object
      description: Sent voice message price.
      properties:
        pricePerSecond:
          type: number
          description: Price per one second of the voice message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpApiPool:
      type: object
      description: IP pools assigned to the domain. Assigned IP pools with the lowest priority value have the highest sending precedence.
      properties:
        id:
          type: string
          description: IP pool identifier.
        name:
          type: string
          description: IP pool name.
        priority:
          type: integer
          format: int32
          description: IP pool sending priority. Higher value will result in a lower sending precedence for the specified IP pool.
          maximum: 49
          minimum: 0
        ips:
          type: array
          items:
            $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpResponse'
          minItems: 0
          uniqueItems: true
      required:
      - id
      - ips
      - name
      - priority
      title: DomainIpApiPool
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique ID of an image.
        name:
          type: string
          description: Image name.
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ImageType'
        size:
          type: integer
          format: int64
          description: Image size in bytes.
      title: ImageResponse
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DeliveryReport'
      title: DeliveryReports
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Layout:
      type: string
      default: '[GRID]'
      description: Represents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID.
      enum:
      - SOLO
      - GRID
      title: Layout
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenStatusReporting:
      type: object
      description: Provides options for configuring the seen report behavior.
      properties:
        url:
          type: string
          description: The URL on your call back server where a seen report will be sent.
      title: SeenStatusReporting
    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
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeneralStatus:
      type: string
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - REJECTED
      - EXPIRED
      title: GeneralStatus
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.VideoMediaProperties:
      type: object
      description: Video media properties.
      properties:
        camera:
          type: boolean
          description: Indicates whether there is a video feed.
        screenShare:
          type: boolean
          description: Indicates whether the end user is sharing their screen.
        blind:
          type: boolean
          description: Indicates whether the end user can receive remote videos.
      title: VideoMediaProperties
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryDay'
        from:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime'
        to:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    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
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceComposition:
      type: object
      properties:
        enabled:
          type: boolean
          default: false
          description: 'Indicates whether to create a single recording of all participants. If set to `True`, all

            participants are merged into a single audio or video file. Otherwise, all participants will have their

            own individual audio or video file.'
      title: ConferenceComposition
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateBody:
      type: object
      description: Template body containing the actual message text for a specific language.
      properties:
        language:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateLang'
        template:
          type: string
          description: Template message text with optional placeholders for variables (e.g., {{1}}, {{2}}). Maximum 1000 characters. Last word in the template text cannot be a placeholder.
          example: Your order {{orderId}} has been confirmed.
          maxLength: 1000
          minLength: 1
      required:
      - language
      - template
      title: TemplateBody
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvents:
      type: object
      properties:
        results:
          type: array
          description: Collection of typing indicator events.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEvent'
        eventCount:
          type: integer
          format: int32
          description: The number of events returned in the results array.
          example: 1
        pendingEventCount:
          type: integer
          format: int32
          description: The number of events that have not been pulled in.
          example: 42
      required:
      - eventCount
      - pendingEventCount
      - results
      title: RcsIsTypingEvents
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportRequest:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloReportSingle'
      required:
      - results
      title: ZaloReportRequest
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserData:
      type: object
      description: Data about the user who sent the message.
      properties:
        cdpPersonId:
          type: integer
          format: int64
          description: Internal person ID in People.
        userIdentity:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentity'
      required:
      - cdpPersonId
      title: LiveChatInboundUserData
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RequestSchedulingSettings'
      title: KakaoSangdamMessageRequestOptions
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1ButtonApiData:
      type: object
      description: Template buttons. Can be either up to 3 `quick reply` buttons or up to 2 `call to action` buttons. Call to action buttons must be unique in type.
      discriminator:
        propertyName: type
        mapping:
          PHONE_NUMBER: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1PhoneNumberButtonApiData'
          URL: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1UrlButtonApiData'
          QUICK_REPLY: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.V1QuickReplyButtonApiData'
      properties:
        text:
          type: string
          description: Button text.
          maxLength: 25
          minLength: 0
        type:
          type: string
          enum:
          - PHONE_NUMBER
          - URL
          - QUICK_REPLY
      required:
      - text
      title: V1ButtonApiData
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDomainResponse:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Domain identifier.
          minimum: 1
        name:
          type: string
          description: Domain name.
        pools:
          type: array
          items:
            $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DomainIpApiPool'
          minItems: 0
          uniqueItems: true
      required:
      - id
      - name
      - pools
      title: IpDomainResponse
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationCc:
      type: object
      properties:
        cc:
          type: string
          description: Message destination address, carbon copy.
          example: '41793026999'
      title: Destination as Cc
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.StatusReason:
      type: string
      description: '[The status](https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes) of RCS capability check request for the specified phone number.'
      enum:
      - PENDING_TIME_VIOLATION
      - DELIVERED_TO_OPERATOR
      - PENDING_WAITING_DELIVERY
      - UNDELIVERABLE_REJECTED_OPERATOR
      - DELIVERED_TO_HANDSET
      - REJECTED_NETWORK
      - PENDING_ENROUTE
      - REJECTED_PREFIX_MISSING
      - UNDELIVERABLE_NOT_DELIVERED
      - REJECTED_DND
      - REJECTED_SOURCE
      - REJECTED_NOT_ENOUGH_CREDITS
      - REJECTED_SENDER
      - REJECTED_DESTINATION
      - EXPIRED_EXPIRED
      - REJECTED_NOT_REACHABLE
      - REJECTED_PREPAID_PACKAGE_EXPIRED
      - REJECTED_DESTINATION_NOT_REGISTERED
      - REJECTED_ROUTE_NOT_AVAILABLE
      - REJECTED_FLOODING_FILTER
      - REJECTED_SYSTEM_ERROR
      - EXPIRED_UNKNOWN
      - REJECTED_DUPLICATE_MESSAGE_ID
      - REJECTED_INVALID_UDH
      - REJECTED_MESSAGE_TOO_LONG
      - REJECTED_NOT_SENT
      - EXPIRED_DLR_UNKNOWN
      - MO_DELIVERED
      - UNDELIVERABLE_NOT_SENT
      - MISSING_TO
      - INVALID_DESTINATION_ADDRESS
      - CONCATENATED_MESSAGE_TOO_LONG
      - REJECTED_MONTHLY_LIMIT_REACHED
      - REJECTED_SMPP_SESSION_CLOSED
      - INVALID_SUBACCOUNT_NAME
      - REJECTED_GATEWAY_DATA_TOO_LONG
      - INVALID_COMPANY_ID
      - REJECTED_INVALID_TRACKING_DATA
      - REJECTED_INVALID_COUNT
      - REJECTED_FREE_TRIAL_EXCEEDED
      - REJECTED_SUBSCRIPTION_PLAN_NOT_ACTIVE
      - SIM_SWAP_DETECTED
      - DEACTIVATED_LIST
      - INVALID_CLIENT_NETWORK
      - CURRENCY_CHANGE_IN_PROGRESS
      - REJECTED_UNREACHABLE_DESTINATION
      - SIGNALS_BLOCKED
      - VOLUMETRIC_BLOCKED
      - REJECTED_BLOCKED_TEMPLATE
      - REJECTED_INVALID_PLATFORM_PARAMETERS
      - REJECTED_SHORT_DOMAIN_NOT_VERIFIED
      - REJECTED_10DLC_LIMIT_REACHED
      - REJECTED_INVALID_BYO_EXTERNAL_ID
      title: StatusReason
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMediaCarouselContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveMediaCarouselMessage
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform'
        validityPeriod:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultSmsFailover'
        trackingData:
          type: string
          description: Custom client's data that will be passed back with user's reply. It is not supported for `TEMPLATE` or when `toPrimaryDeviceOnly` option is enabled for text only and image only content types or when `activationCheck` option is enabled for text only content type.
          maxLength: 100
          minLength: 1
        label:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label'
        applySessionRate:
          type: boolean
          description: Defines if the message should be charged using Viber's session rate if applicable. The session rate is supported for text only, image only and `FILE` content types. For text only content type `sessionRate` won't be applied when `toPrimaryDeviceOnly` or `activationCheck` option is enabled. For image only content type `sessionRate` won't be applied when `toPrimaryDeviceOnly` option is enabled.
        toPrimaryDeviceOnly:
          type: boolean
          description: Defines if the message should be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet). Primary device concept is supported for text only, image only, `FILE` content type. For text only `toPrimaryDeviceOnly` won't be applied when `activationCheck` option is enabled.
        activationCheck:
          type: boolean
          description: Enables activation check for sensitive messages. When true, validates that the user has not recently activated Viber on any device. If validation passes message will be sent only to the end user's [primary device](https://www.infobip.com/docs/viber/business-messages/api) (phone or tablet). Supported for text only content type. This feature must be enabled for the sender beforehand. Please contact support to arrange activation.
      title: ViberMessageOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SendingSpeedLimit'
      title: RequestSchedulingSettings
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WaitForEom:
      type: string
      description: Indicates whether end of the message detection is enabled for the call. `ALWAYS` specifies that after detection of `MACHINE` the script will always wait for the end of the message before executing actions defined in `onMachineDetected`. `NEVER` specifies that after detection of `MACHINE` actions defined in `onMachineDetected` will be executed immediately. `ON_DETECTING` specifies that end of the message will be respected as long as actions in `onDetecting` are in progress, once these actions finish the script jumps to `onMachineDetected` section immediately.
      enum:
      - ALWAYS
      - NEVER
      - ON_DETECTING
      title: WaitForEom
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SayOptions:
      type: object
      properties:
        language:
          type: string
          description: Must be defined for correct pronunciation. The parameter can be constructed using variables.
        voice:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceOptions'
        speechRate:
          type: number
          format: double
          description: Must be within [0.5 - 2.0] range, default value is 1.
          maximum: 2
          minimum: 0.5
      title: SayOptions
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateStatus:
      type: string
      description: Current approval status of the template in the review process.
      enum:
      - PENDING
      - APPROVED
      - DECLINED
      example: APPROVED
      title: TemplateStatus
    6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingApplication:
      type: object
      description: Recording application metadata
      discriminator:
        propertyName: type
        mapping:
          CALL_ROUTING: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallRoutingApplication'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationType'
      required:
      - type
      title: RecordingApplication
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    31756dca18d13ab491063defb0eba5e91f72bccd700f710f44794c6f1df9c9ea.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTimeWindow:
      type: object
      description: 'Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days property is mandatory. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. Note: delivery time window is set in UTC timezone.'
      properties:
        days:
          type: array
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryDay'
          uniqueItems: true
        from:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime'
        to:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime'
      required:
      - from
      - to
      title: DeliveryTimeWindow
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberImageMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered Viber Sender name.
          maxLength: 20
          minLength: 2
        to:
          type: string
          description: 'Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).'
          pattern: ^[0-9]{1,15}$
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 50
          minLength: 1
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ImageContent'
        callbackData:
          type: string
          description: Custom client's data that will be included in Delivery Report.
          maxLength: 4000
          minLength: 1
        trackingData:
          type: string
          description: Custom client's data that will be passed back with user's reply.
          maxLength: 100
          minLength: 1
        applySessionRate:
          type: boolean
          description: Defines if the message should be charged using Viber's session rate if applicable.
        label:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label'
        smsFailover:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover'
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
      required:
      - content
      - from
      - to
      title: ViberImageMessage
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Base64EncodedFile:
      type: object
      properties:
        contentType:
          type: string
          description: Content type of the file.
          example: application/pdf
        fileName:
          type: string
          description: Name of the file.
          example: attachment.pdf
        data:
          type: string
          description: Base64 encoded file data.
          example: base64encodeddata
      required:
      - contentType
      - data
      - fileName
      title: Base64EncodedFile
    394de68b2af4916e47f48a4cc3026c2ec4c22342d1304c00a584d14a92a333c1.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkStatusResponse:
      type: object
      properties:
        adminStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus'
      title: SipTrunkStatusResponse
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RescheduleRequest:
      type: object
      properties:
        startTime:
          type: string
          format: date-time
          description: Rescheduled start time.
      required:
      - startTime
      title: RescheduleRequest
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryDay'
        from:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryTime'
        to:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientInfo:
      type: object
      description: Recipient information such as device type, OS, device name.
      properties:
        deviceType:
          type: string
          description: The type of device used by the recipient to do the user action.
        os:
          type: string
          description: The type OS present in the device used by the recipient.
        deviceName:
          type: string
          description: Device name of the action originating device.
      title: RecipientInfo
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TransliterationCode:
      type: string
      description: Conversion of a message text from one script to another.
      enum:
      - NONE
      - ALL
      - BALTIC
      - CENTRAL_EUROPEAN
      - COLOMBIAN
      - CYRILLIC
      - GREEK
      - NON_UNICODE
      - PORTUGUESE
      - SERBIAN_CYRILLIC
      - TURKISH
      - BULGARIAN_CYRILLIC
      title: TransliterationCode
      writeOnly: true
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkItem:
      type: object
      description: Bulk item list.
      minLength: 1
      properties:
        from:
          type: string
          description: Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
        callRequests:
          type: array
          description: Call request list.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCallRequest'
          minLength: 1
        recording:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest'
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Maximum call duration in seconds. Once exceeded, the call terminates automatically.
        connectTimeout:
          type: integer
          format: int32
          description: Time to wait, in seconds, before the called party answers the call. Once exceeded, the call terminates automatically.
          maximum: 60
        callRate:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRate'
        validityPeriod:
          type: integer
          format: int32
          description: The call validity period in minutes. Once expired, the call is not established.
        retryOptions:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RetryOptions'
        schedulingOptions:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SchedulingOptions'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Client-defined, bulk-level custom data.
      required:
      - callRequests
      title: BulkItem
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.GeoLocationInfoWrapper:
      type: object
      description: Geolocation data such as Country and City.
      properties:
        countryName:
          type: string
          description: Country where the user action is recorded.
        city:
          type: string
          description: City where the user action is recorded.
      title: GeoLocationInfoWrapper
    c5d63eb36983d8ea1e54e74166c0e08ea636cff38a55aa9570bd7ba615a520a0.RouteSimulatorRequest:
      type: object
      description: Route simulator request object.
      properties:
        to:
          type: string
          description: 'Phone number or regular expression pattern representing the phone number. Applies to all simulator endpoint types except `WEBRTC`. Examples: `41793026727`, `41793(.+)`.'
        useDisabledRoutes:
          type: boolean
          description: If set to `true`, the simulator will use disabled routes for simulation. If set to `false`, only enabled routes will be used.
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint'
      required:
      - endpoint
      - to
      title: RouteSimulatorRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResult:
      type: object
      description: The result of the RCS capability check for the specified phone numbers.
      properties:
        messageId:
          type: string
          description: A unique message ID. This ID is automatically generated and will be included in the API response.
        phoneNumber:
          type: string
          description: The recipient's phone number that was checked for RCS capability.
        code:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResponseCodeV2'
      required:
      - code
      - messageId
      - phoneNumber
      title: CapabilityCheckSyncResult
      xml:
        name: CapabilityCheckSyncResult
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateUpdatePushEvent:
      type: object
      properties:
        messageTemplateId:
          type: string
          description: Template ID.
          example: '111'
        messageTemplateName:
          type: string
          description: Name of the template.
          example: template_name
        messageTemplateLanguage:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language'
        timestamp:
          type: string
          format: date-time
          description: 'Date and time when event occurred. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        change:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatePushEventChange'
        entityId:
          type: integer
          format: int64
          description: Entity ID.
          example: 123456
        applicationId:
          type: integer
          format: int64
          description: Application ID.
          example: 1234567
      required:
      - change
      - messageTemplateId
      - messageTemplateLanguage
      - messageTemplateName
      - timestamp
      title: TemplateUpdatePushEvent
    0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.StatusResponse:
      type: object
      title: StatusResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageResponseDetails:
      type: object
      description: Other details of the message.
      properties:
        messageCount:
          type: integer
          format: int32
          description: Number of SMS message parts required to deliver the message.
      title: SmsMessageResponseDetails
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageContent:
      type: object
      description: Content of the message.
      properties:
        body:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageBody'
      required:
      - body
      title: OpenChannelMessageContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundContent:
      type: object
      description: Message content.
      properties:
        title:
          type: string
          description: Message title.
          maxLength: 66
          minLength: 0
        messageSegments:
          type: array
          description: Content of the message being sent.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegment'
      required:
      - messageSegments
      title: MmsOutboundContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Url:
      type: object
      description: Url information.
      properties:
        url:
          type: string
          description: Url of a contact.
          writeOnly: true
        type:
          type: string
          description: Type of a url. Can be HOME, WORK.
          writeOnly: true
      title: Url
      writeOnly: true
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationRequest:
      type: object
      properties:
        name:
          type: string
          description: Optional. Name describing the push configuration.
        ios:
          $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.IosPushNotificationConfig'
        android:
          $ref: '#/components/schemas/4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.AndroidPushNotificationConfig'
      title: PushConfigurationRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Price:
      type: object
      description: Sent SMS price.
      properties:
        pricePerMessage:
          type: number
          format: double
          description: Price per one SMS.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          example: 1
        groupName:
          type: string
          description: Status group name.
          example: PENDING
        id:
          type: integer
          format: int32
          description: Status ID.
          example: 7
        name:
          type: string
          description: Status name.
          example: PENDING_ENROUTE
        description:
          type: string
          description: Human-readable description of the status.
          example: Message sent to next instance
        action:
          type: string
          description: Action that should be taken to eliminate the error.
      title: SingleMessageStatus
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AudienceUsersResponse:
      type: object
      properties:
        audienceId:
          type: string
          description: Meta custom audience ID.
          example: '52512562968362'
        numReceived:
          type: integer
          format: int32
          description: Number of entries received.
          example: 1
        numInvalidEntries:
          type: integer
          format: int32
          description: Number of invalid entries.
          example: 0
        subscriptionInfo:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.SubscriptionInfo'
      title: AudienceUsersResponse
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationsResponse:
      type: object
      properties:
        configurations:
          type: array
          description: List of configurations.
          items:
            $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ConfigurationResponse'
      required:
      - configurations
      title: ConfigurationsResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkCall:
      type: object
      description: Bulk call list.
      properties:
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        callId:
          type: string
          description: Unique call ID.
          maxLength: 128
        externalId:
          type: string
          description: Client-defined call ID.
        from:
          type: string
          description: Caller identifier.
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint'
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus'
        reason:
          type: string
          description: Failure reason in human-readable format.
      title: BulkCall
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionType:
      type: string
      description: Type of the conversion. Can be `PURCHASE` or `LEAD_SUBMITTED`.
      enum:
      - PURCHASE
      - LEAD_SUBMITTED
      - INITIATE_CHECKOUT
      - ADD_TO_CART
      - VIEW_CONTENT
      - ORDER_CREATED
      - ORDER_SHIPPED
      - ORDER_DELIVERED
      - ORDER_CANCELED
      - ORDER_RETURNED
      - CART_ABANDONED
      - QUALIFIED_LEAD
      - RATING_PROVIDED
      - REVIEW_PROVIDED
      example: PURCHASE
      title: MetaConversionType
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailIps:
      type: object
      description: IP options per message.
      properties:
        ipPoolId:
          type: string
          description: The ID of the IP pool that will be used to send the email.
      title: EmailIps
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogAcceptTransferRequest:
      type: object
      properties:
        targetCallRequest:
          $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogCallRequest'
      required:
      - targetCallRequest
      title: DialogAcceptTransferRequest
    59ad711434aad6c39708ffc0bab084b409f8c1de0ab1fd0cfa66aa965f740ee4.CallbackRequest:
      type: object
      description: Callback request.
      properties:
        from:
          type: string
          description: Caller phone number.
        to:
          type: string
          description: Called phone number.
        correlationId:
          type: string
          description: Unique identifier of the call record, available for both Callback and Status requests.
        nmCorrelationId:
          type: string
          description: Unique identifier for correlation with inbound call, available in Callback and Status requests.
        dtmfCaptured:
          type: boolean
          description: Indicates that this callback request is initiated after the `captureDtmf` command is executed. Not present in the first callback request for the call.
      title: CallbackRequest
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetAudienceResponse:
      type: object
      description: List of custom audiences.
      properties:
        id:
          type: string
          description: Meta custom audience ID.
          example: '52512562968362'
        name:
          type: string
          description: Custom audience name.
          example: My CRM Audience
        description:
          type: string
          description: Custom audience description.
          example: Q3 campaign target users
        adAccountId:
          type: string
          description: Facebook ad account ID.
          example: act_3339405976215927
        pageId:
          type: string
          description: Facebook page ID.
          example: '108968269613427'
      title: GetAudienceResponse
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniLog:
      type: object
      description: Collection of logs.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
          readOnly: true
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          readOnly: true
        to:
          type: string
          description: The message destination address.
          readOnly: true
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
          readOnly: true
        text:
          type: string
          description: Text of the message that was sent.
          readOnly: true
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the message was sent. It has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: true
        doneAt:
          type: string
          format: date-time
          description: Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.)
          readOnly: true
        messageCount:
          type: integer
          format: int32
          description: The number of sent message segments.
          readOnly: true
        mccMnc:
          type: string
          description: Mobile country and network codes.
          readOnly: true
        price:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price'
        status:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status'
        channel:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel'
      readOnly: true
      title: OmniLog
    2dac378b25c8dcf450b0618ee8c5fb6fb461154cc6b53aedfd327a01e576875e.RingbackGeneration:
      type: object
      description: Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for the existing call, provided it joins the conference before the remote ringback of the new call starts.
      properties:
        enabled:
          type: boolean
          default: false
          description: Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`.
      title: RingbackGeneration
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveAllowedOrderPaymentDetails:
      type: object
      description: Payment of the order.
      discriminator:
        propertyName: type
        mapping:
          UPI_PAYU: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentDetails'
          BRAZIL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentDetails'
          BRAZIL_PIX_DC: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentDetails'
          BRAZIL_LINK: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentDetails'
          BRAZIL_BOLETO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentDetails'
          BRAZIL_PAYMENTS: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentsDetails'
          PG_PAYU: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentDetails'
          PG_RAZORPAY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentDetails'
          UPI_INTENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentDetails'
          UPI_LINK: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentDetails'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveAllowedOrderPaymentDetails
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationSingle:
      type: object
      description: '---'
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Single destination
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusResponse:
      type: object
      properties:
        externalBulkId:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        bulks:
          type: array
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatusInfo'
      required:
      - bulks
      - externalBulkId
      title: BulkStatusResponse
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SendingSpeedLimit'
      title: RequestSchedulingSettings
    578c889dd8f68587bd351066c5c6572a98ea0c15c65b5cacb8779be90fbfbb70.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowHeaderContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      title: InteractiveFlowContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.OnDemandComposition:
      type: object
      description: Composition request.
      properties:
        deleteCallRecordings:
          type: boolean
          default: true
          description: Indicates whether to delete individual files for the call recordings after composition. If set to 'true' then files from the call recordings will be deleted after composition. Otherwise, files from the call recordings will be available, alongside with composed file.
        multiChannel:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MultiChannel'
      title: OnDemandComposition
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Destination:
      type: object
      description: Description of who or what is going to receive a call.
      discriminator:
        propertyName: type
        mapping:
          WEBRTC: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.WebRtcDestination'
          CONVERSATIONS: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ConversationsDestination'
          PHONE: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PhoneDestination'
          ROOM: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RoomDestination'
          APPLICATION: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ApplicationDestination'
      example:
        identity: bob
        type: WEBRTC
      properties:
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DestinationType'
      title: Destination
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. This ID is automatically generated and will be included in the API response.
        capabilityCheckRequestStates:
          type: array
          description: The sync response from the RCS capability checker for the specified phone numbers. Represents the current status of the requests.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckRequestState'
      required:
      - bulkId
      - capabilityCheckRequestStates
      title: CapabilityCheckAsyncResponse
      xml:
        name: CapabilityCheckAsyncResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels:
      type: string
      default: MONO
      description: Audio channel mode. If set to `STEREO`, incoming audio from the endpoint is recorded on the left channel and outgoing audio on the right channel.
      enum:
      - MONO
      - STEREO
      title: RecordingChannels
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundTextContent'
          FILE: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundFileContent'
      properties:
        type:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberInboundMessageContentType'
      required:
      - type
      title: ViberInboundMessageContent
    fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.ApnsData:
      type: object
      description: APNs data.
      properties:
        enabled:
          type: boolean
          description: Equals true if sending messages via APNS is enabled for this application.
      title: ApnsData
    97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.StandardVoiceResponse:
      type: object
      description: Voice response object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        messages:
          type: array
          description: Array of sent messages, one object per every message.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ResponseDetails'
      title: StandardVoiceResponse
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsDescriptiveAmount:
      type: object
      properties:
        value:
          type: integer
          format: int32
          description: Value multiplied by the offset (100 for INR and BRL).
        description:
          type: string
          description: Description of the value.
          maxLength: 60
          minLength: 0
      required:
      - value
      title: InteractiveOrderDetailsDescriptiveAmount
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLogResponse:
      type: object
      properties:
        results:
          type: array
          description: Array of email logs, one object per each email request.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLog'
      title: EmailLogResponse
    8ea2c7a3b5efbaf9015a5275da389c3449f0ab4f7dfbf8f3f925836e68df04d6.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushStatusResponse:
      type: object
      description: Message status.
      properties:
        groupId:
          type: integer
          format: int64
          description: Status group ID.
        groupName:
          type: string
          description: Status group name.
        id:
          type: integer
          format: int64
          description: Status ID.
        name:
          type: string
          description: Status name.
        description:
          type: string
          description: Human readable description of the status.
      required:
      - groupId
      - groupName
      - id
      - name
      title: PushStatusResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUrlOptions'
        clientPriority:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ClientPriority'
      title: EmailMessageRequestOptions
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberPageResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumber'
        paging:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PageInfo'
      required:
      - paging
      - results
      title: RcsTestNumberPageResponse
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordOptions:
      type: object
      properties:
        escapeDigits:
          type: string
          description: DTMF codes which should stop recording when input by the user.
        beep:
          type: boolean
          description: Flag indicating a beep sound should be played at the start of the recording.
        maxSilence:
          type: integer
          format: int32
          description: The amount of silence to wait for before stopping the recording.
        identifier:
          type: string
          description: The identifier for the recording. Identified recordings can be reused in Play from Recording. The parameter can be constructed using variables.
      title: RecordOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: VideoMessage
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundTextContent'
          IMAGE: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundImageContent'
          VIDEO: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundVideoContent'
          AUDIO: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundAudioContent'
          DOCUMENT: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundDocumentContent'
          SURVEY_RESPONSE: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundSurveyResponseContent'
          BUTTON_RESPONSE: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundButtonResponseContent'
          BUNDLE: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundBundleContent'
          CUSTOM_DATA: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundCustomDataContent'
      properties:
        type:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContentType'
      title: LiveChatInboundContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.NonMsisdnSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.RegionalOptions'
        destinationMatching:
          type: array
          description: The SMS failover destination matching.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.FailoverDestinationPair'
      required:
      - text
      title: NonMsisdnSmsFailover
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContentType:
      type: string
      enum:
      - TEMPLATE
      - TEXT
      - IMAGE
      - GIF
      - STICKER
      - QUOTE_CONSULTATION
      - USER_INFORMATION_REQUEST_FORM
      - FILE
      - REACTION
      title: ZaloOutboundContentType
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessagePrice'
        status:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageStatus'
        error:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegment:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentText'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentLink'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentBinary'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentSmil'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegmentUploadReference'
      description: Content of the message being sent.
      title: MmsAdvancedMessageSegment
      writeOnly: true
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkRescheduleRequest:
      type: object
      properties:
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the email is to be sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-01-02T01:00:00.123Z'
      required:
      - sendAt
      title: BulkRescheduleRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResponse:
      type: object
      properties:
        capabilityCheckResults:
          type: array
          description: The result of the RCS capability check for the specified phone numbers.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncResult'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions'
      required:
      - capabilityCheckResults
      title: CapabilityCheckSyncResponse
      xml:
        name: CapabilityCheckSyncResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamMultiChannel:
      type: object
      description: Multi-channel streaming configuration. When enabled, streams both directions as interleaved stereo (left=caller's voice, right=what caller hears). Disabled by default.
      properties:
        enabled:
          type: boolean
      required:
      - enabled
      title: MediaStreamMultiChannel
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Log:
      type: object
      description: Collection of logs.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          readOnly: true
        messageId:
          type: string
          description: Unique message ID.
          readOnly: true
        to:
          type: string
          description: The destination address of the message.
          readOnly: true
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
          readOnly: true
        text:
          type: string
          description: Content of the message being sent.
          readOnly: true
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was [scheduled](https://www.infobip.com/docs/api#channels/sms/get-scheduled-sms-messages) to be sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: true
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e. delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: true
        smsCount:
          type: integer
          format: int32
          description: The number of parts the message content was split into.
          readOnly: true
        mccMnc:
          type: string
          description: Mobile country and network codes.
          readOnly: true
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogPrice'
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogStatus'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogError'
        applicationId:
          type: string
          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).
        entityId:
          type: string
          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).
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      readOnly: true
      title: Log
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DialData:
      type: object
      description: The data related to the dial instruction.
      properties:
        callId:
          type: string
          description: The unique identifier of the call that was dialed.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        errorCodeId:
          type: integer
          format: int32
          description: The status of the dialed call.
          example: 0
        errorCodeName:
          type: string
          description: The name of the error code associated with the dialed call.
          example: NORMAL_HANGUP
        duration:
          type: integer
          format: int64
          description: The duration of the dialed call in milliseconds.
          example: 12500
      title: DialData
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent:
      type: object
      description: Template header. Should be defined, only if placeholders or media have been registered in the template's header.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateTextHeaderContent'
          DOCUMENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDocumentHeaderContent'
          IMAGE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateImageHeaderContent'
          VIDEO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVideoHeaderContent'
          GIF: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateGifHeaderContent'
          LOCATION: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLocationHeaderContent'
      properties:
        type:
          type: string
      required:
      - type
      title: TemplateHeaderContent
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsResponseEnvelope:
      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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageResponseSmsMessageResponseDetails'
      required:
      - messages
      title: SmsResponseEnvelope
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiDomainAccess:
      type: string
      description: Represents the access level for the domain. Domain can be either owned or have granted permissions.
      enum:
      - OWNER
      - GRANTED
      title: ApiDomainAccess
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionPayload:
      type: object
      description: Required when flowAction is set to 'NAVIGATE. Should be omitted otherwise.
      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: InteractiveFlowActionPayload
    dc38425c131b95e4c45181495294ce145519edf2a5db70e09ac8bc816d8bceba.UserActivityResponse:
      type: object
      description: List of results for the requested page.
      properties:
        sessionId:
          type: string
          description: An identifier that links different occurrences of `activityType` within the same activity session for a user identity on the Infobip WebRTC platform. When two activity events, distinguished by their `activityType`, happen during the same user activity session, they will share the same `sessionId`.
        activityType:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ActivityType'
        timestamp:
          type: string
          format: date-time
          description: 'Timestamp of the activity. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
      title: UserActivityResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlTrackingWebhook:
      type: object
      properties:
        notificationType:
          type: string
          description: 'Tells the type of user event that took place. Possible events: CLICKED'
        recipient:
          type: string
          description: Recipient of the message.
        url:
          type: string
          description: The link the recipient has clicked.
        sendDateTime:
          type: integer
          format: int64
          description: This is timestamp epoch millis when we received event for CLICK.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to the recipient.
        bulkId:
          type: string
          description: The ID that uniquely identifies a list of messages. This is either defined by user in the request or auto generated.
        callbackData:
          type: string
          description: The callback data sent through the callbackData field in your fully featured message.
        recipientInfo:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientInfo'
        geoLocationInfo:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.GeoLocationInfoWrapper'
        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).
        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).
      title: UrlTrackingWebhook
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Platform'
        validityPeriod:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTimeWindow'
        smsFailover:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSmsFailover'
        regional:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRegionalOptions'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
      title: MmsUnificationMessageOptions
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton:
      type: object
      description: Buttons to include in the message. Optional value. Max 5 buttons.
      discriminator:
        propertyName: type
        mapping:
          APP_LINK: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAppLinkButton'
          URL: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimUrlButton'
          DELIVERY_TRACKING: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimDeliveryTrackingAlimButton'
          CHATBOT_SWITCH: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimChatbotSwitchButton'
          MESSAGE_DELIVERY: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimMessageDeliveryButton'
          BOT_KEYWORD: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimBotKeywordButton'
          ADD_CHANNEL: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimAddChannelButton'
      properties:
        buttonText:
          type: string
          description: Text of the button. Max 28 characters.
          maxLength: 28
          minLength: 1
          writeOnly: true
        type:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButtonType'
      required:
      - buttonText
      title: KakaoAlimButton
      writeOnly: true
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.PageMarketingSubscriptionResponse:
      type: object
      properties:
        notificationMessagesToken:
          type: string
          description: Token that represents the person. It is used to send Marketing Messages.
          example: '1111111111111111111'
        recipientId:
          type: string
          description: Page ID.
          example: '1111111111111111'
        notificationMessagesReoptin:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.NotificationMessageReoptin'
        creationDatetime:
          type: string
          format: date-time
          description: Creation Datetime.
        tokenExpiry:
          type: string
          format: date-time
          description: Date when the the notification message token expires.
        userTokenStatus:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenRefreshStatus'
        title:
          type: string
          description: Title.
          example: title
        notificationMessagesTimezone:
          type: string
          description: Timezone for the person receiving the message.
          example: Europe\/Zagreb
        nextEligibleDatetime:
          type: string
          format: date-time
          description: The date on which it will be possible to send the next message.
      required:
      - creationDatetime
      - nextEligibleDatetime
      - notificationMessagesReoptin
      - notificationMessagesTimezone
      - notificationMessagesToken
      - recipientId
      - title
      - tokenExpiry
      - userTokenStatus
      title: PageMarketingSubscriptionResponse
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SynthesisVoiceResponse:
      type: object
      description: Array of voices belonging to the specified language.
      properties:
        name:
          type: string
          description: 'Name of the voice. Example: `Joanna`'
        gender:
          type: string
          description: Gender of the voice. Can be `male` or `female`.
        supplier:
          type: string
          description: Name of the supplier for text to speech synthesis.
        ssmlSupported:
          type: boolean
          description: Indicates if SSML is supported.
        default:
          type: boolean
        neural:
          type: boolean
        isDefault:
          type: boolean
          description: Indicates whether voice is default voice for a given language. If voice is not chosen for the language, then default voice will be used.
        isNeural:
          type: boolean
          description: Indicates whether voice is neural. Using neural voice will generate additional cost.
      title: SynthesisVoiceResponse
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CapturePlayInstruction:
      type: object
      description: Audio content to play before capturing DTMF input.
      properties:
        content:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PlayContent'
      required:
      - content
      title: CapturePlayInstruction
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    32babbebe659b3766e613639af834c2c8d0ef32612ea561cefb60f69be9f25b9.IntegrationType:
      type: object
      properties:
        integrationType:
          type: string
          description: Integration type.
          enum:
          - WHATSAPP
          - VIBER
          - FACEBOOK
          readOnly: false
          writeOnly: true
      title: IntegrationType
    3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Status:
      type: object
      properties:
        groupName:
          type: string
          description: Group name for the status.
          readOnly: false
          writeOnly: true
        id:
          type: integer
          format: int32
          description: Status ID.
          readOnly: false
          writeOnly: true
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          readOnly: false
          writeOnly: true
        name:
          type: string
          description: Status name.
          readOnly: false
          writeOnly: true
        action:
          type: string
          description: Action that should be taken to fix the error.
          readOnly: false
          writeOnly: true
        description:
          type: string
          description: Human-readable description of the status.
          readOnly: false
          writeOnly: true
      title: Status
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    f9f4d06aa76c139ea87428e14c99b11f79a0ab9b330e26afc80d0c5a5ff1acbb.RingbackGeneration:
      type: object
      description: Option to generate a consistent local ringback tone, overriding remote ringing tones. It applies only to `INBOUND` parent calls in the `CALLING` state; otherwise, it is ignored.
      properties:
        enabled:
          type: boolean
          default: false
          description: Flag indicating whether ringback generation is enabled. Cannot be `true` when `childCallRinging` is `true`.
      title: RingbackGeneration
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.SuppressionInfo:
      type: object
      description: Suppression get response.
      properties:
        domainName:
          type: string
          description: Name of the requested domain.
        emailAddress:
          type: string
          description: Email address that is suppressed.
        type:
          type: string
          description: Type of suppression.
        createdDate:
          type: string
          format: date-time
          description: Date and time when email address was suppressed.
        reason:
          type: string
          description: Reason for suppression.
      required:
      - createdDate
      - domainName
      - emailAddress
      - reason
      - type
      title: SuppressionInfo
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform'
        validityPeriod:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnSmsFailover'
      title: NonMsisdnMessageFailoverOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DeliveryReport'
      title: DeliveryReports
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CreateRcsTemplateRequest:
      type: object
      properties:
        templateName:
          type: string
          description: The unique name of the template that will be created for the specified sender. Must contain only alphanumeric characters and underscores.
          example: demo_template
          maxLength: 20
          minLength: 1
        providers:
          type: array
          default: []
          description: List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that default value is empty array and in that case the template will be registered with all providers available for given sender.
          example:
          - INDIA_VI
          items:
            type: string
            default: '[]'
            description: List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that default value is empty array and in that case the template will be registered with all providers available for given sender.
            example: '["INDIA_VI"]'
          uniqueItems: true
        content:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent'
      required:
      - content
      - providers
      - templateName
      title: CreateRcsTemplateRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEMPLATE: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundTemplateContent'
          TEXT: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundTextContent'
          IMAGE: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundImageContent'
          GIF: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundGifContent'
          STICKER: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundStickerContent'
          QUOTE_CONSULTATION: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundQuoteConsultationContent'
          USER_INFORMATION_REQUEST_FORM: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundUserInformationRequestFormContent'
          FILE: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundFileContent'
          REACTION: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundReactionContent'
      properties:
        type:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContentType'
      required:
      - type
      title: ZaloOutboundContent
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse:
      type: object
      description: Markup language configuration response object.
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the configuration.
        name:
          type: string
          description: Configuration name.
        markupUrl:
          type: string
          description: URL where markup script is hosted.
        notifyUrl:
          type: string
          description: URL where notifications will be sent.
        errorUrl:
          type: string
          description: URL where error notifications will be sent.
        httpMethod:
          type: string
          description: HTTP method for callbacks (e.g., POST, GET).
        createTime:
          type: string
          format: date-time
          description: Timestamp when the configuration was created, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        updateTime:
          type: string
          format: date-time
          description: Timestamp when the configuration was last updated, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
      required:
      - httpMethod
      - markupUrl
      - name
      title: MarkupLanguageConfigResponse
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateProperty:
      type: object
      description: List of template properties.
      properties:
        name:
          type: string
          description: Property name.
        required:
          type: boolean
          description: Indicates if the property is mandatory.
        type:
          type: string
          description: Property type e.g. STRING.
        maxLength:
          type: integer
          format: int32
          description: Maximum number of characters that the property value can have.
        minLength:
          type: integer
          format: int32
          description: Minimum number of characters that the property value can have.
        acceptNull:
          type: boolean
          description: Indicates if the property value can be null.
      title: TemplateProperty
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod:
      type: string
      description: Allowed markup HTTP method.
      enum:
      - POST
      - GET
      title: MarkupHttpMethod
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplate:
      type: object
      properties:
        name:
          type: string
          description: Template name.
        type:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType'
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus'
        content:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent'
        lastUpdate:
          type: string
          format: date-time
          description: 'Date and time when the template was updated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      required:
      - content
      - lastUpdate
      - name
      - status
      - type
      title: RcsTemplate
    02ec6d748bd9b366e5aeae1eaf03d6007ae57830d7d55344122f68a2478c9f84.UpdateRequest:
      type: object
      properties:
        muted:
          type: boolean
          description: Indicates whether to mute or unmute the end user. This action prevents the user from talking.
        deaf:
          type: boolean
          description: Indicates whether to deaf or undeaf the end user. This action prevents the user from hearing the call.
        blind:
          type: boolean
          description: Indicates whether to blind or unblind the end user. This action prevents the user from seeing any remote video in the call. Only applicable for WebRTC endpoints.
      title: UpdateRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode:
      type: string
      description: '[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages.'
      enum:
      - NONE
      - TR
      - ES
      - PT
      - AUTODETECT
      title: LanguageCode
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessagePrice'
        status:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageStatus'
        error:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateEvent:
      type: object
      description: Collection of RCS test number update events
      properties:
        event:
          type: string
          description: Event type identifier for webhook notifications. Indicates the type of status change that occurred.
        senderName:
          type: string
          description: Unique identifier of a sender for which test number is associated.
        testNumber:
          type: string
          description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
        testNumberStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when test number has been updated last time.
        completedAt:
          type: string
          format: date-time
          description: Timestamp when request has been completed. It will be null if request is still in progress.
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - event
      - senderName
      - senderStatus
      - testNumber
      - testNumberStatus
      - updatedAt
      title: RcsTestNumberUpdateEvent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending MMS to phone numbers registered in South Korea.
      properties:
        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: MmsUnificationSouthKoreaOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReportResponse:
      type: object
      properties:
        results:
          type: array
          description: Arrays of delivery reports, one object for every message.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceReport'
      title: VoiceReportResponse
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStructureApiData:
      type: object
      title: TemplateStructureApiData
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDataContent:
      type: object
      description: Template data. Values have to be set as registered in the template.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateBodyContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateHeaderContent'
        buttons:
          type: array
          description: Template buttons. Should be defined in the correct order, only if `quick reply`, `dynamic URL`, `copy code` or `flow`  buttons have been registered. It can have up to ten buttons including a maximum of two `dynamic URL` buttons, one `copy code` button and one `flow` button. When `catalog`, `multi product` or `order details` button is used it needs to be the only button.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent'
        carousel:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCarouselContent'
        limitedTimeOffer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLimitedTimeOfferContent'
        orderStatus:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderStatusContent'
      required:
      - body
      title: TemplateDataContent
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    9ecece8e0bfcbe5cd4fc1dd17fb7c9f9ae92bd39a74bbe56daee9e0629666e59.UploadBody:
      type: object
      properties:
        url:
          type: string
          description: URL of your voice file location. Max size of the file is 4MB. The acceptable file format is mp3.
        content:
          type: string
          format: byte
          description: Encoded (Base64) value of mp3 file can be included instead of the file location URL.
      title: UploadBody
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.WebhookCallbackRequest:
      type: object
      description: Markup language callback request object.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
      title: WebhookCallbackRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price:
      type: object
      properties:
        currency:
          type: string
          description: The currency in which the price is displayed.
          readOnly: false
          writeOnly: true
        pricePerMessage:
          type: number
          format: double
          description: The price per individual  message.
          readOnly: false
          writeOnly: true
      title: Price
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ShorteningOptionsApiData:
      type: object
      description: URL shortening options. Applicable only if at least one dynamic URL button is present. Modifying this provided URL outside of our company's services may lead to unexpected results.
      properties:
        customDomain:
          type: string
          description: Custom domain to be used for URL shortening.
      required:
      - customDomain
      title: ShorteningOptionsApiData
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentOptionsInboxMessageExpirationTimeUnit:
      type: string
      description: Time unit for inbox message expiration. Only applicable when inboxTopic is present.
      enum:
      - DAYS
      - MONTHS
      title: PushOutboundContentOptionsInboxMessageExpirationTimeUnit
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductHeaderContent'
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductActionContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      - header
      title: InteractiveMultiProductContent
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplatesApiResponsePaginated:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse'
        paging:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PageInfo'
      required:
      - paging
      - results
      title: TemplatesApiResponsePaginated
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RequestSchedulingSettings'
      title: ViberBotMessageRequestOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Say:
      type: object
      description: Say action converts provided text into an audio file which is played during the call based on the provided parameters. Message text can be up to 1400 characters long.
      properties:
        say:
          type: string
          description: Message text. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text. The parameter can be constructed using variables.
          externalDocs:
            description: SSML support
            url: https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SayOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - say
      title: Say
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedAudioFilesResponse:
      type: object
      properties:
        files:
          type: array
          description: Array of recorded files metadata, one for each recorded file.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedIvrFile'
      title: RecordedAudioFilesResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Identity:
      type: object
      properties:
        acknowledged:
          type: boolean
        hash:
          type: string
        createdAt:
          type: string
          format: date-time
      required:
      - acknowledged
      - createdAt
      - hash
      title: Identity
    04790a6ae08cb63186016b6e4b8eb1c003a31d6a3227220686470a5721dc2d02.CreateOrUpdateScenarioRequest:
      type: object
      properties:
        name:
          type: string
          description: OMNI scenario name.
        flow:
          type: array
          description: Sender used in OMNI scenario’s step for sending message.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Step'
        default:
          type: boolean
          description: Indicates if created scenario should be set as a default.
      required:
      - flow
      title: Scenario
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsActionContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      title: InteractiveOrderDetailsContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContent:
      type: object
      description: Template content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextContent'
          CARD: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCardContent'
          CAROUSEL: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateCarouselContent'
          TEXT_WITH_PDF: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateTextWithPdfContent'
      properties:
        type:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType'
      required:
      - type
      title: RcsTemplateContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryProviders:
      type: object
      properties:
        countryCode:
          type: string
          description: Country code in two-letter ISO 3166-1 alpha 2 standard. If set, only providers available in the specified country will be returned.
        providers:
          type: array
          description: Name of the provider.
          items:
            type: string
            description: Name of the provider.
          uniqueItems: true
      required:
      - countryCode
      - providers
      title: CountryProviders
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.RequestSchedulingSettings'
      title: PushMessageRequestOptions
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessages:
      type: object
      properties:
        results:
          type: array
          description: Incoming messages.
          items:
            $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessage'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      required:
      - messageCount
      - pendingMessageCount
      - results
      title: LivechatInboundMessages
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderPaymentStatus:
      type: object
      description: Payment of the order.
      discriminator:
        propertyName: type
        mapping:
          UPI_PAYU: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPayUPaymentStatus'
          BRAZIL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPaymentStatus'
          BRAZIL_PIX_DC: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilPixDcPaymentStatus'
          PG_PAYU: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGPayUPaymentStatus'
          PG_RAZORPAY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIPGRazorpayPaymentStatus'
          BRAZIL_LINK: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilLinkPaymentStatus'
          BRAZIL_BOLETO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderBrazilBoletoPaymentStatus'
          UPI_INTENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPIIntentPaymentStatus'
          UPI_LINK: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderUPILinkPaymentStatus'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveOrderPaymentStatus
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowAction:
      type: string
      default: NAVIGATE
      description: Action of the flow, can be either 'NAVIGATE' or 'DATA_EXCHANGE'.
      enum:
      - NAVIGATE
      - DATA_EXCHANGE
      title: InteractiveFlowAction
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundTextContent'
          FILE: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundFileContent'
          SUGGESTION: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundSuggestionContent'
          LOCATION: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundLocationContent'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContentType'
      required:
      - type
      title: RcsInboundMessageContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Phone:
      type: object
      description: Phone information.
      properties:
        phone:
          type: string
          description: Phone of  contact.
          writeOnly: true
        type:
          type: string
          description: Type of a phone. Can be CELL, MAIN, IPHONE, HOME, WORK.
          writeOnly: true
        waId:
          type: string
          description: WhatsApp ID.
          writeOnly: true
      title: Phone
      writeOnly: true
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnMessageFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Platform'
        validityPeriod:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnSmsFailover'
      title: NonMsisdnMessageFailoverOptions
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentChannelData:
      type: object
      description: Messenger-specific subscription data.
      properties:
        notificationMessagesToken:
          type: string
          description: Token required to send future marketing messages.
          example: '5049615565024480819'
        tokenExpiry:
          type: string
          description: Date when the notification message token expires.
          example: 2030-01-01T00:00:00.000+0000
        userTokenStatus:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenStatus'
        notificationMessagesTimezone:
          type: string
          description: Timezone for the person receiving the message.
          example: Europe/Warsaw
        subscriptionPayload:
          type: string
          description: Payload string from the subscription opt-in button.
          example: promo_campaign_v2
        subscriptionTitle:
          type: string
          description: Title of the subscription opt-in.
          example: Get weekly deals
      required:
      - notificationMessagesToken
      title: MessengerConsentChannelData
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        templateName:
          type: string
          description: Template name. Should only contain lowercase alphanumeric characters and underscores.
          maxLength: 512
          minLength: 1
        templateData:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateDataContent'
        language:
          type: string
          description: The code of language or locale to use. Must be the same code used when registering the template.
      required:
      - language
      - templateData
      - templateName
      title: TemplateContent
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow:
      type: object
      description: 'Scheduling object that allows setting up detailed time windows in which the message can be sent. Consists of from, to and days properties. Days in the week are written as their full names: Monday-Sunday. Days parameter must be populated as a list, between two square brackets. `Example: [''MONDAY'', ''TUESDAY'', ''WEDNESDAY'']`. From and to properties should be either both included, to allow finer time window granulation or both omitted, to include whole days in the delivery time window. From and to parameters are objects, that consist of hour and minute fields that hold integer values. For example, ` from: [ hour: 15, minute:45 ]`. For complete json, please check out our example. Note: delivery time window is set in UTC timezone.'
      properties:
        days:
          type: array
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryDay'
          uniqueItems: true
        from:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime'
        to:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTime'
      required:
      - days
      - from
      - to
      title: DeliveryTimeWindow
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogResponseLogViberBotOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogViberBotOutboundContent'
        cursor:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.CursorPageInfo'
      title: LogResponseLogViberBotOutboundContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HangupSource:
      type: string
      description: Hangup source.
      enum:
      - ENDPOINT
      - API
      - PLATFORM
      title: HangupSource
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Report:
      type: object
      description: Arrays of delivery reports, one object for every message.
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the bulk of messages.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        to:
          type: string
          description: Destination address of the voice message.
        sentAt:
          type: string
          description: 'Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Custom data sent over to the notifyUrl.
        voiceCall:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceData'
        price:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Price'
        status:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus'
        error:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError'
      title: Report
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageConfiguration:
      type: object
      description: Sets up additional configuration that changes the original message content you can preview with this call.
      properties:
        language:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language'
        transliteration:
          type: string
          description: 'Conversion of a message text from one script to another. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `NON_UNICODE` and `ALL`.'
      title: LanguageConfiguration
    1fab3d191d736425211a5879d4b2241fa0e80b8ab68239ab74531b9b6408a7a8.DeletionAcceptedResponse:
      type: object
      description: Response to an accepted request.
      properties:
        campaignId:
          type: string
          description: '`campaignId` of messages that you request to delete.'
        bulkId:
          type: string
          description: '`bulkId` of messages that you request to delete.'
        messageId:
          type: string
          description: '`messageId` of the specific message you request to delete.'
        message:
          type: string
          description: Response wording.
      required:
      - message
      title: DeletionAcceptedResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ClientPriority:
      type: string
      description: Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
      enum:
      - HIGH
      - STANDARD
      - LOW
      title: ClientPriority
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest:
      type: object
      properties:
        recordingType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType'
        customData:
          type: object
          additionalProperties:
            type: string
        filePrefix:
          type: string
          maxLength: 214
          minLength: 1
          pattern: ^[a-zA-Z0-9_\-]*$
        channels:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels'
      required:
      - recordingType
      title: CallRecordingRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.SendingSpeedLimit'
      title: RequestSchedulingSettings
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignsResponse:
      type: object
      properties:
        campaigns:
          type: array
          description: List of campaigns.
          items:
            $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.GetCampaignResponse'
      title: GetCampaignsResponse
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.ViberTemplateResponseNoDates:
      type: object
      description: Viber message template response containing template details and current status.
      properties:
        templateId:
          type: string
          description: Unique identifier of the template.
          example: 00000000-0000-0000-0000-000000000000
        version:
          type: string
          description: Template version number.
          example: '1'
        sender:
          type: string
          description: Sender for which the template is registered.
          example: CompanyName
        category:
          $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateCategory'
        status:
          $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateStatus'
        params:
          type: array
          description: List of variable parameters defined in the template.
          items:
            $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParam'
        body:
          type: array
          description: List of template bodies per language containing the actual message text.
          items:
            $ref: '#/components/schemas/f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateBody'
      title: ViberTemplateResponseNoDates
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SearchResponse:
      type: object
      properties:
        createTime:
          type: string
          format: date-time
          description: Creation timestamp.
        description:
          type: string
          description: Scenario description.
        id:
          type: string
          description: Scenario key. It is used for launching IVR scenario.
        name:
          type: string
          description: Scenario name.
        notifyUrl:
          type: string
          description: The URL on the client's callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        record:
          type: boolean
          description: Indicates if all calls using the scenario should be recorded.
        script:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script'
        updateTime:
          type: string
          format: date-time
          description: Update timestamp
        lastUsageDate:
          type: string
          format: date
          description: Last usage date. `null` for scenarios that are used last time before `2024-01-01`.
      title: SearchResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReports:
      type: object
      properties:
        emailResults:
          type: array
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReport'
          writeOnly: true
        results:
          type: array
          description: Collection of email delivery reports, one per every message.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailDeliveryReport'
      required:
      - results
      title: EmailDeliveryReports
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus:
      type: string
      description: SIP trunk admin status.
      enum:
      - ENABLED
      - DISABLED
      - SYSTEM_DISABLED
      title: SipTrunkAdminStatus
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SendingSpeedLimit'
      title: RequestSchedulingSettings
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    ce93fb2fe51c89086b5064c5562c417f51be44b14f40606d3932f527a3fd02d9.SendResult:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique bulk identifier.
          example: '1'
        messages:
          type: array
          description: Array of sent message objects, one object per every message.
          items:
            oneOf:
            - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultBcc'
            - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultCc'
            - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultTo'
        errorMessage:
          type: string
          description: General error description.
      required:
      - messages
      title: SendResult
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Status:
      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:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
        id:
          type: integer
          format: int32
          description: Status ID.
        name:
          type: string
          description: '[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes).'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action that should be taken to recover from the error.
      title: Status
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.MarkAsReadErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Error details
      title: MarkAsReadErrorResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry:
      type: object
      description: 'Used to define if the delivery of the Voice messages should be retried in case the first try doesn''t succeed. Additional retries will be made according to the schedule defined by _minPeriod_ and _maxPeriod_ parameters and platform''s internal retry logic. If the _minPeriod_ differs _maxPeriod_, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached.  If the retry attempt for the _maxPeriod_ is reached, the _maxPeriod_ will be used for all subsequent retries. If the _minPeriod_ and the _maxPeriod_ are defined as equal values, the period of time between retries will be equal to this value. Message delivery will be retried until the successful delivery or message validity or _maxCount_ value is reached.'
      properties:
        minPeriod:
          type: integer
          format: int32
          description: Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours.
        maxPeriod:
          type: integer
          format: int32
          description: Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the message again. Supported values are 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours. If entered a value that isn't from the previous list but that's smaller than 24 hours, it is used the next bigger value from the list. If entered value that is bigger than 24 hours than it is used 24 hours.
        maxCount:
          type: integer
          format: int32
          description: Specify the maximum number of retry attempts. Maximum value of the maxCount is `4`. If the value is higher than `4`, it will be set to `4`.
      required:
      - maxCount
      - maxPeriod
      - minPeriod
      title: Retry
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - CAROUSEL
      - RICH_CARD
      title: InstagramDmOutboundContentType
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.ConsentEvent:
      type: string
      description: Subscription event type.
      enum:
      - SUBSCRIBE
      - UNSUBSCRIBE
      title: ConsentEvent
    d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.RecordingPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/73e6f414ccb2e1e41274c061b50cf5765f69b642a3e0cca54b0248eb3baf086d.RecordingResponse'
        paging:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo'
      title: RecordingPage
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessagePrice'
        status:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageStatus'
        error:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CmlScript:
      type: array
      description: Array of markup language instructions defining the call flow.
      items:
        oneOf:
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Play'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Say'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Fetch'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Pause'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Hangup'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Record'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmf'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StartRecording'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.StopRecording'
        - $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Dial'
      title: CmlScript
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContent:
      type: object
      discriminator:
        propertyName: type
        mapping:
          URL: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UrlAudioContent'
          FILE: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.FileAudioContent'
      properties:
        type:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AudioContentType'
      required:
      - type
      title: AudioContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.WhileDo:
      type: object
      description: While-Do action executes the do field block of code as long as a specified condition is true in the while field. As with Repeat-While, comparison is done using equal (==) or not equal (! =) operators. Make sure not to provide a condition that causes an infinite loop.
      properties:
        while:
          type: string
          description: The expression to evaluate.
        do:
          type: array
          description: Array of actions to execute if none of the conditions above are met.
          items:
            type: object
            description: Array of actions to execute if none of the conditions above are met.
      required:
      - do
      - while
      title: While Do
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsApiResponse:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageInfo'
      required:
      - messages
      title: RcsApiResponse
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language:
      type: string
      description: Template language, one template with same name can have multiple transliterations.
      enum:
      - af
      - sq
      - ar
      - ar_EG
      - ar_AE
      - ar_LB
      - ar_MA
      - ar_QA
      - az
      - bn
      - bn_IN
      - bg
      - ca
      - zh_CN
      - zh_HK
      - zh_TW
      - hr
      - cs
      - da
      - nl
      - nl_BE
      - en
      - en_GB
      - en_US
      - en_AE
      - en_AU
      - en_CA
      - en_GH
      - en_IE
      - en_IN
      - en_JM
      - en_MY
      - en_NZ
      - en_QA
      - en_SG
      - en_UG
      - en_ZA
      - et
      - fil
      - fi
      - fr
      - fr_BE
      - fr_CA
      - fr_CH
      - fr_CI
      - fr_MA
      - ka
      - de
      - de_AT
      - de_CH
      - el
      - gu
      - ha
      - he
      - hi
      - hu
      - id
      - ga
      - it
      - ja
      - kn
      - kk
      - rw_RW
      - ko
      - ky_KG
      - lo
      - lv
      - lt
      - mk
      - ms
      - ml
      - mr
      - nb
      - fa
      - pl
      - pt_BR
      - pt_PT
      - pa
      - ro
      - ru
      - sr
      - si_LK
      - sk
      - sl
      - es
      - es_AR
      - es_CL
      - es_CO
      - es_CR
      - es_DO
      - es_EC
      - es_HN
      - es_MX
      - es_PA
      - es_PE
      - es_ES
      - es_UY
      - sw
      - sv
      - ta
      - te
      - th
      - tr
      - uk
      - ur
      - uz
      - vi
      - zu
      - unknown
      example: en
      title: Language
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessage'
        options:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushMessageRequestOptions'
      required:
      - messages
      title: PushUnificationRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogHangupSource:
      type: string
      enum:
      - API
      - PARENT_ENDPOINT
      - CHILD_ENDPOINT
      - PLATFORM
      title: DialogHangupSource
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetSenderFlowsResponse:
      type: object
      properties:
        flows:
          type: array
          description: List of found flows.
          items:
            $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.FlowDataResponse'
      required:
      - flows
      title: GetSenderFlowsResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.File'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: FilePage
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingFile:
      type: object
      description: Recording files.
      properties:
        id:
          type: string
          description: File identifier.
        name:
          type: string
          description: File name.
        fileFormat:
          type: string
          description: File format.
          enum:
          - MP3
          - WAV
          - MP4
        size:
          type: integer
          format: int64
          description: File size in bytes.
        startTime:
          type: string
          format: date-time
          description: 'Date and time in the UTC timezone when the recording started. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        endTime:
          type: string
          format: date-time
          description: 'Date and time in the UTC timezone when the recording ended. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        creationTime:
          type: string
          format: date-time
          description: 'Date and time in the UTC timezone when the recording file was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSS+ZZZZ`.'
        duration:
          type: integer
          format: int64
          description: File duration in seconds.
        location:
          type: string
          description: Location of recording file after processing.
          enum:
          - UPLOADING
          - UPLOADED
          - HOSTED
        customData:
          type: object
          additionalProperties:
            type: string
            description: Client-defined data.
          description: Client-defined data.
      title: RecordingFile
    f6fe07754dbab8be58eaa18cf7a5d306bd0a320e1642529931d05084863a1fb3.TemplateParamType:
      type: string
      description: Type of template parameter.
      enum:
      - TEXT
      example: TEXT
      title: TemplateParamType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DefaultEventRequestOptions:
      type: object
      description: Options applicable to all events in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.RequestSchedulingSettings'
      title: DefaultEventRequestOptions
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.WhatsAppSenderRegistrationStatus:
      type: string
      description: Add phone number status.
      enum:
      - SUBMITTED_FOR_REGISTRATION
      - OTP_REQUESTED
      example: SUBMITTED_FOR_REGISTRATION
      title: WhatsAppSenderRegistrationStatus
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions:
      type: object
      description: SIP Options.
      properties:
        enabled:
          type: boolean
          default: false
          description: Indicates whether Infobip Session Border Controller should send SIP Options.
      title: SipOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateResponse:
      type: object
      description: Response from Zalo API after creating a ZBS template.
      properties:
        templateId:
          type: string
          description: Unique identifier for the created template.
        templateName:
          type: string
          description: Name of the template.
        templateType:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateType'
        status:
          type: string
          description: Current status of the template.
        tag:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateTag'
        appId:
          type: string
          description: Application ID associated with the template.
        oaId:
          type: string
          description: Official Account ID that owns the template.
        timeout:
          type: integer
          format: int64
          description: Template timeout.
        previewUrl:
          type: string
          description: URL to preview the template in Zalo's interface.
      required:
      - templateType
      title: CreateTemplateResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamAudioProperties:
      type: object
      properties:
        mediaStreamConfigId:
          type: string
          description: Media stream configuration ID.
        replaceMedia:
          type: boolean
          description: Indicates whether outbound media should be replaced. The replacement media is received from the url defined in the media stream configuration.
        multiChannel:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamMultiChannel'
      required:
      - mediaStreamConfigId
      title: MediaStreamAudioProperties
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessageBase:
      type: object
      properties:
        from:
          type: string
          description: Number which sent the message.
          readOnly: false
          writeOnly: true
        to:
          type: string
          description: Sender provided during the activation process.
          readOnly: false
          writeOnly: true
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the message.
          readOnly: false
          writeOnly: true
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
          readOnly: false
          writeOnly: true
        price:
          allOf:
          - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.Price'
          description: Message price.
          readOnly: false
          writeOnly: true
      title: InboundMessageBase
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SeenReport:
      type: object
      description: Collection of reports, one per every received message.
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        sendAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
        contact:
          $ref: '#/components/schemas/8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact'
      title: SeenReport
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Email:
      type: object
      description: Email information.
      properties:
        email:
          type: string
          description: Email of a contact.
          writeOnly: true
        type:
          type: string
          description: Type of an email. Can be HOME, WORK.
          writeOnly: true
      title: Email
      writeOnly: true
    d1778b306237beb41d9922fd3fd38c085ddcf463c618d1f8ceed148892c3020d.SystemEvent:
      type: object
      properties:
        description:
          type: string
          description: Description of the event.
          readOnly: false
          writeOnly: true
        hash:
          type: string
          description: Identity hash.
          readOnly: false
          writeOnly: true
        type:
          type: string
          description: Indicates type of system event forwarded.
          enum:
          - user_identity_changed
          readOnly: false
          writeOnly: true
        userNumber:
          type: string
          description: End user's number. Must be in international format.
          readOnly: false
          writeOnly: true
        userId:
          type: string
          description: Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business.
          readOnly: false
          writeOnly: true
      title: whatsappSystemReportsSystemEvent
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogResponseLogAppleMfbOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.LogAppleMfbOutboundContent'
        cursor:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.CursorPageInfo'
      title: LogResponseLogAppleMfbOutboundContent
    6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallSendMessageRequest:
      type: object
      properties:
        message:
          type: string
          description: Message to send.
      required:
      - message
      title: CallSendMessageRequest
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SendingSpeedLimit'
      title: RequestSchedulingSettings
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Recording:
      type: object
      description: Recording metadata.
      properties:
        composedFiles:
          type: array
          description: List of composed files.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingFile'
        callRecordings:
          type: array
          description: List of call recordings.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallRecording'
      title: Recording
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessage:
      type: object
      properties:
        messages:
          type: array
          description: An array of messages being sent.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.FailoverMessage'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          maxLength: 100
          minLength: 0
      required:
      - messages
      title: BulkMessage
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveUrlButtonMessage
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        mediaUrl:
          type: string
          description: URL of a sticker sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported sticker type is `WebP`. Sticker file should be 512x512 pixels. Maximum size is 100KB for static sticker and 500KB for animated sticker.
          maxLength: 2048
          minLength: 1
      required:
      - mediaUrl
      title: StickerContent
    f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplatePublicApiRequest:
      type: object
      discriminator:
        propertyName: category
        mapping:
          MARKETING: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplatePublicApiRequest'
          UTILITY: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplatePublicApiRequest'
          AUTHENTICATION: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplatePublicApiRequest'
      properties:
        name:
          type: string
          description: Template name. Must only contain lowercase alphanumeric characters and underscores.
        language:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language'
        category:
          type: string
          description: Category of the template. Mind that each category has different fields available for the endpoint. If you're sending traffic in India, for `AUTHENTICATION`, use fields available for `UTILITY` with `AUTHENTICATION` as category. Note that category of the template can be automatically changed by Meta.
          enum:
          - MARKETING
          - AUTHENTICATION
          - UTILITY
          example: MARKETING
        structure:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.TemplateStructureApiData'
        platform:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform'
      required:
      - category
      - language
      - name
      - structure
      title: TemplateRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceResponseDetails:
      type: object
      description: Array of sent messages, one object per every message.
      properties:
        to:
          type: string
          description: The message destination address.
        status:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus'
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
      title: VoiceResponseDetails
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus:
      type: string
      description: Status of scheduled email messages.
      enum:
      - PENDING
      - PAUSED
      - PROCESSING
      - CANCELED
      - FINISHED
      - FAILED
      title: BulkStatus
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Hangup:
      type: string
      description: Hangup action marks the end of the IVR flow execution, leading to the call actually being hung up.
      enum:
      - hangup
      required:
      - hangup
      title: Hang-up
    a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price:
      type: object
      properties:
        pricePerSecond:
          type: number
          format: double
          description: Price per one second of the Voice message.
          readOnly: false
          writeOnly: false
        currency:
          type: string
          description: The currency in which the price is expressed.
          readOnly: false
          writeOnly: false
      title: Price
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice'
        status:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus'
        error:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentityType:
      type: string
      description: Unique Person identifier type.
      enum:
      - EMAIL
      - PHONE
      - EXTERNAL_ID
      title: LiveChatInboundUserIdentityType
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStorage:
      type: object
      description: '[Email storage options](https://www.infobip.com/docs/email/email-storage-and-retrieval) per message.'
      properties:
        skipPassive:
          type: boolean
          description: "Set to true to skip [passive email storage](https://www.infobip.com/docs/email/email-storage-and-retrieval/passive-email-storage) (long-term storage used for compliance, legal, or audit purposes).\n            If `false` or not set, the account-level setting is used."
        skipActive:
          type: boolean
          description: "Set to true to skip [active email storage](https://www.infobip.com/docs/email/email-storage-and-retrieval/active-email-storage) (short-term storage used for troubleshooting or support).\n            If `false` or not set, the account-level setting is used."
      title: EmailStorage
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.ImagePage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/bced1b5de5a3082b5f8ce3c272029f66a05beaf3b2db4fdc852bd1a5393c0582.ImageResponse'
        paging:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.PageInfo'
      title: ImagePage
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceRecordingPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicConferenceRecording'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: ConferenceRecordingPage
    4f883ab7a2c1db442b6865996e0e9f08b46ee1927d7a2c7d45b090008604a1ec.PushConfigurationResponse:
      type: object
      properties:
        id:
          type: string
          description: The identifier to associate the push configuration with.
        name:
          type: string
          description: Name describing the push configuration.
        androidConfigured:
          type: boolean
          description: Flag indicating whether the Android push notification config is set.
        iosConfigured:
          type: boolean
          description: Flag indicating whether the iOS push notification config is set.
      title: PushConfigurationResponse
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTextContent'
          IMAGE: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundImageContent'
          BUTTON_LIST: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundButtonListContent'
          TERMINATE_SESSION: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundTerminateSessionContent'
      properties:
        type:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContentType'
      title: KakaoSangdamOutboundContent
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - AUDIO
      - DOCUMENT
      - SURVEY_RESPONSE
      - PRE_CHAT_FORM
      - FORM_RESPONSE
      - BUTTON_RESPONSE
      - BUNDLE
      - CUSTOM_DATA
      title: LiveChatInboundContentType
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberMessage'
        options:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultMessageRequestOptions'
      required:
      - messages
      title: ViberRequest
    b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceReport:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the bulk of messages.
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
          readOnly: false
          writeOnly: false
        to:
          type: string
          description: Destination address of the voice message.
          readOnly: false
          writeOnly: false
        sentAt:
          type: string
          description: 'Date and time when the voice message was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: false
        mccMnc:
          type: string
          description: Mobile country and network codes.
          readOnly: false
          writeOnly: false
        callbackData:
          type: string
          description: Custom data sent over to the notifyUrl.
          readOnly: false
          writeOnly: false
        voiceCall:
          allOf:
          - $ref: '#/components/schemas/b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.VoiceData'
          description: Fields representing details specific for voice messages.
          readOnly: false
          writeOnly: false
        price:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Price'
          description: Sent Voice message price.
          readOnly: false
          writeOnly: false
        status:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status'
          description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
          externalDocs:
            description: Response status and error codes
            url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#status-object-example
          readOnly: false
          writeOnly: false
        error:
          allOf:
          - $ref: '#/components/schemas/a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error'
          description: Indicates whether the error occurred during the query execution.
          externalDocs:
            description: Response status and error codes
            url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes#error-object-example
          readOnly: false
          writeOnly: false
      title: VoiceReport
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddNewCallRequest:
      type: object
      properties:
        callRequest:
          $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest'
        connectOnEarlyMedia:
          type: boolean
          default: false
          description: Indicates whether to connect a new call on early media. Otherwise, the call will be connected after being established. Cannot be `true` when `ringbackGeneration` is enabled.
        ringbackGeneration:
          $ref: '#/components/schemas/27eaa09c2aeef6932f3271ca5bde4158d33d6ab404b64c38db12c844a2084089.RingbackGeneration'
        role:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role'
      required:
      - callRequest
      title: AddNewCallRequest
    b2a108c706e7d46b95495b161a8c99f5751c046c5e419f6f0780788488a1af14.CallLinkConfigRequest:
      type: object
      description: Call link configuration.
      properties:
        name:
          type: string
          description: Configuration name.
        initialOptions:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.InitialOptions'
        callOptions:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallOptions'
        theme:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Theme'
        isDefault:
          type: boolean
          default: false
          description: 'Indicates whether the specific call link configuration is the default one and used with any call link without a callLinkConfigId. Only one configuration can be default.If you don''t have a configuration, the basic Infobip theme with default values and minimal options will be used.If you want to use another configuration, set this value to `true` for the call link config you wish as default. '
        subdomainId:
          type: string
          description: Subdomain to use for every call link generated for this configuration.If not defined, no subdomain will be used.
        webhook:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Webhook'
      required:
      - name
      title: CallLinkConfigRequest
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenStatusReporting:
      type: object
      description: Provides options for configuring the seen report behavior.
      properties:
        url:
          type: string
          description: The URL on your call back server where a seen report will be sent.
      title: SeenStatusReporting
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SendingSpeed:
      type: object
      description: Sending rate defined in number of messages sent per second, minute, hour or day. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic. Not setting a send speed limit can overwhelm your resources with incoming traffic. If this parameter is defined, _validityPeriod_ is ignored.
      properties:
        speed:
          type: integer
          format: int32
          description: Defines the number of messages that will be sent per specified time unit.
        timeUnit:
          type: string
          description: 'Defines time unit used for calculating sending speed.  Possible values: `second`, `minute`, `hour` and `day`.'
      title: SendingSpeed
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Destination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. Anything above 200 characters passed in the request will be clipped during processing and returned in response, reports and logs.
          writeOnly: true
        to:
          type: string
          description: 'Message destination address. Addresses must be in international format (Example: `41793026727`).'
          maxLength: 64
          minLength: 0
          writeOnly: true
      required:
      - to
      title: Destination
      writeOnly: true
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckAsyncResult:
      type: object
      properties:
        capabilityCheckResult:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckResult'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions'
      required:
      - capabilityCheckResult
      title: CapabilityCheckAsyncResult
      xml:
        name: CapabilityCheckAsyncResult
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.DeliveryReport'
      title: DeliveryReports
    431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call:
      type: object
      properties:
        id:
          type: string
          description: Unique call ID.
          example: d8d84155-3831-43fb-91c9-bb897149a79d
          maxLength: 128
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        from:
          type: string
          description: Caller ID.
          example: '44790123456'
        to:
          type: string
          description: Callee ID.
          example: '44790987654'
        direction:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        state:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState'
        media:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties'
        startTime:
          type: string
          format: date-time
          description: Date and time for when the call has been created.
        answerTime:
          type: string
          format: date-time
          description: Date and time for when the call has been answered.
        endTime:
          type: string
          format: date-time
          description: Date and time for when the call has been finished.
        parentCallId:
          type: string
          description: Parent call ID.
          example: 3ad8805e-d401-424e-9b03-e02a2016a5e2
          maxLength: 128
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties'
        ringDuration:
          type: integer
          format: int32
          description: Ringing duration in seconds.
          example: 3
        callsConfigurationId:
          type: string
          description: Current calls configuration ID.
          example: dc5942707c704551a00cd2ea
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        conferenceId:
          type: string
          description: Current conference ID.
          example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
          maxLength: 128
        customData:
          type: object
          additionalProperties:
            type: string
            example: '{"key1":"value1","key2":"value2"}'
          description: Custom data.
          example:
            key1: value1
            key2: value2
        dialogId:
          type: string
          description: Dialog ID.
          example: 5aee53f4-72f8-484b-bfcc-10c5f5476f70
          maxLength: 128
        externalId:
          type: string
          description: Client defined call ID.
      required:
      - endpoint
      title: Call
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamInboundResponse:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.InboundMessageKakaoSangdamInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: KakaoSangdamInboundResponse
    a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Error:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
          readOnly: false
          writeOnly: false
        groupName:
          type: string
          description: Error group name.
          readOnly: false
          writeOnly: false
        id:
          type: integer
          format: int32
          description: Error ID.
          readOnly: false
          writeOnly: false
        name:
          type: string
          description: Error name.
          readOnly: false
          writeOnly: false
        description:
          type: string
          description: Human-readable description of the error.
          readOnly: false
          writeOnly: false
        permanent:
          type: boolean
          description: Tells if the error is permanent.
          readOnly: false
          writeOnly: false
      title: Error
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReport'
      title: SeenReports
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Pause:
      type: object
      description: Pause action waits for a specified duration before executing the next instruction.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - pause
        duration:
          type: number
          format: double
          description: Duration of the pause in seconds (1 to 5).
          maximum: 5
          minimum: 1
      required:
      - action
      - duration
      title: Pause
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateButtonContent:
      type: object
      description: Template buttons. Should be defined in the correct order, only if `quick reply` or `dynamic URL` buttons have been registered. It can have up to ten buttons including a maximum of two `dynamic URL` buttons.
      discriminator:
        propertyName: type
        mapping:
          QUICK_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateQuickReplyButtonContent'
          URL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateUrlButtonContent'
          COPY_CODE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCopyCodeButtonContent'
          FLOW: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateFlowButtonContent'
          CATALOG: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateCatalogButtonContent'
          MULTI_PRODUCT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateMultiProductButtonContent'
          ORDER_DETAILS: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateOrderDetailsButtonContent'
          VOICE_CALL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateVoiceCallButtonContent'
      properties:
        type:
          type: string
      required:
      - type
      title: TemplateButtonContent
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallTransfer:
      type: object
      description: Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.
      properties:
        callTransferMaxDuration:
          type: integer
          format: int32
          description: Maximum duration of the transferred call, specified in seconds.
        equals:
          type: string
          description: Criteria for establishing call transfer, if `dtmf` is evaluated.
        transferTo:
          type: string
          description: 'Phone number of the recipient that will receive transferred call. Must be written in E.164 standard (Example: 41793026727).'
        if:
          type: string
          description: Specifies what to evaluate. Can be `dtmf` or `anyDtmf`.
      required:
      - if
      - transferTo
      title: CallTransfer
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Price:
      type: object
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CampaignRequest:
      type: object
      properties:
        name:
          type: string
          description: Campaign name.
          example: Summer Sale Campaign
        dailyBudget:
          type: integer
          format: int64
          description: Daily budget for the campaign in cents. At least one of `dailyBudget` or `lifetimeBudget` must be provided.
          example: 10000
        lifetimeBudget:
          type: integer
          format: int64
          description: Lifetime budget for the campaign in cents. At least one of `dailyBudget` or `lifetimeBudget` must be provided.
          example: 100000
        adAccountId:
          type: string
          description: Facebook ad account ID associated with the campaign.
          example: ACT_123456789
          maxLength: 100
          minLength: 1
        pageId:
          type: string
          description: Facebook page ID associated with the campaign.
          example: '111111111111111'
          maxLength: 100
          minLength: 1
      required:
      - adAccountId
      - name
      - pageId
      title: CampaignRequest
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress:
      type: object
      description: Privacy policy associated with the sender.
      properties:
        url:
          type: string
          description: A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        label:
          type: string
          description: Label for the URI. Currently accepted but not in use by RCS providers.
          maxLength: 25
          minLength: 1
      required:
      - url
      title: PrivacyWebAddress
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteResponse:
      type: object
      description: Route response object.
      properties:
        id:
          type: string
          description: Unique identifier of a route.
        name:
          type: string
          description: Route name.
        criteria:
          type: array
          description: List of criteria that should match route. For a route to match, any criterion should be met.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria'
        destinations:
          type: array
          description: List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination'
          maxItems: 10
          minItems: 1
        status:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus'
        order:
          type: integer
          format: int32
          description: 'Indicates priority index of the route. Routes with lower priority index are executed first. '
        transferOnly:
          type: boolean
          description: Indicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The `to` number value will be taken from the `Refer-To` header.
      required:
      - destinations
      - id
      - name
      - status
      title: RouteResponse
    cb1ef9a380a46bb9d49281818dd22b206a7f89260670bd103daadd3abc4386a3.QuerySmsResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when a message is sent to more than one destination address.
          readOnly: true
        messages:
          type: array
          description: Array of sent message objects, one object per every message.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails'
          readOnly: true
      title: QuerySmsResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingPlayContent:
      type: object
      description: Plays a previously recorded call file.
      properties:
        type:
          type: string
          description: Content type discriminator.
          enum:
          - RECORDING
        fileId:
          type: string
          description: Identifier of the recording to play.
      required:
      - fileId
      - type
      title: RecordingPlayContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedWebhooksWithSeen:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenStatusReporting'
      title: AdvancedWebhooksWithSeen
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SouthKoreaOptions'
      title: RegionalOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReply:
      type: object
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.TextFacebookMtQuickReply'
          PHONE_NUMBER: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.PhoneNumberFacebookMtQuickReply'
          EMAIL: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtEmailQuickReply'
      properties:
        type:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReplyContentType'
      title: FacebookMtQuickReply
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ToDestination'
        content:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmOutboundContent'
        options:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DefaultMessageOptions'
        webhooks:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: InstagramDmMessage
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.InboundMessageZaloInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloInboundContent'
        price:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageZaloInboundContent
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest:
      type: object
      properties:
        recordingType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType'
        dialogComposition:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingComposition'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
        filePrefix:
          type: string
          description: 'Custom name for the recording''s zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).

            Using the same filePrefix will override the files on the SFTP server.

            For recordings without composition, `callId` and `fileId` will be appended to the `filePrefix` value.'
      required:
      - recordingType
      title: DialogRecordingRequest
    6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.CallRecording:
      type: object
      description: Call recording metadata.
      properties:
        callId:
          type: string
          description: Call identifier.
        endpoint:
          type: string
          description: Call endpoint. Represents a caller for the inbound calls and a callee for the outbound calls.
        direction:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Direction'
        status:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.Status'
        reason:
          type: string
          description: Reason for recording failure.
        files:
          type: array
          description: Recording files.
          items:
            $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingFile'
      title: CallRecording
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Play:
      type: object
      description: Play action performs playback of audio provided by the client’s URL. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
      properties:
        playFromUrl:
          type: string
          description: Audio file URL. The parameter can be constructed using variables.
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayOptions'
      required:
      - playFromUrl
      title: Play
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallOptions:
      type: object
      description: User options available during a call. Depending on the fields, certain options for a call will be shown to a user.
      properties:
        mute:
          type: boolean
          default: true
          description: User will be able to mute themselves during the call.
        screenShare:
          type: boolean
          default: true
          description: User will be able to share the screen during the call.
        camera:
          type: boolean
          default: true
          description: User will be able to toggle the video during the call.
        switchCameraFacingMode:
          type: boolean
          default: true
          description: User will be able to switch between front-facing and back camera during the call.
        dialPad:
          type: boolean
          default: false
          description: User will be able to use dial pad for DTMF, during the call.
        chat:
          type: boolean
          default: false
          description: Users will be able to open the chat box and send and receive text messages that are visible to all the participants. This is applicable only for the ROOM call type. Messages sent before joining the room are not visible.
        settings:
          type: boolean
          default: true
          description: User will be able to access settings during the call.
        recordingIndicator:
          type: boolean
          default: false
          description: User will be able to see if the call is being recorded.
      title: CallOptions
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineDataType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - AUDIO
      - STICKER
      - FLEX
      title: LineDataType
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundMessage:
      type: object
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundTextMessage'
          IMAGE: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundImageMessage'
          DOCUMENT: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundDocumentMessage'
          STICKER: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundStickerMessage'
          LOCATION: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundLocationMessage'
          CONTACT: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundContactMessage'
          VIDEO: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVideoMessage'
          VOICE: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundVoiceMessage'
          AUDIO: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.InboundAudioMessage'
          BUTTON: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.QuickReplyContent'
          INTERACTIVE_BUTTON_REPLY: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ButtonReplyContent'
          INTERACTIVE_LIST_REPLY: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ListReplyContent'
          INTERACTIVE_PAYMENT_CONFIRMATION: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentConfirmationContent'
          ORDER: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.OrderContent'
      properties:
        type:
          $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Type'
        context:
          $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Context'
        identity:
          $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Identity'
        referral:
          $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Referral'
      title: MoMessage
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DKIMCheck:
      type: object
      description: The result of a check of the DKIM authentication record of the inbound email.
      properties:
        result:
          type: string
          description: Indicates whether the DKIM validation was successful.
        domains:
          type: array
          description: List of domains which were used to validate DKIM.
          items:
            type: string
            description: List of domains which were used to validate DKIM.
      required:
      - domains
      - result
      title: DKIMCheck
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.NotificationOptions:
      type: object
      description: Options on how to alert the user when the Push message is received.
      properties:
        vibrationEnabled:
          type: boolean
          description: Notification vibration (Android only).
          writeOnly: true
        soundEnabled:
          type: boolean
          description: Sound when notification arrives on a device.
          writeOnly: true
        soundName:
          type: string
          description: 'Name of the custom sound played when notification arrives on a device. File should be located in the app with max 30 seconds length. File extension is required for iOS and optional for Android. For custom sound to be played soundEnabled shouldn’t be false (Example: `notification_sound.wav`). Check Android and iOS usage details.'
          writeOnly: true
        badge:
          type: integer
          format: int32
          description: Badge counter (iOS only).
          writeOnly: true
        contentUrl:
          type: string
          description: URL of the image displayed in the notification. Rich push notifications are available on devices with iOS 10 and Android 4.1.+. Supported on iOS since MM SDK version 2.5.8. Supported on Android since MM SDK version 1.6.4.
          writeOnly: true
        category:
          type: string
          description: 'Category id for actionable notification. Supported on Android since MM SDK version 1.6.16. Supported on iOS since MM SDK version 2.6.9. Predefined category ids: `mm_accept_decline` - Accept & Decline button actions.'
          writeOnly: true
        inAppStyle:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.InAppStyle'
        title:
          type: string
          description: Notification title displayed within notification. Requires iOS 10+ or Android 4.1+ (may depend on Android custom firmware)
          writeOnly: true
        isSilent:
          type: boolean
          description: Set to `true` to send silent push message. Such messages are not displayed on device lock screen and in the notification center. Silent messages can be used to deliver custom data to your mobile application or to trigger an in-app notification.
          writeOnly: true
        webViewUrl:
          type: string
          description: URL to open external web page within the mobile app (web view).
          writeOnly: true
        inboxTopic:
          type: string
          description: A case sensitive topic name to save a message to an inbox. If the topic name does not exist for a specified account, message sending will be rejected.
          writeOnly: true
      title: NotificationOptions
      writeOnly: true
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.IpCoreGeneralStatus:
      type: string
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: IpCoreGeneralStatus
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.CallRequest:
      type: object
      description: Outbound call request.
      properties:
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        from:
          type: string
          description: Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers.
        fromDisplayName:
          type: string
          description: Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string.
        connectTimeout:
          type: integer
          format: int32
          description: Time to wait, in seconds, before the called party answers the call.
          maximum: 60
        recording:
          $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest'
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        parentCallId:
          type: string
          description: ID of an existing call that initiated this leg. Required for [creating a dialog with an existing call.](#create-dialog-with-existing-calls)
          maxLength: 128
        externalId:
          type: string
          description: Custom ID assigned by the client.
      required:
      - callsConfigurationId
      - endpoint
      title: CallRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailLog:
      type: object
      description: Array of email logs, one object per each email request.
      properties:
        applicationId:
          type: string
          description: The Application ID sent in the email request.
        entityId:
          type: string
          description: The Entity ID sent in the email request.
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the sent email request.
        to:
          type: string
          description: The recipient email address.
        from:
          type: string
          description: From email address.
        text:
          type: string
          description: The text from email body.
        sentAt:
          type: string
          format: date-time
          description: 'Tells when the email was initiated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. '
          example: '2021-01-02T01:00:00.123Z'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the email (i.e. delivered to the destination, waiting for delivery, etc.). '
          example: '2021-01-02T01:00:00.123Z'
        messageCount:
          type: integer
          format: int32
          description: Email request count.
        price:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Price'
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Status'
        error:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Error'
      title: EmailLog
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConnectRequest:
      type: object
      properties:
        callIds:
          type: array
          description: IDs of the calls to connect.
          items:
            type: string
            description: IDs of the calls to connect.
          uniqueItems: true
        conferenceRequest:
          $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest'
      required:
      - callIds
      title: ConnectRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkActionStatus:
      type: string
      description: Status of the last action performed on the SIP trunk configuration.
      enum:
      - CREATING
      - UPDATING
      - DELETING
      - FAILED
      - RESET
      - SUCCESS
      title: SipTrunkActionStatus
    74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResetPasswordResponse:
      type: object
      discriminator:
        propertyName: type
        mapping:
          REGISTERED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkRegisteredResetPasswordResponse'
          AUTHENTICATED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkAuthenticatedResetPasswordResponse'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType'
      title: SipTrunkResetPasswordResponse
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.SortDirection:
      type: string
      enum:
      - ASC
      - DESC
      title: SortDirection
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeUnit:
      type: string
      description: Defines a time unit used for calculating call creation rate.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      title: TimeUnit
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CallPermissionRequestApiData:
      type: object
      description: Call permission request. Presence of this object enables a call permission request feature, no fields are required. When header is media type call permission request will not be displayed on end-user's device.
      title: CallPermissionRequestApiData
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.ToDestination'
        content:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineOnOutboundContent'
        options:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: LineMessage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent:
      type: object
      description: Body of a message containing text only.
      properties:
        text:
          type: string
          description: Content of the message body.
          maxLength: 1024
          minLength: 0
      required:
      - text
      title: InteractiveBodyWhatsAppContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEvent:
      type: object
      description: Collection of conversation started events.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the sent/received message.
        trafficType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConvStartedTrafficType'
        event:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventContent'
        conversation:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedInfo'
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
      required:
      - conversation
      - event
      - messageId
      - platform
      title: RcsConversationStartedEvent
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.RecordingStatus:
      type: string
      description: Recording status provided if recording was attempted.
      enum:
      - HOSTED
      - SFTP
      - FAILED
      title: RecordingStatus
    efc1265916a727aef4eb46ff2e01c3e0ad0c1ad70cf38d568ed99c04a9a73fa0.RingbackGeneration:
      type: object
      description: Option to generate a consistent local ringback tone, overriding remote ringing tones. If enabled, the ringback will be generated for existing conference participants, if present, provided the new participant is added to the conference before its remote ringback starts. If the remote ringback has already started or finished, local ringback generation will not be applied.
      properties:
        enabled:
          type: boolean
          default: false
          description: Flag indicating whether ringback generation is enabled. Cannot be `true` when `connectOnEarlyMedia` is `true`.
      title: RingbackGeneration
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema:
      type: object
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to a recipient.
        bulkId:
          type: string
          description: 'The ID that uniquely identifies the sent bulk.

            This filter will enable you to query delivery reports for all the messages using just one request.

            You will receive a `bulkId` in the response after sending an email request.

            If you don''t set your own `bulkId`, unique ID will be generated by our system and returned in the API response. (Optional Field)")'
        from:
          type: string
          description: 'The email address specified in this field takes precedence over the From header in the MIME message.

            If you leave this field empty, the From address in the MIME message will be used instead.

            If you provide both values and they are different, their domains must match at the organizational level; otherwise, the request will be rejected.

            '
        destinations:
          type: array
          description: 'A list of recipient email addresses.

            <br/>

            The email addresses specified in this field takes precedence over the To, CC, and BCC headers in the MIME message.

            Only the addresses in this list will receive the final email.

            If you leave this field empty, To, CC, and BCC headers in the MIME message will be used instead.

            <br/>

            Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
          items:
            type: string
            description: 'A list of recipient email addresses.

              <br/>

              The email addresses specified in this field takes precedence over the To, CC, and BCC headers in the MIME message.

              Only the addresses in this list will receive the final email.

              If you leave this field empty, To, CC, and BCC headers in the MIME message will be used instead.

              <br/>

              Note: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.'
            maximum: 1000
          maximum: 1000
        mimeMessage:
          type: string
          description: 'This field accepts a complete email message serialized in the MIME format, conforming to RFC 5322 and MIME-related standards (RFCs 2045–2047, RFC 2183).

            The MIME message must be correctly constructed per the following requirements as if it were being sent via traditional SMTP.

            The entire MIME message (including headers and body) must be `base64-encoded` before being sent.

            <br/><br/>


            When using this field, these are the requirements:

            <br/>

            **-** The message must consist of a set of header fields, followed by a blank line (CRLF), and then the message body

            <br/>

            **-** All required and optional fields must be properly formatted with header-name, colon, and header-value

            <br/>

            **-** If any MIME part contains non-7-bit-ASCII data (e.g., UTF-8 text, binaries), that part must be encoded

            <br/>

            **-** If your message uses multipart content (attachments, alternative bodies, etc.), each MIME part must contain `Content-Type` header. For encoded parts, include `Content-Transfer-Encoding`. For attachments, include a valid `Content-Disposition`.

            <br/><br/>

            We also support specifying additional headers in your MIME message, such as `List-Unsubscribe`, `List-Unsubscribe-Post`, `In-Reply-To`, `References` and `Message-ID`.

            '
        intermediateReport:
          type: boolean
          description: The real-time Intermediate delivery report that will be sent on your callback server.
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional client data that will be sent on the notifyUrl.
          maximum: 4000
          minimum: 0
        trackingUrl:
          type: string
          description: The URL on your callback server on which the open and click notifications will be sent. See [Tracking Notifications](https://www.infobip.com/docs/email/email-over-api/tracking-notifications) for details.
        clientPriority:
          type: string
          default: STANDARD
          description: 'Adds a priority rating to this email message.

            Allowed values are `HIGH`, `STANDARD` and `LOW`.

            Messages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account.

            If no priority value is provided, messages will be treated with `STANDARD` priority by default.

            '
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events.
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events.
      required:
      - mimeMessage
      title: SendMimeRequestSchema
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestination:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationTo'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationCc'
      description: Recipients of group MMS.
      title: MoDestination
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineData:
      type: object
      description: Line-specific data used if the message is sent through a Line channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        type:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.LineDataType'
        url:
          type: string
          description: Url of the image sent in the Line message. Max 1000 characters.
          maxLength: 1000
          minLength: 0
          writeOnly: true
        thumbnailUrl:
          type: string
          description: Thumbnail of the image sent in the Line message. Max 1000 characters.
          maxLength: 1000
          minLength: 0
          writeOnly: true
        duration:
          type: integer
          format: int64
          description: Duration of the audio file.
          writeOnly: true
        packageId:
          type: string
          description: Package id of sticker that will be sent.
          writeOnly: true
        stickerId:
          type: string
          description: Sticker id that will be sent.
          writeOnly: true
        altText:
          type: string
          maxLength: 400
          minLength: 0
        contents:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer'
      required:
      - altText
      - contents
      - duration
      - packageId
      - stickerId
      - thumbnailUrl
      - url
      title: LineData
      writeOnly: true
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListItem:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Unique identifier of the email template.
          example: 1000000000000000001
        name:
          type: string
          description: Name of the email template.
          example: Welcome email
        imagePreviewUrl:
          type: string
          description: Image preview URL
          example: /email/1/templates/1000000000000000001/preview.png
        createdAt:
          type: string
          format: date-time
          description: 'Date and time when the email template was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        updatedAt:
          type: string
          format: date-time
          description: 'Date and time when the email template was last updated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      required:
      - id
      title: EmailTemplateListItem
    9ddf5548c4806a579a37575477f73704a9d1f23ccda5d683f70483437522f25d.StatusRequest:
      type: object
      description: Status request.
      properties:
        action:
          type: string
          description: Requested action (dial, audio, captureDtmf).
        from:
          type: string
          description: Caller phone number.
        to:
          type: string
          description: Called phone number.
        transferTo:
          type: string
          description: Called party phone number that the call is transferred to.
        duration:
          type: integer
          format: int32
          description: Duration of the outbound call shown in seconds
        status:
          type: string
          description: 'Call status which can be: answered, busy, no answer, failed or congestion'
        nmCorrelationId:
          type: string
          description: Unique identifier for correlation with inbound call, available in Callback and Status requests.
        fileID:
          type: string
          description: Identifier of the file played to the caller.
        fileUrl:
          type: string
          description: The URL of the file played to the caller.
        ringingTime:
          type: string
          description: Date and time when ringing started.
        answeredTime:
          type: string
          description: Date and time when the call was answered.
        correlationId:
          type: string
          description: Unique identifier of the call record, available for both Callback and Status requests.
        inboundDuration:
          type: integer
          format: int32
          description: Duration of the inbound call shown in seconds.
        calculatedDuration:
          type: integer
          format: int32
          description: The duration of the outbound part of the number masking session, where the voice billing model (1/1, 15/15,...) has been applied to the calculatedDuration.
        pricePerSecond:
          type: number
          format: double
          description: This is the price per second for the outbound part of the number masking session, with the price being expressed in cents per second.
        currency:
          type: string
          description: The currency in which the price is expressed.
        recordingFileId:
          type: string
          description: ID of a recording file of a call.
        recordCalleeAnnouncement:
          type: boolean
          description: Flag that indicates if callee announcement is included in recording file.
        recordingStatus:
          $ref: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.RecordingStatus'
        machineDetectionResult:
          $ref: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.MachineDetectionResult'
        clientReferenceId:
          type: string
          description: Client-defined ID of a valid file name. Used to correlate a call with this reference. If recording is enabled and files are stored in the SFTP server, that ID will be used as a file name instead.
      title: StatusRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SingleMessageStatus:
      type: object
      description: Indicates whether the message has been successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
        id:
          type: integer
          format: int32
          description: Status ID.
        name:
          type: string
          description: Status name.
        description:
          type: string
          description: Human-readable description of the status.
      title: SingleMessageStatus
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessage:
      type: object
      description: Collection of mobile originated messages.
      properties:
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        interactionType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType'
        rcsCount:
          type: integer
          format: int32
          description: A field that informs the client how many segment counts does a MO message contain. Can be received as > 1 for use case of Rich message in USA.
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundMessageContent'
        price:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoMessagePrice'
        conversation:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo'
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo'
      required:
      - conversation
      - integrationType
      - interactionType
      - message
      - messageId
      - platform
      - price
      - rcsCount
      - receivedAt
      - sender
      - to
      title: RcsInboundMessage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.StickerContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: StickerMessage
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApi:
      type: object
      description: Call API Action performs an HTTP request to a client’s endpoint, and (if told to) processes the response data. If collectResponse is set, the system will attempt to parse the response from the server. Our platform needs to be able to make HTTP requests to the specified endpoint.
      properties:
        request:
          type: string
          description: The URL to target. The parameter can be constructed using variables.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApiOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - options
      - request
      title: Call API
    4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferencePlayRequest:
      type: object
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the file will be played.
        content:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent'
      required:
      - content
      title: ConferencePlayRequest
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLog:
      type: object
      description: Results.
      properties:
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        to:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        messageId:
          type: string
          description: Unique message ID.
        title:
          type: string
          description: Message title.
        messageSegments:
          type: array
          description: Content of the message being sent.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsLogsMessageSegment'
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, delivered to the destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        mmsCount:
          type: integer
          format: int32
          description: The number of parts the message content was split into.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price'
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Status'
        error:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Error'
        applicationId:
          type: string
          description: The application used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        entityId:
          type: string
          description: The entity used when sending the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      title: MMSMtLog
    1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteRequest:
      type: object
      description: Route request object.
      properties:
        name:
          type: string
          description: Route name.
        criteria:
          type: array
          description: List of criteria used to match a route. For a route to match, any criterion should be met.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SearchCriteria'
        destinations:
          type: array
          description: List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination'
          maxItems: 10
          minItems: 1
        transferOnly:
          type: boolean
          default: false
          description: Indicates whether this route should be used exclusively for call transfers initiated via the REFER SIP message. The `to` number value will be taken from the `Refer-To` header.
      required:
      - destinations
      - name
      title: RouteRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContentType:
      type: string
      enum:
      - TEXT
      - LOCATION
      - IMAGE
      - DOCUMENT
      - AUDIO
      - VIDEO
      - VOICE
      - CONTACT
      - INFECTED_CONTENT
      - BUTTON
      - STICKER
      - INTERACTIVE_BUTTON_REPLY
      - INTERACTIVE_LIST_REPLY
      - INTERACTIVE_FLOW_REPLY
      - INTERACTIVE_PAYMENT_CONFIRMATION
      - INTERACTIVE_CALL_PERMISSION_REPLY
      - INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY
      - ORDER
      - REACTION
      - UNSUPPORTED
      title: WhatsAppInboundContentType
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.LogKakaoSangdamOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessagePrice'
        status:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageStatus'
        error:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageError'
        platform:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform'
        content:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogKakaoSangdamOutboundContent
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponse:
      type: object
      example:
        status: MESSAGE_ACCEPTED
      properties:
        status:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponseStatus'
      title: OpenChannelMessageResponse
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IysRecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Dial:
      type: object
      description: Dial action performs a call redirection, joining the user's call with another destination. Dial must be the last action.
      properties:
        dial:
          type: string
          description: must be a valid E164 MSISDN; the parameter can be constructed using variables
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - dial
      title: Dial
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    d32f709b8e696d073f5212b1e1d90721a8fd1118bf2c8abce078bf2baf7d1707.SubdomainPage:
      type: array
      items:
        $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SubdomainResponse'
      properties:
        empty:
          type: boolean
        first:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SubdomainResponse'
        last:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SubdomainResponse'
      title: SubdomainPage
    f7a48ff9966e7ac9fef5292e0b74f7ccc796492cacffd985bfded901992c414b.TemplateApiResponse:
      type: object
      description: The list of the results for this page.
      discriminator:
        propertyName: category
        mapping:
          MARKETING: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultMarketingTemplateApiResponse'
          UTILITY: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateApiResponse'
          AUTHENTICATION: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.AuthenticationTemplateApiResponse'
      properties:
        id:
          type: string
          description: Template ID.
          example: '111'
        businessAccountId:
          type: integer
          format: int64
          description: Business account ID to which template belongs.
          example: 222
        name:
          type: string
          description: Name of the template.
          example: template_name
        language:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Language'
        status:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status'
        category:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.WhatsAppCategory'
        structure:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.DefaultTemplateStructureApiData'
        quality:
          type: string
          description: Quality of the template.
          enum:
          - HIGH
          - MEDIUM
          - LOW
          - UNKNOWN
          example: HIGH
        platform:
          $ref: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Platform'
        createdAt:
          type: string
          format: date-time
          description: Creation date of the template.
        lastUpdatedAt:
          type: string
          format: date-time
          description: Last update date of the template.
        libraryTemplateName:
          type: string
          description: Name of the library template from which this template was created. If not present, the template was not created using the template library.
      required:
      - structure
      title: TemplateResponse
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessInfoResponse:
      type: object
      properties:
        about:
          type: string
          description: Manages the content of the sender\'s **About** section.
          example: Infobip Business Account
        address:
          type: string
          description: Street address of the business.
          example: 35-38 New Bridge Street, London EC4V 6BW
        description:
          type: string
          description: Description of the business.
          example: Infobip is a global cloud communications platform.
        email:
          type: string
          description: Email of the business.
          example: info@example.com
        vertical:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical'
        websites:
          type: array
          description: Websites of the business.
          example: https://www.infobip.com
          items:
            type: string
            description: Websites of the business.
            example: https://www.infobip.com
        displayName:
          type: string
          description: Display name of the phone number.
          example: Infobip
      required:
      - about
      - address
      - description
      - displayName
      - email
      - vertical
      - websites
      title: BusinessInfoResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactsContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        contacts:
          type: array
          description: An array of contacts sent in a WhatsApp message.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ContactContent'
      required:
      - contacts
      title: ContactsContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationGroup:
      type: object
      description: '---'
      properties:
        group:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationSingle'
          maxItems: 200
          minItems: 1
      required:
      - group
      title: Group of destinations
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CaptureDtmfCallbackUrl:
      type: object
      description: Callback URL configuration for captureDtmf action.
      properties:
        url:
          type: string
          description: Callback URL.
        method:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod'
        callOnEmpty:
          type: boolean
          default: false
          description: Whether to invoke the callback URL when no DTMF digits were collected.
      required:
      - url
      title: CaptureDtmfCallbackUrl
    be917819c3f3f7072f44fe3d7909e7b833fe4857710e7f5ab585df108ef1ed5b.RecordingTransferOptions:
      type: object
      description: Options that control how call recording should behave after the application transfer.
      properties:
        continueCallRecording:
          type: boolean
          default: false
          description: Continue recording on the transferred call.
      title: RecordingTransferOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventRequest:
      type: object
      properties:
        events:
          type: array
          description: An array of event objects of the events to be sent.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEvent'
      required:
      - events
      title: RcsEventRequest
    5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogWithExistingCallsRequest:
      type: object
      properties:
        recording:
          $ref: '#/components/schemas/14b5f31f4f292db4a32c4e61928f9a47f8ff4c0a1c06a38af2c29ef9ca05095d.DialogRecordingRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
        propagationOptions:
          $ref: '#/components/schemas/5fc49137a7b003ca1d8c4957601417b8ed884356b7fbc49afe416dd5c098a0bd.DialogPropagationOptions'
      title: DialogWithExistingCallsRequest
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListPage:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplateListItem'
        paging:
          $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.PageInfo'
      required:
      - paging
      - results
      title: EmailTemplateListPage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonActionContent'
        header:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      - body
      title: InteractiveUrlButtonContent
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ApplicationType:
      type: string
      enum:
      - CALL_LINK
      title: ApplicationType
    a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusRequest:
      type: object
      description: Bulk status request object.
      properties:
        status:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus'
      required:
      - status
      title: BulkStatusRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        sentAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
        applicationId:
          type: string
          description: Application id that the message is linked to.
        entityId:
          type: string
          description: Entity id that the message is linked to.
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: SeenReport
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Regional:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        southKorea:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsSouthKoreaOptions'
      title: Regional
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderLaunchStatusEvent:
      type: object
      description: Launch status information for the sender including coverage details by country and provider.
      properties:
        event:
          type: string
          description: Event type identifier for webhook notifications. Indicates the type of status change that occurred.
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
        coverage:
          type: array
          description: Coverage information by country showing launch status for each provider.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.CountryCoverage'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when launch status has been updated last time.
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - coverage
      - event
      - senderName
      - senderStatus
      - updatedAt
      title: RcsSenderLaunchStatusEvent
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransaction:
      type: object
      description: Transactions of the payment.
      properties:
        id:
          type: string
          description: Unique identifier of the transaction.
          example: '27194245144'
        type:
          $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionType'
        status:
          $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionStatus'
        createdTimestamp:
          type: string
          format: date-time
          description: Creation time of the transaction.
        updatedTimestamp:
          type: string
          format: date-time
          description: Update time of the transaction.
      required:
      - createdTimestamp
      - id
      - status
      - type
      - updatedTimestamp
      title: PaymentTransaction
    fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Status:
      type: object
      description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status [group ID](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes).
        groupName:
          type: string
          description: Status [group name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes).
        id:
          type: integer
          format: int32
          description: Status [ID](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes).
        name:
          type: string
          description: Status [name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes).
        description:
          type: string
          description: Human-readable [description](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes) of the status.
        action:
          type: string
          description: '[Action](https://www.infobip.com/docs/essentials/response-status-and-error-codes#http-status-codes) that should be taken to eliminate the error.'
      title: Status
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundTextContent'
          IMAGE: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundImageContent'
          VIDEO: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundVideoContent'
          FILE: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundFileContent'
          CAROUSEL: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundCarouselContent'
          LOCATION: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundLocationContent'
          CONTACT: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContactContent'
          STICKER: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundStickerContent'
          URL: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundUrlContent'
      properties:
        type:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContentType'
      title: ViberBotOutboundContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEvent:
      type: object
      description: Collection of mobile originated events.
      properties:
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        interactionType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventInteractionType'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContent'
        price:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoEventMessagePrice'
        conversation:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo'
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsPlatformInfo'
      required:
      - conversation
      - integrationType
      - interactionType
      - message
      - messageId
      - platform
      - price
      - receivedAt
      - sender
      - to
      title: RcsInboundEvent
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LivechatInboundMessage:
      type: object
      description: Incoming messages.
      properties:
        from:
          type: string
          description: Live Chat registration ID of the person who sent the message.
        to:
          type: string
          description: Live Chat widget ID which was used to send the message.
        integrationType:
          type: string
          description: Message channel which was used to send the message. It is always LIVE_CHAT in this case.
        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.
        callbackData:
          type: string
          description: Callback data sent through the ‛callbackData‛ field when sending a message.
        message:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundContent'
        threadId:
          type: string
          description: The ID that uniquely identifies the conversation thread.
        currentLanguage:
          type: string
          description: Widget language at the time the message was sent.
        userData:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserData'
        price:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.MessagePrice'
      required:
      - from
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - to
      title: LivechatInboundMessage
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.EmailData:
      type: object
      description: Email-specific data used if the message is sent through an email channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          maxLength: 2147483647
          minLength: 1
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        subject:
          type: string
          description: Message subject.
          writeOnly: true
      title: EmailData
      writeOnly: true
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeTo:
      type: object
      description: The exact time of day to end sending messages. Time is expressed in the UTC time zone. If set, use it together with the `from` property with minimum 1 hour difference.
      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
          writeOnly: true
        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
          writeOnly: true
      required:
      - hour
      - minute
      title: DeliveryTimeTo
      writeOnly: true
    c8006fe0d154740d4f3e0ed89b54c9c54d35edf85894782dbfe7d9ae0ea23725.UpdateStatusRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BulkStatus'
      required:
      - status
      title: UpdateStatusRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType:
      type: string
      default: NONE
      description: Preferred presentation of anonymized calls.
      enum:
      - NONE
      - REMOTE_PARTY_ID
      - ASSERTED_IDENTITY
      - PREFERRED_IDENTITY
      title: AnonymizationType
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.DeliveryTimeWindow:
      type: object
      description: Sets specific SMS delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent.
      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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryDay'
          writeOnly: true
        from:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeFrom'
        to:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.DeliveryTimeTo'
      required:
      - days
      title: DeliveryTimeWindow
      writeOnly: true
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateData:
      type: object
      description: Media template definitions
      properties:
        header:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateHeaderContent'
        body:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateBodyContent'
        buttons:
          type: array
          description: Media template buttons
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.MediaTemplateButtonContent'
          writeOnly: true
      required:
      - body
      title: MediaTemplateData
      writeOnly: true
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Error:
      type: object
      description: Indicates whether the error occurred during the query execution.
      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.
      title: Error
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveButtonContent:
      type: object
      description: An array of buttons sent in a message. It can have up to three buttons.
      discriminator:
        propertyName: type
        mapping:
          REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveReplyButtonContent'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveButtonContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductActionContent:
      type: object
      description: Allows you to specify catalog and product details sent in the multi-product message.
      properties:
        catalogId:
          type: string
          description: The ID that uniquely identifies the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging) registered with Facebook and connected to the WhatsApp Business Account the sender belongs to.
        sections:
          type: array
          description: An array of multi product sections.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductSectionContent'
          maxItems: 10
          minItems: 1
      required:
      - catalogId
      - sections
      title: InteractiveMultiProductActionContent
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryDay'
        from:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryTime'
        to:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicDialogState:
      type: string
      description: Dialog state.
      enum:
      - CREATED
      - PRE_ESTABLISHED
      - ESTABLISHED
      - FINISHED
      - FAILED
      - TRANSFERRING
      title: PublicDialogState
    999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.ErrorInfo:
      type: object
      description: Messages not delivered to users.
      properties:
        registration:
          type: integer
          format: int64
          description: Messages not delivered due to errors with non-valid registrations due to user uninstalling the app.
        expired:
          type: integer
          format: int64
          description: Messages undelivered due to expired validity period. Indicates users who have disabled notifications on a specific Push application.
        cloud:
          type: integer
          format: int64
          description: Messages not delivered due to errors on APNS or FCM clouds. Happens due to transient errors on cloud services.
      required:
      - cloud
      - expired
      - registration
      title: ErrorInfo
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContentType:
      type: string
      enum:
      - TYPING_INDICATOR
      - MARK_AS_READ
      title: TikTokOutboundEventContentType
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateListItem:
      type: object
      properties:
        name:
          type: string
          description: Template name.
        type:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateContentType'
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiStatus'
        lastUpdate:
          type: string
          format: date-time
          description: 'Date and time when the template was updated. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      required:
      - lastUpdate
      - name
      - status
      - type
      title: RcsTemplateListItem
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.EventType:
      type: string
      description: Type determining content of received event.
      enum:
      - DTMF_CAPTURED
      - CALL_ESTABLISHED
      - CALL_PRE_ESTABLISHED
      - CALL_MEDIA_CHANGED
      - CALL_FINISHED
      - CALL_FAILED
      - CALL_RECEIVED
      - CALL_STARTED
      - CALL_RECORDING_STARTED
      - CALL_RECORDING_FAILED
      - CALL_RECORDING_READY
      - CALL_RECORDING_STOPPED
      - CONFERENCE_RECORDING_STARTED
      - CONFERENCE_RECORDING_FAILED
      - CONFERENCE_RECORDING_READY
      - CONFERENCE_RECORDING_STOPPED
      - CALL_RINGING
      - CONFERENCE_CREATED
      - CONFERENCE_FINISHED
      - ERROR
      - PARTICIPANT_MEDIA_CHANGED
      - PARTICIPANT_JOIN_FAILED
      - PARTICIPANT_JOINED
      - PARTICIPANT_JOINING
      - PARTICIPANT_RECORDING_FAILED
      - PARTICIPANT_REMOVED
      - PARTICIPANT_STARTED_TALKING
      - PARTICIPANT_STOPPED_TALKING
      - PARTICIPANT_ROLE_CHANGED
      - PARTICIPANT_ROLE_CHANGE_FAILED
      - PLAY_FINISHED
      - CONFERENCE_COMPOSITION_FAILED
      - CONFERENCE_COMPOSITION_FINISHED
      - SAY_FINISHED
      - MACHINE_DETECTION_FINISHED
      - MACHINE_DETECTION_FAILED
      - MACHINE_MESSAGE_DETECTION_FINISHED
      - MACHINE_MESSAGE_DETECTION_FAILED
      - MEDIA_STREAM_STARTED
      - MEDIA_STREAM_FAILED
      - MEDIA_STREAM_FINISHED
      - APPLICATION_TRANSFER_REQUESTED
      - APPLICATION_TRANSFER_FAILED
      - APPLICATION_TRANSFER_FINISHED
      - DIALOG_CREATED
      - DIALOG_ESTABLISHED
      - DIALOG_FAILED
      - DIALOG_FINISHED
      - DIALOG_RECORDING_STARTED
      - DIALOG_RECORDING_FAILED
      - DIALOG_RECORDING_READY
      - DIALOG_RECORDING_STOPPED
      - DIALOG_COMPOSITION_FAILED
      - DIALOG_COMPOSITION_FINISHED
      - TRANSCRIPTION
      - SPEECH_CAPTURED
      - BULK_CALL_STATUS
      - CONFERENCE_RECORDING_DELETED
      - DIALOG_RECORDING_DELETED
      - CALL_RECORDING_DELETED
      - CALL_DISCONNECTED
      - CALL_RECONNECTED
      - DIALOG_TRANSFER_REQUESTED
      - DIALOG_TRANSFER_FAILED
      - DIALOG_TRANSFER_FINISHED
      title: EventType
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateApiCountryCoverage:
      type: object
      description: Coverage information by country showing template status for each provider.
      properties:
        countryCode:
          type: string
          description: Country code where the template is being registered.
        providers:
          type: array
          description: List of template providers in the country and their template registration status.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProviderStatusDetails'
      required:
      - countryCode
      - providers
      title: RcsTemplateApiCountryCoverage
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoTextSegment:
      type: object
      properties:
        contentType:
          type: string
          description: Content type of the message segment `text/plain`.
        value:
          type: string
          description: Message text.
      title: Text segment
    6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkUpdateRequest:
      type: object
      discriminator:
        propertyName: type
        mapping:
          STATIC: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StaticSipTrunkUpdateRequest'
          REGISTERED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RegisteredSipTrunkUpdateRequest'
          PROVIDER: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ProviderSipTrunkUpdateRequest'
          AUTHENTICATED: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AuthenticatedSipTrunkUpdateRequest'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType'
        name:
          type: string
          description: SIP trunk name.
        internationalCallsAllowed:
          type: boolean
          default: false
          description: Indicates whether international calls should be allowed. Calls between different countries are considered international.
        channelLimit:
          type: integer
          format: int32
          description: Maximum number of concurrent channels.
          maximum: 1000
      required:
      - name
      title: SipTrunkUpdateRequest
    4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceBroadcastWebrtcTextRequest:
      type: object
      properties:
        text:
          type: string
          description: Text to broadcast.
      title: ConferenceBroadcastWebrtcTextRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveCallPermissionRequestMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - from
      - to
      title: InteractiveCallPermissionRequestMessage
    87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        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:
          type: string
          description: Set the title or subject of a message. South Korea only.
          maxLength: 66
          minLength: 0
      title: SouthKoreaOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.UrlOptions'
      title: DefaultMessageRequestOptions
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: Use Application Code or Application ID of application profile, [application profile](https://www.infobip.com/docs/mobile-push/get-started/mobile-application-profile#copy-application-code-create-and-enable-a-mobile-application-profile), created in Infobip web interface.
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required. When using a `MULTIPLE` type, at least one property is required.
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestination'
        content:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContent'
        options:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushUnificationMessageOptions'
        webhooks:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: PushUnificationMessage
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Webhook:
      type: object
      description: Webhook triggered when there is a call event.
      properties:
        url:
          type: string
          description: Your webhook URL.
        securityConfig:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfig'
      required:
      - url
      title: Webhook
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    790123005ad6e23bd7e4622ede8f0ed5301700e1d8b1837e5f4cdfdda800eaa2.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.SipTrunkPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: SipTrunkPage
    ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.Payload:
      type: object
      properties:
        eventId:
          type: string
          format: uuid
          description: Unique ID of the event. This ID can be used for deduplication purposes.
        createdAt:
          type: integer
          format: int64
          description: Epoch milliseconds when the event occurred.
        eventDetails:
          $ref: '#/components/schemas/ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.EventDetails'
      required:
      - createdAt
      - eventDetails
      - eventId
      title: Payload
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageRequestOptions:
      type: object
      properties:
        schedule:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.UrlOptions'
        messageOrdering:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageOrderingOptions'
      title: RcsMessageRequestOptions
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventType:
      type: string
      description: Conversation started event type.
      enum:
      - CONVERSATION_STARTED
      - CONVERSATION_STARTED
      title: RcsConversationStartedEventType
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CreateTemplateRequest:
      type: object
      description: Request to create a new ZBS template in Zalo.
      properties:
        templateName:
          type: string
          description: Template name.
          maxLength: 60
          minLength: 10
        templateContent:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateContent'
        params:
          type: array
          description: Template parameters for dynamic content.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateParameter'
        note:
          type: string
          description: Template note.
          maxLength: 400
          minLength: 1
        trackingId:
          type: string
          description: Tracking identifier.
          maxLength: 200
          minLength: 1
      required:
      - note
      - templateContent
      - templateName
      - trackingId
      title: CreateTemplateRequest
    a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkRequest:
      type: object
      description: Bulk request object.
      properties:
        sendAt:
          type: string
          format: date-time
          description: Rescheduled timestamp of the bulk.
      required:
      - sendAt
      title: BulkRequest
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotification:
      type: object
      properties:
        sender:
          type: string
          description: Registered WhatsApp sender number.
          minLength: 1
        from:
          type: string
          description: End user's phone number.
          minLength: 1
        notificationMessagesStatus:
          type: string
          description: Status of marketing update notification.
          minLength: 1
        description:
          type: string
          description: Description of marketing update notification.
          minLength: 1
      title: whatsappMarketingUpdateNotification
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.MachineMessageDetectionCallbackRequest:
      type: object
      description: Markup Language machine message detection callback request object. Sent to the callback URL configured on the Markup Language configuration (markupUrl) once machine message detection has completed. Extends the instructions callback payload with the machine detection result.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        machineDetectionResult:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus'
      title: MachineMessageDetectionCallbackRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEvent:
      type: object
      description: An array of event objects of the events to be sent.
      properties:
        sender:
          type: string
          description: Identifier of an RCS sender that will be used to send event.
        destinations:
          type: array
          description: An array of destination objects for where the event is being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ToDestination'
        content:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContent'
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventOptions'
      required:
      - content
      - destinations
      - sender
      title: RcsEvent
    5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationsResponse:
      type: object
      properties:
        applications:
          type: array
          description: List of applications.
          items:
            $ref: '#/components/schemas/5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationResponse'
      required:
      - applications
      title: ApplicationsResponse
    52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.WABAConversionEventRequest:
      type: object
      properties:
        sourceId:
          type: string
          description: Sender as source identifier. This is the phone number registered via the embedded signup flow available in Exchange app.
          example: '1234567890'
        conversions:
          type: array
          description: Conversion events collection.
          items:
            $ref: '#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionModel'
          maxItems: 1000
          minItems: 1
      required:
      - conversions
      - sourceId
      title: WABAConversionEventRequest
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ApiBulkRequest:
      type: object
      description: Validations request
      properties:
        validationRequestId:
          type: string
          description: 'Unique identifier for the bulk email validation request. Provide your own or leave it blank to have one generated automatically.

            '
          maxLength: 200
          minLength: 0
        destinations:
          type: array
          description: Array of email addresses to be validated.
          items:
            $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationDestination'
          maxItems: 100000
          minItems: 1
      required:
      - destinations
      title: ApiBulkRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendToReports:
      type: string
      description: 'Choose if you want to show DTMF inputs in Voice reports and logs. Options are: ALWAYS (always send - default value), MASKED (send masked - xxxx will be shown in reports and logs), NEVER (don''t send - DTMF inputs will not be shown in reports and logs).'
      enum:
      - ALWAYS
      - MASKED
      - NEVER
      title: SendToReports
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.Status:
      type: string
      description: Status of the template.
      enum:
      - APPROVED
      - IN_APPEAL
      - PENDING
      - REJECTED
      - PENDING_DELETION
      - DELETED
      - REINSTATED
      - FLAGGED
      - FIRST_PAUSED
      - SECOND_PAUSED
      - DISABLED
      example: APPROVED
      title: Status
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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
    fccfa6f52b47dd30d36e2c1fad9bb5d494251b453352b21aeb7a407c6f1eeb5c.Price:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: Price
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.SendingSpeedLimit'
      title: RequestSchedulingSettings
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationRegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an MMS to requires additional information.
      properties:
        southKorea:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationSouthKoreaOptions'
      title: MmsUnificationRegionalOptions
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ClientPriority:
      type: string
      description: Client priority set on request. Must be 'HIGH', 'STANDARD' or 'LOW'.
      enum:
      - HIGH
      - STANDARD
      - LOW
      title: ClientPriority
    a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicDialogRecording:
      type: object
      properties:
        dialogId:
          type: string
          description: Unique dialog ID.
          example: 034e622a-cc7e-456d-8a10-0ba43b11aa5e
          maxLength: 128
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
          example: dc5942707c704551a00cd2ea
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        composedFiles:
          type: array
          description: File(s) with a recording of both dialog participants.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
        callRecordings:
          type: array
          description: File(s) with a recording of one dialog participant.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
        startTime:
          type: string
          format: date-time
          description: Date and time when the (first) recording started.
        endTime:
          type: string
          format: date-time
          description: Date and time when the (last) recording ended.
      title: PublicDialogRecording
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SeenReport'
      title: SeenReports
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.AttachmentList:
      type: array
      items:
        $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'
      properties:
        size:
          type: integer
          format: int32
        empty:
          type: boolean
        first:
          $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'
        last:
          $ref: '#/components/schemas/39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.Attachment'
      title: AttachmentList
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsData:
      type: object
      properties:
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToConversationsOptions'
      required:
      - options
      title: DialToConversationsData
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContent:
      type: object
      description: Event content.
      discriminator:
        propertyName: type
        mapping:
          SEEN: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventSeenContent'
          TYPING_INDICATOR: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventTypingIndicatorContent'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsOutboundEventContentType'
      required:
      - type
      title: RcsOutboundEventContent
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRequestContactInfoContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
      required:
      - body
      title: InteractiveRequestContactInfoContent
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushDestinationType:
      type: string
      enum:
      - EXTERNAL_USER_ID
      - EMAIL
      - PHONE_NUMBER
      - REGISTRATION
      - MULTIPLE
      title: PushDestinationType
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryDay'
        from:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime'
        to:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegmentType:
      type: string
      enum:
      - TEXT
      - LINK
      - SMIL
      - UPLOADED_REFERENCE
      title: MmsOutboundSegmentType
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEventRequest:
      type: object
      properties:
        events:
          type: array
          description: An array of event objects of the events to be sent.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbEvent'
        options:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultEventRequestOptions'
      required:
      - events
      title: AppleMfbEventRequest
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.NonMsisdnSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RegionalOptions'
        destinationMatching:
          type: array
          description: The SMS failover destination matching.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FailoverDestinationPair'
      required:
      - text
      title: NonMsisdnSmsFailover
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMtQuickReplyContentType:
      type: string
      enum:
      - TEXT
      - PHONE_NUMBER
      - EMAIL
      title: FacebookMtQuickReplyContentType
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FileFormat:
      type: string
      description: File format.
      enum:
      - MP3
      - WAV
      - MP4
      example: WAV
      title: FileFormat
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.AddDomainRequest:
      type: object
      properties:
        domainName:
          type: string
          description: Unique name for the domain.
          example: example.com
          maxLength: 100
          maximum: 100
          minLength: 0
        dkimKeyLength:
          type: integer
          format: int32
          default: 2048
          description: Value for DKIM key length.
          enum:
          - 1024
          - 2048
          example: 1024
        targetedDailyTraffic:
          type: integer
          format: int64
          description: Targeted daily traffic.
          example: 1000
          minimum: 1
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events.
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events.
      required:
      - domainName
      - targetedDailyTraffic
      title: AddDomainRequest
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberRequestAcceptedResponse:
      type: object
      properties:
        senderName:
          type: string
          description: Unique identifier of a sender for which test number is associated.
        testNumber:
          type: string
          description: Full number in E.164 format, e.g. +1234567890. Leading '+' is optional.
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus'
      required:
      - senderName
      - status
      - testNumber
      title: RcsTestNumberRequestAcceptedResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FilePageResponse:
      type: object
      properties:
        results:
          type: array
          description: List of results for the requested page.
          items:
            $ref: '#/components/schemas/ffb4c29a0ab7c4ca15544ca9d6ceffaf3e8b394d7fc1a53728ba61496b4513fc.FileResponse'
        pageInfo:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo'
      title: FilePageResponse
    49bee00604d221bf98890cc8ca36403a588d28255383650998e0c4df2f9a5b4f.RecipientInfo:
      type: object
      description: Recipient information such as device type, OS, device name.
      properties:
        deviceType:
          type: string
          description: The type of device used by the recipient to do the user action.
        os:
          type: string
          description: The type OS present in the device used by the recipient.
        deviceName:
          type: string
          description: Device name of the action originating device.
      title: RecipientInfo
    1705572441d20bbbfe49765ca2bed87cd314f9c5c501048d5a9494385ff9f223.SMSReportResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsReport'
      title: SMSReportResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.WebrtcRecordingPageResponse:
      type: object
      properties:
        results:
          type: array
          description: List of results for this page.
          items:
            $ref: '#/components/schemas/6a67def771061fe877b7bafa26c22e83ef5c7b44e2a298a70b54e0ed657fe102.RecordingResponse'
        pageInfo:
          $ref: '#/components/schemas/7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.PageInfo'
      title: WebrtcRecordingPageResponse
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Price:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per message.
        currency:
          type: string
          description: Currency.
      title: Price
    49f1996e051117ce119ddfc3e07857856b24a0d3f7351242fd9c4615508a2845.VoicePreferences:
      type: object
      description: Voice preferences for text-to-speech.
      properties:
        voiceGender:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Gender'
        voice:
          type: string
          description: Voice name in which text would be synthesized. More info about available languages and voices can be found [here](https://www.infobip.com/docs/voice-and-video/reference#available-voices-by-language). Use value from Name column in the table.
          example: Joanna
      title: VoicePreferences
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ReportResponse:
      type: object
      properties:
        results:
          type: array
          description: Arrays of delivery reports, one object for every message.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Report'
      title: ReportResponse
    4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceSendMessageRequest:
      type: object
      properties:
        message:
          type: string
          description: Message to send.
      required:
      - message
      title: ConferenceSendMessageRequest
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotificationResponse:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number.
          minLength: 1
        content:
          allOf:
          - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.PaymentNotification'
          description: Content of the notification.
        createdAt:
          type: string
          format: date-time
          description: 'Tells when the event occurred. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      title: whatsappPaymentNotificationResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportResponse:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReport'
      title: MMSReportResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrderType:
      type: string
      description: Type of the goods offered in the order.
      enum:
      - PHYSICAL_GOODS
      - DIGITAL_GOODS
      title: OrderType
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SetVariable:
      type: object
      description: Set variable action makes it possible to set a variable defined inside the IVR scenario to a specified value.
      properties:
        setVariable:
          type: string
          description: Name of a variable.
        value:
          type: string
          description: Value to which the variable should be set. The parameter can be constructed using variables.
      required:
      - setVariable
      - value
      title: Set Variable
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.BinaryContent:
      type: object
      properties:
        dataCoding:
          type: integer
          format: int32
          description: 'Binary content data coding. The default value is (`0`) for GSM7. Example: (`8`) for  Unicode data.'
          writeOnly: true
        esmClass:
          type: integer
          format: int32
          description: “Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (`0`).
          writeOnly: true
        hex:
          type: string
          description: 'Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character (Example: `0f c2 4a bf 34 13 ba`).'
          writeOnly: true
      required:
      - hex
      title: BinaryContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent:
      type: object
      description: Audio content to play. It can either be previously uploaded file or a file from a URL.
      discriminator:
        propertyName: type
        mapping:
          FILE: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FilePlayContent'
          URL: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.UrlPlayContent'
          RECORDING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingPlayContent'
          TEXT: '#/components/schemas/00a1f95ecbb89787a99eae13916106d1d4d9cc2934634cfbf0d16daa73fd2cf0.TextPlayContent'
          TTY: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TtyPlayContent'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContentType'
      title: PlayContent
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderUpdateEvent:
      type: object
      description: Collection of RCS sender update events
      properties:
        event:
          type: string
          description: Event type identifier for webhook notifications. Indicates the type of status change that occurred.
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
        googleAgentId:
          type: string
          description: Google Agent ID associated with this sender. Only included during the first transition to READY_FOR_TESTING status.
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when sender has been updated last time.
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
      required:
      - event
      - senderName
      - senderStatus
      - updatedAt
      title: RcsSenderUpdateEvent
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.RequestSchedulingSettings'
      title: InstagramDmMessageRequestOptions
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters:
      type: object
      description: Platform parameters that would be associated with the sender. Please note that platform parameters must be created before they can be associated with the sender. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        applicationId:
          type: string
          description: ID of the Application that would be associated with the sender.
          maxLength: 255
          minLength: 1
        entityId:
          type: string
          description: ID of the Entity that would be associated with the sender.
          maxLength: 255
          minLength: 1
      title: PlatformParameters
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferenceLogPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: ConferenceLogPage
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.InitialOptions:
      type: object
      description: User options available when a user opens a call link page before initiating the call. Depending on the fields, certain options for the call will be shown to a user.
      properties:
        audio:
          type: boolean
          default: true
          description: User will be able to initiate the audio call.
        video:
          type: boolean
          default: true
          description: User will be able to initiate the video call.
        muted:
          type: boolean
          default: true
          description: User will be muted once the call is established.
        settings:
          type: boolean
          default: true
          description: User will be able to configure settings before a call.
        cameraFacingMode:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CameraFacingMode'
      title: InitialOptions
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.WebhookPayload:
      type: object
      properties:
        id:
          type: string
          description: The ID that uniquely identifies the inbound email.
        spfCheck:
          type: string
          description: The result of a check of the SPF authentication record of the inbound email.
        dkimCheck:
          $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.DKIMCheck'
        senderIp:
          type: string
          description: The IP address from which the inbound email was sent.
        from:
          type: string
          description: The sender name and sender address from which the inbound email was sent.
        to:
          type: string
          description: The reply-to address to which the inbound email was sent.
        subject:
          type: string
          description: The subject of the inbound email.
        html:
          type: string
          description: The MIME html content of the inbound email.
        text:
          type: string
          description: The MIME text content of the inbound email.
        attachment:
          type: array
          description: Attachments are received as variables named attachment1, attachment2, attachment3, etc. Each variable contains one part of the attachment in a byte array. The variable names are based on the “attachmentInfo” part of the inbound email.
          items:
            type: array
            items:
              type: string
              format: byte
          maxItems: 999
          minItems: 0
        attachmentInfo:
          type: object
          description: Information about any attachments of the inbound email.
          properties:
            name:
              type: string
              description: Name of the variable containing the byte array of the file in the request.
            contentType:
              type: string
              description: Type of the attached file.
            filename:
              type: string
              description: Name of the attached file.
            contentId:
              type: string
              description: Unique ID of the attached file.
          required:
          - contentId
          - contentType
          - filename
          - name
        envelope:
          $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.Envelope'
      required:
      - attachment
      - attachmentInfo
      - dkimCheck
      - envelope
      - from
      - html
      - id
      - senderIp
      - spfCheck
      - subject
      - text
      - to
      title: WebhookPayload
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsBinaryMessageContent:
      type: object
      allOf:
      - type: object
        properties:
          dataCoding:
            type: integer
            format: int32
            default: 0
            description: 'Binary content data coding. The default value is (`0`) for GSM7. Example: (`8`) for  Unicode data.'
            example: 8
          esmClass:
            type: integer
            format: int32
            default: 0
            description: “Esm_class” parameter. Indicate special message attributes associated with the SMS. Default value is (`0`).
          hex:
            type: string
            description: Hexadecimal string. This is the representation of your binary data. Two hex digits represent one byte. They should be separated by the space character.
            example: 48 65 6c 6c 6f
      required:
      - hex
      title: binary content
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.CreateEmailTemplateRequest:
      type: object
      properties:
        name:
          type: string
          description: Name of the email template.
          example: Welcome email
        from:
          type: string
          description: Email address with optional sender name.
          example: Infobip <noreply@example.com>
        replyTo:
          type: string
          description: Email address to which recipients of the email can reply.
          example: support@example.com
        subject:
          type: string
          description: Subject of the email template.
          example: Welcome to Infobip
          maxLength: 200
          minLength: 0
        preheader:
          type: string
          description: Preheader of the email template.
          example: Welcome to Infobip
          maxLength: 75
          minLength: 0
        html:
          type: string
          description: HTML content of the email template.
          example: <html><head></head><body><h2>Welcome to Infobip</h2></body></html>
        attachments:
          type: string
          description: JSON string of attachments to be sent with the email template.
          example: '[{"contentType":"application/pdf","fileName":"attachment.pdf","data":"base64encodeddata"}]'
        landingPage:
          type: string
          description: The identifier of an opt out landing late to be used and displayed when an end user clicks the unsubscribe link. Create a landing page in your Infobip account and use the ID number. For example, 1_23456. If not present, the default opt out landing page is used.
          example: '1_2345'
      required:
      - html
      title: CreateEmailTemplateRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsWebhookDeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        channel:
          type: string
          description: The channel used to deliver a message. This property will be present only if the original message was sent with the failover option defined. The property will be included in the delivery report for the original RCS message and for the failover message (in case the failover was triggered).
          enum:
          - RCS
          - SMS
          - MMS
        price:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrMessagePrice'
        status:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageStatus'
        error:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageError'
        conversation:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo'
        messageId:
          type: string
          description: Unique message ID.
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        interactionType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: RcsWebhookDeliveryReport
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.SmsData:
      type: object
      description: SMS-specific data used if the message is sent through an SMS channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          maxLength: 2147483647
          minLength: 1
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        transliteration:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TransliterationCode'
        language:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Language'
        regional:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.RegionalData'
      title: SmsData
      writeOnly: true
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayFromUploadOptions:
      type: object
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the file will be played. Valid values are from 1 to 10.
          maximum: 10
          minimum: 1
      title: PlayFromUploadOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    f0c12807aec90d20a332deb5d4c4ff89651a8119eb6a5fa7e1d6e803f3c0e71b.ConferencePage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
        paging:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PageInfo'
      title: ConferencePage
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationDestination:
      type: object
      description: Array of email addresses to be validated.
      properties:
        destination:
          type: string
          description: The email address to be validated.
          maxLength: 320
          minLength: 1
      required:
      - destination
      title: ValidationDestination
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.RecipientInfo:
      type: object
      description: Recipient information such as device type, OS, device name.
      properties:
        deviceType:
          type: string
          description: The type of device used by the recipient to do the user action.
        os:
          type: string
          description: The type OS present in the device used by the recipient.
        deviceName:
          type: string
          description: Device name of the action originating device.
      title: RecipientInfo
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
    245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentity:
      type: object
      description: Information about the user who sent the message.
      properties:
        identityType:
          $ref: '#/components/schemas/245a74e48cd7ce0a3e2f108689f6fc8d5a08a4d75c5aeb1883fc983443d62958.LiveChatInboundUserIdentityType'
        identityValue:
          type: string
          description: Unique Person identifier.
        pushRegistrationId:
          type: string
          description: Push registration ID.
      required:
      - identityType
      - identityValue
      title: LiveChatInboundUserIdentity
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment:
      type: object
      description: Content of the message being sent.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundTextSegment'
          LINK: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundLinkSegment'
          SMIL: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSmilSegment'
          UPLOADED_REFERENCE: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundUploadedReferenceSegment'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegmentType'
      required:
      - type
      title: MmsOutboundSegment
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        track:
          type: boolean
          description: Enable or disable open and click tracking. Passing true will only enable tracking and the statistics will be visible in the web interface alone. This can be explicitly overridden by `trackClicks` and `trackOpens`.
        trackOpens:
          type: boolean
          description: This parameter enables or disables track open feature.
        trackClicks:
          type: boolean
          description: This parameter enables or disables track click feature.
        trackingUrl:
          type: string
          description: The URL on your callback server on which the open and click notifications will be sent. See [Tracking Notifications](https://www.infobip.com/docs/email/send-email-over-api#tracking-notifications) for details.
        trackingPixelPosition:
          type: string
          default: TOP
          description: This parameter specifies the position of the open tracking pixel within the email content. Allowed values are `TOP` and `BOTTOM`. If no value is provided, the default is `TOP`.
      title: EmailUrlOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.BulkMessageInfo:
      type: object
      properties:
        messages:
          type: array
          description: Array of sent message objects, one object per every message.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SingleMessageInfo'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
          example: '2034072219640523073'
      title: BulkMessageInfo
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegment:
      type: object
      description: Content of the message being sent.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundTextSegment'
          LINK: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundLinkSegment'
          SMIL: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSmilSegment'
          UPLOADED_REFERENCE: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundUploadedReferenceSegment'
      properties:
        type:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundSegmentType'
      required:
      - type
      title: MmsOutboundSegment
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.CreateTemplateResponse:
      type: object
      properties:
        templateCode:
          type: string
          description: Template code registered in system.
      required:
      - templateCode
      title: CreateTemplateResponse
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Result:
      type: object
      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).
        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).
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
        bulkId:
          type: string
          description: The ID that uniquely identifies a list of email messages. This is either defined by user in the request or auto generated.
        price:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PriceInfo'
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStatus'
        error:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ErrorInfo'
        messageId:
          type: string
          description: The ID that uniquely identifies the email sent to the recipient.
        doneAt:
          type: string
          format: date-time
          description: Delivery date and time.
        smsCount:
          type: integer
          format: int32
          description: The number of emails sent.
        sentAt:
          type: string
          format: date-time
          description: 'Send date and time. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        attemptCount:
          type: integer
          format: int32
          description: Number of times delivery was attempted for the email.
        timeToFirstAttempt:
          type: integer
          format: int64
          description: This is the time in milliseconds between accepting the request and making the first delivery attempt to the destination.
        browserLink:
          type: string
          description: "Contains the link to the HTML sent to recipient. This will be present only if the _view in browser_ feature is used in the email.\n (Please note that this feature is not activated automatically for Email traffic sent over API. If you would like to utilize it please reach out to your Infobip person of contact.)"
        sendingIp:
          type: string
          description: The IP address that was used to send out the email.
        smtp:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SmtpInfo'
        callbackData:
          type: string
          description: Callback data sent through `callbackData` field in fully featured email.
        to:
          type: string
          description: Destination email address.
      title: Result
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RequestMediaStreamConfigType:
      type: string
      description: Media stream configuration type.
      enum:
      - MEDIA_STREAMING
      - WEBSOCKET_ENDPOINT
      title: RequestMediaStreamConfigType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsAmount:
      type: object
      properties:
        value:
          type: integer
          format: int32
          description: Value multiplied by the offset (100 for INR and BRL).
      required:
      - value
      title: InteractiveOrderDetailsAmount
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LaunchScenarioRequest:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID which uniquely identifies the request.
        messages:
          type: array
          description: Array of IVR messages to be sent, one object per every message.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IvrMessage'
      required:
      - messages
      title: LaunchScenarioRequest
    afc47ed3ecce0d042db7648b2699b209de7fd712b3df90ffbf75e4058f683890.ApiRequestErrorDetails:
      type: object
      properties:
        messageId:
          type: string
          description: Identifier of the error.
          readOnly: false
          writeOnly: false
        text:
          type: string
          description: Detailed error description.
          readOnly: false
          writeOnly: false
      title: ApiRequestErrorDetails
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.SecurityConfigType:
      type: string
      enum:
      - BASIC
      - HMAC
      title: SecurityConfigType
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Paging:
      type: object
      description: Pagination details like page number, page size,etc.
      properties:
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
        totalResults:
          type: integer
          format: int32
      title: Paging
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProvidersResponse:
      type: object
      properties:
        providers:
          type: array
          description: List of available template providers.
          items:
            type: string
            description: List of available template providers.
          uniqueItems: true
      required:
      - providers
      title: RcsTemplateProvidersResponse
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.StartMediaStreamRequest:
      type: object
      properties:
        mediaStream:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStream'
      required:
      - mediaStream
      title: StartMediaStreamRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation:
      type: string
      description: SIP trunk location.
      enum:
      - SAO_PAULO
      - BOGOTA
      - FRANKFURT
      - SWEDEN
      - JOHANNESBURG
      - NEW_YORK
      - PORTLAND
      - MOSCOW
      - SINGAPORE
      - ISTANBUL
      - KUALA_LUMPUR
      title: SipTrunkLocation
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTextContent'
          IMAGE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundImageContent'
          VIDEO: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundVideoContent'
          DOCUMENT: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundDocumentContent'
          QUICK_REPLY: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundQuickReplyContent'
          RICH_LINK: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundRichLinkContent'
          AUTHENTICATION_REQUEST: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAuthRequestContent'
          LIST_PICKER: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundListPickerContent'
          FORM: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundFormContent'
          TIME_PICKER: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTimePickerContent'
          PAY_REQUEST: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundPayRequestContent'
          INVITATION: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundInvitationContent'
          MEDIA: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMediaContent'
          APP_CLIP: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundAppClipContent'
      properties:
        type:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType'
      required:
      - type
      title: AppleMfbOutboundMessageContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveOrderDetailsMessage
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    270617dafe939f994767f4b01223addd34979b1c67bb145186dac4c5c875ab19.Status:
      type: object
      description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery, or any other possible status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          example: 1
        groupName:
          type: string
          description: Status group name.
          example: PENDING
        id:
          type: integer
          format: int32
          description: Status ID.
          example: 26
        name:
          type: string
          description: Status name.
          example: PENDING_ACCEPTED
        description:
          type: string
          description: Status description.
          example: Message accepted, pending for delivery.
      required:
      - description
      - groupId
      - groupName
      - id
      - name
      title: Status
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationInfo:
      type: object
      description: Conversation information associated with the message.
      properties:
        canInitiate:
          type: boolean
          description: Indicates whether this message can initiate or trigger a conversation. If the message already belongs to a conversation, the value is false.
        id:
          type: string
          description: Unique conversation identifier. Present when the message belongs to a conversation, null otherwise.
      required:
      - canInitiate
      title: RcsConversationInfo
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessage'
        options:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageRequestOptions'
      required:
      - messages
      title: EmailRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SeenReport'
      title: SeenReports
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContentType:
      type: string
      enum:
      - TEXT
      - URL
      - AUDIO
      - VIDEO
      - FILE
      - IMAGE
      - LOCATION
      - LOCATION_URL
      - POSTBACK
      - SHARE
      - STORY_MENTION
      - PRODUCT
      - UNKNOWN
      title: InstagramDmInboundContentType
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessagePrice'
        status:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus'
        error:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Regional:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.IndiaDlt'
      title: Regional
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogResponseSmsLogSmsMessageContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent'
        cursor:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.CursorPageInfo'
      title: LogResponseSmsLogSmsMessageContent
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AdvancedTtsApiMessage:
      type: object
      description: Array of messages to be sent, one object per every message
      properties:
        from:
          type: string
          description: 'Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable.'
        destinations:
          type: array
          description: Array of message destination addresses. Maximum number of destination addresses is 20k.
          items:
            $ref: '#/components/schemas/97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.Destination'
        audioFileUrl:
          type: string
          description: An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
        text:
          type: string
          description: Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. Adding _pauses_ between the words and extending the duration of the voice message is possible by using the comma character `“,”`. For example, if you want to have a 3 second pause after each word, then the text parameter should look like this `“one,,,,,,two,,,,,,three,,,,,,”`. Each comma creates a pause of 0.5 seconds. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.
          externalDocs:
            description: SSML support
            url: https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages
        language:
          type: string
          description: If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.
          externalDocs:
            description: Voice Text-To-Speech Languages
            url: https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages
        voice:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice'
        speechRate:
          type: number
          format: double
          description: The reproduction speed of speech in the resulting message. Effective only when using text. Supported range is from `0.5` (slow down speech) to `2` (speed up speech). Values less than `0.5` will be replaced with `0.5`, and values higher than `2` will be replaced with `2`. Default value is `1`.
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`. [Read more](https://www.infobip.com/docs/api#channels/voice/get-voice-delivery-reports).
        notifyContentVersion:
          type: integer
          format: int32
          description: Specifies the version of the Delivery report to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2. [Read more](https://www.infobip.com/docs/api#channels/voice/get-voice-delivery-reports).
        callbackData:
          type: string
          description: 'Additional client''s data that will be sent on the notifyUrl. The maximum value is 700 characters. Example:  `Text containing some additional data needed in Delivery Report`.'
          maxLength: 700
          minLength: 0
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
          minimum: 1
        sendAt:
          type: string
          format: date-time
          description: Used for scheduled Voice messages (message not to be sent immediately, but at scheduled time).
        repeatDtmf:
          type: string
          description: 'Specify DTMF code that is used as an indicator to repeat the voice message to the end user. The # key cannot be collected, as it is reserved for user input termination. Message can be repeated up to 5 times.'
        maxDtmf:
          type: integer
          format: int32
          description: Defines the maximum number of DTMF codes entered by end user that would be collected.
        ringTimeout:
          type: integer
          format: int32
          description: 'Ringing duration, unless there are no operator limitations. Default value is `45`. Note: There are no limitations on the Voice platform regarding this value, however, most of the operators have their own ring timeout limitations and it is advisable to keep the ringTimeout value up to `45` seconds.'
        dtmfTimeout:
          type: integer
          format: int32
          description: The waiting period for end user to enter DTMF digits. Default value is `10` seconds.
        callTimeout:
          type: integer
          format: int32
          description: Maximum possible duration of the call to be set, shown in seconds.
        callTransfers:
          type: array
          description: Call transfers object enables transferring the ongoing call to another recipient(s) and establish a communication between your original recipient and additional one.
          items:
            $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallTransfer'
        pause:
          type: integer
          format: int32
          description: Period of time in seconds between end user answering the call and message starting to be played. Minimal value is `0` and maximum value is 10 seconds. Default value is `0`.
          maximum: 10
          minimum: 0
        retry:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry'
        sendingSpeed:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SendingSpeed'
        machineDetection:
          type: string
          description: Used for enabling detection of answering machine after the call has been answered. It can be set to `hangup` or `continue`. When set to `hangup`, if a machine is detected call will hang up. When set to `continue`, if a machine is detected, then voice message starts playing into voice mail after the answering message is finished with its greeting. If machineDetection is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager and check documentation on Answering Machine Detection.
          externalDocs:
            description: Answering Machine Detection
            url: https://www.infobip.com/docs/voice-and-video/getting-started#answering-machine-detection-add-ons-and-options
        deliveryTimeWindow:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow'
      required:
      - destinations
      title: AdvancedTtsApiMessage
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantState:
      type: string
      description: Participant state.
      enum:
      - JOINING
      - JOINED
      - LEFT
      title: ParticipantState
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus'
      title: ActionResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionContent:
      type: object
      description: Allows you to specify flow message details.
      properties:
        mode:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionMode'
        flowMessageVersion:
          type: integer
          format: int32
          description: Version of the flow message.
        flowToken:
          type: string
          description: Flow token that should serve as an identifier.
        flowId:
          type: string
          description: ID of the registered flow.
        callToActionButton:
          type: string
          description: Call to action button text.
          maxLength: 20
          minLength: 1
        flowAction:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowAction'
        flowActionPayload:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionPayload'
      required:
      - callToActionButton
      - flowId
      - flowToken
      title: InteractiveFlowActionContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialOptions:
      type: object
      properties:
        senderId:
          type: string
          description: must be a valid E164 MSISDN; the parameter can be constructed using variables
        maxCallDuration:
          type: integer
          format: int32
          description: If set, call transfer will be limited by maxCallDuration seconds, must be a positive number, no upper bound.
          minimum: 1
        customRingback:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CustomRingback'
      title: DialOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.SendingSpeedLimit'
      title: RequestSchedulingSettings
    60d0e6d5cbcf8382b5a6bad1f38781f71991c7ea63dad2e6ec22ddc8893af51c.RecordingStatusCallbackRequest:
      type: object
      description: Markup Language recording status callback request object. Sent to the callback URL configured on the Record or StartRecording instruction once the recording has been fully processed. Extends the instructions callback payload with the recorded file identifier and the final recording status.
      properties:
        callId:
          type: string
          description: Unique identifier of the call.
          example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        from:
          type: string
          description: The phone number of the caller in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026834'
        to:
          type: string
          description: The phone number of the callee in the [E.164](https://en.wikipedia.org/wiki/E.164) format.
          example: '41793026835'
        direction:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallDirection'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackEndpoint'
        startTime:
          type: string
          format: date-time
          description: The timestamp when the call started, in ISO-8601 UTC format (yyyy-MM-dd'T'HH:mm:ss.SSSZ).
          example: '2025-04-04T11:38:01.724Z'
        recordingFileId:
          type: string
          description: The unique identifier of the recording file.
          example: b83f049e-6b2a-4111-bbeb-32426fe0a737
        recordingStatus:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingStatusEvent'
      title: RecordingStatusCallbackRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpoint:
      type: object
      description: 'Simulator endpoint to be used for the simulation. '
      discriminator:
        propertyName: type
        mapping:
          SIP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorSipEndpoint'
          PHONE: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorPhoneEndpoint'
          WEBRTC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWebRTCEndpoint'
          WHATSAPP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorWhatsAppEndpoint'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpointType'
      title: SimulatorCallEndpoint
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationType:
      type: string
      description: Conversation type (Application to Person/Person to Application/Interactive session).
      enum:
      - A2P
      - P2A
      - INTERACTIVE_SESSION
      title: RcsConversationType
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.InboundMessageViberBotInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotInboundContent'
        price:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageViberBotInboundContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoReport:
      type: object
      description: Results.
      properties:
        messageId:
          type: string
          description: ID that uniquely identifies the received message.
        to:
          type: string
          description: Message destination address.
        from:
          type: string
          description: Sender ID that can be alphanumeric or numeric.
        message:
          type: string
          description: Full text of the received message.
        group:
          type: array
          description: Recipients of group MMS.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestination'
        receivedAt:
          type: string
          description: 'Tells when Infobip platform received the message. It has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        mmsCount:
          type: integer
          format: int32
          description: The number of sent message segments.
        callbackData:
          type: string
          description: Custom callback data can be inserted during the setup phase.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Price'
        applicationId:
          type: string
          description: '[Application](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#application) identifier the message belongs to.'
        entityId:
          type: string
          description: '[Entity](https://www.infobip.com/docs/cpaas-x/application-and-entity-management#entity) identifier the message belongs to.'
      title: MMSMoReport
    d787c8758e54290e2bc82a005b86f9050517ec4ab2e17f0a4cc0942f51132c33.ConversionType:
      type: string
      description: Type of the conversion. Can be `PURCHASE` or `LEAD_SUBMITTED`.
      enum:
      - PURCHASE
      - LEAD_SUBMITTED
      example: PURCHASE
      title: ConversionType
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ErrorInfo:
      type: object
      description: Indicates whether the error occurred during the query execution.
      properties:
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: Error name.
        description:
          type: string
          description: Human-readable description of the error.
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          type: string
          description: Error group name.
        permanent:
          type: boolean
          description: Indicates whether the error is permanent.
      title: ErrorInfo
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressContent:
      type: object
      description: Array of addresses information.
      properties:
        street:
          type: string
          description: Street name.
        city:
          type: string
          description: City name.
        state:
          type: string
          description: State name.
        zip:
          type: string
          description: Zip code value.
        country:
          type: string
          description: Country name.
        countryCode:
          type: string
          description: Country code value.
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.AddressType'
      title: AddressContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoEventMessagePrice:
      type: object
      description: Price object with traffic type information.
      properties:
        trafficType:
          type: string
          description: Always will be null, events are not chargeable.
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: RcsMoEventMessagePrice
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundMessageContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - DOCUMENT
      - MEDIA
      - QUICK_REPLY
      - RICH_LINK
      - APP_CLIP
      - AUTHENTICATION_REQUEST
      - LIST_PICKER
      - FORM
      - TIME_PICKER
      - PAY_REQUEST
      - INVITATION
      title: AppleMfbOutboundMessageContentType
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.DestinationType:
      type: string
      enum:
      - WEBRTC
      - CONVERSATIONS
      - ROOM
      - PHONE
      - VIBER
      - APPLICATION
      title: DestinationType
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionAction:
      type: object
      description: A list of actions a sender may undertake to facilitate a call permission or a business initiated call.
      properties:
        name:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionName'
        canPerformAction:
          type: boolean
          description: Whether the action can be performed now, taking into account all limits.
        limits:
          type: array
          description: A list of time-bound restrictions for the given action.
          items:
            $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionLimit'
      required:
      - canPerformAction
      - limits
      - name
      title: CallingPermissionAction
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpointType:
      type: string
      enum:
      - PHONE
      title: BulkEndpointType
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ToDestination'
        content:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloOutboundContent'
        options:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessageOptions'
        webhooks:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: ZaloMessage
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniChannel:
      type: string
      description: Channel that was used for message delivering.
      enum:
      - SMS
      - EMAIL
      - VOICE
      - PUSH
      - VIBER
      - LINE
      - VKONTAKTE
      - KAKAO_CHINGU
      - KAKAO_ALIM
      - WHATSAPP
      title: OmniChannel
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingComposition:
      type: object
      properties:
        enabled:
          type: boolean
          default: false
          description: Indicates whether to create a single recording of both participants. If set to `true`, both participants are merged into a single audio or video file. Otherwise, both participants will have their own individual audio or video file.
      title: DialogRecordingComposition
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResultTo:
      type: object
      allOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResult'
      - type: object
        properties:
          to:
            type: string
            description: The message destination address.
            example: '41793026727'
          messageId:
            type: string
            description: The ID that uniquely identifies the message sent.
            example: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
      required:
      - status
      title: Message result as to
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    febbeec59369f28c0a6e3ddd1a2666aea9869953e0893914d340d35c6901410c.Subdomain:
      type: object
      properties:
        id:
          type: string
          description: Identifier of a created subdomain.
        name:
          type: string
          description: 'Name of a subdomain: name.call-link.com .'
          pattern: ^[A-Za-z0-9](?:[A-Za-z0-9\-]{0,61}[A-Za-z0-9])?$
      title: Subdomain
    bed2167e3f739c7f0ded9831d75a7a93f11864f45170ef7c0c6b02ad17bd1a97.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.KakaoChinguOutboundContentType:
      type: string
      enum:
      - TEXT_FREE_FORM
      - IMAGE_FREE_FORM
      - IMAGE_WIDE_FREE_FORM
      - ITEM_LIST_FREE_FORM
      - COMMERCE_FREE_FORM
      - CAROUSEL_FREE_FORM
      - CAROUSEL_COMMERCE_FREE_FORM
      - PREMIUM_VIDEO_FREE_FORM
      - TEXT_VARIABLE
      - IMAGE_VARIABLE
      - IMAGE_WIDE_VARIABLE
      - ITEM_LIST_VARIABLE
      title: KakaoChinguOutboundContentType
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
      writeOnly: true
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    cd5e571e477c0b81ca50ad592cf9f67cc32feded2012ec26d7fae09c0c2d5108.SmsMoReportResponse:
      type: object
      properties:
        results:
          type: array
          description: An array of result objects.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMoReport'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the `results` array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: SmsMoReportResponse
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.AddSuppression:
      type: object
      description: Suppression.
      properties:
        domainName:
          type: string
          description: Domain name from which suppressions will be added.
        emailAddress:
          type: array
          description: Email addresses to add to suppression list.
          items:
            type: string
            description: Email addresses to add to suppression list.
          maxItems: 1000
          minItems: 1
        type:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiAddSuppressionType'
      required:
      - domainName
      - emailAddress
      - type
      title: AddSuppression
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventOptions:
      type: object
      description: Event options.
      properties:
        platform:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Platform'
        validityPeriod:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ValidityPeriod'
      title: TikTokEventOptions
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateType:
      type: string
      enum:
      - AUTHENTICATION
      - PAYMENT_REQUEST
      - SERVICE_REVIEW
      - VOUCHER
      - CUSTOM
      title: ZbsTemplateType
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.SipTrunkResponse:
      type: object
      discriminator:
        propertyName: type
        mapping:
          STATIC: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.StaticSipTrunkResponse'
          REGISTERED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.RegisteredSipTrunkResponse'
          PROVIDER: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.ProviderSipTrunkResponse'
          AUTHENTICATED: '#/components/schemas/74ef2de883b1c563e3452617e157979c03da4c002bc4346d51554a1679b9616f.AuthenticatedSipTrunkResponse'
      properties:
        id:
          type: string
          description: SIP trunk ID.
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType'
        name:
          type: string
          description: SIP trunk name.
        location:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkLocation'
        tls:
          type: boolean
          description: Indicates whether communication is secured by the TLS protocol.
        codecs:
          type: array
          description: List of audio codecs supported by a SIP trunk.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec'
        dtmf:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType'
        fax:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.FaxType'
        numberFormat:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat'
        internationalCallsAllowed:
          type: boolean
          description: Indicates whether international calls should be allowed. Calls between different countries are considered international.
        channelLimit:
          type: integer
          format: int32
          description: Maximum number of concurrent channels.
        anonymization:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnonymizationType'
        billingPackage:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BillingPackage'
        sbcHosts:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts'
        sipOptions:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipOptions'
      title: SipTrunkResponse
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Gender:
      type: string
      description: Voice gender in which text would be synthesized.
      enum:
      - FEMALE
      - MALE
      title: Gender
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SouthKoreaOptions:
      type: object
      description: Use case dependent parameters for sending SMS to phone numbers registered in South Korea.
      properties:
        title:
          type: string
          description: Title of the message.
          maxLength: 66
          minLength: 0
        resellerCode:
          type: integer
          format: int32
          description: 'Reseller identification code: 9-digit registration number in the business registration certificate for South Korea. Resellers should submit this when sending.'
      title: SouthKoreaOptions
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessageActionWhatsAppContent:
      type: object
      description: Allows you to specify message details.
      properties:
        buttonDisplayText:
          type: string
          description: Text to be displayed on the button.
          maxLength: 20
          minLength: 0
        callValidityPeriod:
          type: integer
          format: int32
          description: Time to live for the voice call button in minutes. Must be between 1 and 43200 (30 days). Default value is 10080 (7 days).
          maximum: 43200
          minimum: 1
        callContextPayload:
          type: string
          description: Payload data sent with the button. Can be retrieved from the call webhook.
          maxLength: 512
          minLength: 1
      title: InteractiveVoiceButtonMessageActionWhatsAppContent
    a0adf300db6deef82e7c0136cd925a42b10c902181badc6843c98dba155015cc.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties:
      type: object
      description: Properties of the events that provide Answering Machine Detection result.
      properties:
        detectionResult:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DetectionResult'
        confidenceRating:
          type: object
          additionalProperties:
            type: number
            format: double
          description: 'A map representing the confidence rating for each detection class. The key is a tag indicating the detection class, and the value is a float between `0.0` and `1.0` representing the confidence rating. Possible classes are: `HUMAN`, `MACHINE`, `MUSIC`, `RINGING`, `NOISE`, `SILENCE` and `OTHER`. Each class confidence rating is independent from the other, thereby the sum of all confidence values may not equal 1.0.'
          example:
            HUMAN: 0.95
            MACHINE: 0.0
            MUSIC: 0.0
            RINGING: 0.0
            NOISE: 0.05
            SILENCE: 0.01
            OTHER: 0.02
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
      title: MachineDetectionProperties
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundTextContent'
          LOCATION: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundLocationContent'
          IMAGE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundImageContent'
          DOCUMENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundDocumentContent'
          AUDIO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundAudioContent'
          VIDEO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVideoContent'
          VOICE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundVoiceContent'
          CONTACT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactsContent'
          INFECTED_CONTENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInfectedContent'
          BUTTON: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundQuickReplyContent'
          STICKER: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundStickerContent'
          INTERACTIVE_BUTTON_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundButtonReplyContent'
          INTERACTIVE_LIST_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundListReplyContent'
          INTERACTIVE_FLOW_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundFlowReplyContent'
          INTERACTIVE_PAYMENT_CONFIRMATION: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundPaymentConfirmationContent'
          INTERACTIVE_CALL_PERMISSION_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundCallPermissionReplyContent'
          INTERACTIVE_IN_THREAD_AUTHENTICATION_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundInThreadAuthenticationReplyContent'
          ORDER: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundOrderContent'
          REACTION: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundReactionContent'
          UNSUPPORTED: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundUnsupportedContent'
      properties:
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContentType'
      required:
      - type
      title: WhatsAppInboundContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.OrganizationContent:
      type: object
      description: Contains information about contact's company.
      properties:
        company:
          type: string
          description: Company name.
        department:
          type: string
          description: Department name.
        title:
          type: string
          description: Title value.
      title: OrganizationContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateStatus:
      type: string
      enum:
      - ALL
      - ENABLED
      - PENDING_REVIEW
      - REJECTED
      - DISABLED
      example: PENDING_REVIEW
      title: TemplateStatus
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection:
      type: object
      description: Machine detection configuration for the dial.
      properties:
        detectionTime:
          type: number
          format: double
          description: Detection time in seconds
          maximum: 5
          minimum: 1
        mode:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode'
        messageDetection:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MessageDetection'
      title: MachineDetection
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MultiTtsApiMessage:
      type: object
      description: Array of messages to be sent, one per every message.
      properties:
        audioFileUrl:
          type: string
          description: An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
        text:
          type: string
          description: Text of the message that will be sent. Message text can be up to 1400 characters long and cannot contain only punctuation. SSML (_Speech Synthesis Markup Language_) is supported and can be used to fully customize pronunciation of the provided text.
          externalDocs:
            description: SSML support
            url: https://www.infobip.com/docs/voice-and-video/reference#ssml-support-text-to-speech-languages
        language:
          type: string
          description: If the message is in text format, the language in which the message is written must be defined for correct pronunciation. More about Text-to-speech functionality and supported TTS languages can be found [here](https://www.infobip.com/docs/voice-and-video/outbound-calls#text-to-speech-voice-over-broadcast). If not set, default language is `English [en]`. If voice is not set, then default voice for that specific language is used. In the case of English language, the voice is `[Joanna]`.
          externalDocs:
            description: Voice Text-To-Speech Languages
            url: https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages
        voice:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice'
        from:
          type: string
          description: 'Numeric sender ID in E.164 standard format (Example: 41793026727). This is caller ID that will be presented to the end user where applicable.'
        to:
          type: array
          description: 'Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727). Maximum number of phone numbers listed is 20k.'
          items:
            type: string
            description: 'Phone number of the recipient. Phone number must be written in E.164 standard format (Example: 41793026727). Maximum number of phone numbers listed is 20k.'
      required:
      - to
      title: MultiTtsApiMessage
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoTo:
      type: object
      description: Go-To action is used to go back to some specified action that was already executed in the scenario and continue the execution from that point.
      properties:
        goTo:
          type: integer
          format: int32
          description: The actionId of an action to which to jump
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.GoToOptions'
      required:
      - goTo
      title: Go To
    ApiRequestErrorDetails:
      type: object
      properties:
        messageId:
          type: string
          description: Identifier of the error.
        text:
          type: string
          description: Detailed error description.
        validationErrors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
              description: Validation errors.
          description: Validation errors.
      title: ApiRequestErrorDetails
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateLimitedTimeOfferContent:
      type: object
      description: Template limited-time offer. Should be defined, only if template contains limited-time offer.
      properties:
        expirationTime:
          type: string
          format: date-time
          description: 'Offer code expiration time. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2030-01-01T10:00:00Z'
      required:
      - expirationTime
      title: TemplateLimitedTimeOfferContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallDirection:
      type: string
      description: Call direction.
      enum:
      - INBOUND
      - OUTBOUND
      title: CallDirection
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolAssignIpApiRequest:
      type: object
      properties:
        ipId:
          type: string
          description: Dedicated IP identifier.
      required:
      - ipId
      title: IpPoolAssignIpApiRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: "Email address with optional sender name. \n\n Note: This field is required if `templateId` is not present."
        destinations:
          type: array
          description: "An array of destination objects for where messages are being sent. A valid destination is required.\n\n Note: Maximum number of recipients is 1000 overall including `to`, `cc` and `bcc` field."
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailGroupDestination'
        content:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageContent'
        options:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageOptions'
        webhooks:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Webhooks'
        ips:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailIps'
        placeholdersMasking:
          type: array
          description: Options to full or partially mask placeholders.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PlaceholderMasking'
        storage:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailStorage'
      required:
      - content
      - destinations
      title: EmailMessage
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Theme:
      type: object
      description: Call link theme-specific configuration settings. Use it to add image, color, and text selections to customize a call link page.
      properties:
        images:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Images'
        messages:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Messages'
        colors:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Colors'
        layouts:
          type: array
          description: Represents layout during the call.When GRID layout is selected, multiple video streams are displayed simultaneously and user can spotlight specific video stream.When SOLO layout is selected, an user can see only his video streams.If there are more than one layout in this list, the first one will be initially selected, and users can change it during the call.The default layout will be set to GRID.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Layout'
        localization:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Localization'
      title: Theme
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrTrafficType:
      type: string
      description: Traffic type applied to the RCS message that the delivery report refers to. Null for not chargeable RCS messages.
      enum:
      - BASIC
      - SINGLE
      - RICH
      - RICH_MEDIA
      - P2A_CONVERSATION
      - INTERACTIVE_SESSION
      title: RcsDlrTrafficType
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions:
      type: object
      description: Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature.
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.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
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection:
      type: string
      description: Call direction.
      enum:
      - INBOUND
      - OUTBOUND
      title: CallDirection
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.ValidityPeriodTimeUnit:
      type: string
      description: Time unit for validity period. Defaults to hours.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkRecordingApplication:
      type: object
      description: Recording application metadata
      discriminator:
        propertyName: type
        mapping:
          CALL_LINK: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CallLinkApplication'
      properties:
        type:
          $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.ApplicationType'
      required:
      - type
      title: CallLinkRecordingApplication
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email:
      type: object
      description: List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.
      properties:
        address:
          type: string
          description: Email address. Must be in valid email format.
          maxLength: 100
          minLength: 1
        label:
          type: string
          description: Label for the email address. Must be plain text (no URLs, HTML or markup).
          maxLength: 25
          minLength: 1
      required:
      - address
      - label
      title: Email
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSms:
      type: object
      description: Send SMS action creates and sends a text message from the scenario.
      properties:
        sendSms:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SendSmsData'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - sendSms
      title: Send SMS
    a22294a21e0a6f95f3711ca1f29de62bd2ce6d8bf890b9e41dadab263638faaf.Status:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          readOnly: false
          writeOnly: false
        groupName:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
          readOnly: false
          writeOnly: false
        id:
          type: integer
          format: int32
          description: Status ID.
          readOnly: false
          writeOnly: false
        name:
          type: string
          description: Status name.
          readOnly: false
          writeOnly: false
        description:
          type: string
          description: Human-readable description of the status.
          readOnly: false
          writeOnly: false
      title: Status
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DetectionResult:
      type: string
      description: Detected class during analysis of the call. Always returns either HUMAN or MACHINE. Use confidenceRating for a finer grained analysis result
      enum:
      - HUMAN
      - MACHINE
      example: HUMAN
      title: DetectionResult
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.EmailTemplatePreviewRequest:
      type: object
      properties:
        placeholders:
          type: object
          additionalProperties:
            type: object
            description: A map of placeholder names and their replacement values.
            example:
              firstName: Joe
          description: A map of placeholder names and their replacement values.
          example:
            firstName: Joe
      title: EmailTemplatePreviewRequest
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessage'
        options:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessageRequestOptions'
      required:
      - messages
      title: KakaoAlimRequest
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContent:
      type: object
      description: Event content.
      discriminator:
        propertyName: type
        mapping:
          TYPING_INDICATOR: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventTypingIndicatorContent'
          MARK_AS_READ: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventMarkAsReadContent'
      properties:
        type:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundEventContentType'
      required:
      - type
      title: TikTokOutboundEventContent
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionType:
      type: string
      description: Action type.
      enum:
      - HTTP_FORWARD
      - PULL
      title: ActionType
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.ButtonApiData:
      type: object
      description: Template buttons. Can contain 1 to 10 buttons which include up to 2 URL buttons, one phone number button, one `copy code` button and one `flow` button. `quick reply` and non `quick reply` buttons have to be grouped together.
      discriminator:
        propertyName: type
        mapping:
          PHONE_NUMBER: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.PhoneNumberButtonApiData'
          URL: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.UrlButtonApiData'
          QUICK_REPLY: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.QuickReplyButtonApiData'
          COPY_CODE: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CopyCodeDefaultButtonApiData'
          FLOW: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.FlowButtonApiData'
          CATALOG: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.CatalogButtonApiData'
          MULTI_PRODUCT: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.MultiProductButtonApiData'
          ORDER_DETAILS: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.OrderDetailsButtonApiData'
          VOICE_CALL: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.VoiceCallButtonApiData'
          REQUEST_CONTACT_INFO: '#/components/schemas/f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.RequestContactInfoButtonApiData'
      properties:
        type:
          type: string
          enum:
          - PHONE_NUMBER
          - URL
          - QUICK_REPLY
          - COPY_CODE
          - FLOW
          - CATALOG
          - MULTI_PRODUCT
          - ORDER_DETAILS
          - VOICE_CALL
          - REQUEST_CONTACT_INFO
      title: ButtonApiData
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZaloMessage'
        options:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DefaultMessageRequestOptions'
      required:
      - messages
      title: ZaloRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.SingleMessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          example: 1
        groupName:
          type: string
          description: Status group name.
          example: PENDING
        id:
          type: integer
          format: int32
          description: Status ID.
          example: 7
        name:
          type: string
          description: Status name.
          example: PENDING_ENROUTE
        description:
          type: string
          description: Human-readable description of the status.
          example: Message sent to next instance
        action:
          type: string
          description: Action that should be taken to eliminate the error.
      title: SingleMessageStatus
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppCallingPermissionResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionStatus'
        actions:
          type: array
          description: A list of actions a sender may undertake to facilitate a call permission or a business initiated call.
          items:
            $ref: '#/components/schemas/6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionAction'
        expirationTime:
          type: string
          format: date-time
          description: Time at which the calling permission will expire. Present only when `TEMPORARY` permission is granted.
          example: '2025-10-06T08:12:26.422Z'
      required:
      - actions
      - status
      title: WhatsAppCallingPermissionResponse
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ConnectWithNewCallRequest:
      type: object
      properties:
        callRequest:
          $ref: '#/components/schemas/08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest'
        connectOnEarlyMedia:
          type: boolean
          default: false
          description: Indicates whether to connect calls on early media. Otherwise, the calls are connected after being established. Cannot be `true` when `ringbackGeneration` is enabled.
        ringbackGeneration:
          $ref: '#/components/schemas/2dac378b25c8dcf450b0618ee8c5fb6fb461154cc6b53aedfd327a01e576875e.RingbackGeneration'
        conferenceRequest:
          $ref: '#/components/schemas/707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ActionConferenceRequest'
      required:
      - callRequest
      title: ConnectWithNewCallRequest
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundMessages:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InboundMessagePushko'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: WhatsAppInboundMessages
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.UploadBinaryResult:
      type: object
      properties:
        uploadedContentId:
          type: string
          description: The ID that uniquely identifies the uploaded content.
          example: B44419205B27012D82F3BAD7B7EB37...
      title: UploadBinaryResult
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenResult:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.SeenReport'
          readOnly: false
          writeOnly: true
      title: whatsappDlrSeenReportsResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DomainResponse:
      type: object
      description: Detailed domain information.
      properties:
        domainId:
          type: integer
          format: int64
          description: Id of the domain.
          example: 1
        domainName:
          type: string
          description: Name of the domain.
          example: example.com
        active:
          type: boolean
          description: Activation status of the domain.
          example: false
        tracking:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingResponse'
        dnsRecords:
          type: array
          description: DNS records for the domain.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.DnsRecordResponse'
        blocked:
          type: boolean
          description: Status if the domain is blocked.
          example: false
        createdAt:
          type: string
          format: date-time
          description: 'Date the domain was created. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-01-02T01:00:00.123Z'
        blocklistConfigurationLevel:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BlocklistConfigurationLevel'
      title: DomainResponse
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType:
      type: string
      enum:
      - TYPING_INDICATOR
      title: AppleMfbOutboundEventContentType
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundTextContent'
          URL: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUrlContent'
          AUDIO: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundAudioContent'
          VIDEO: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundVideoContent'
          FILE: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFileContent'
          IMAGE: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundImageContent'
          FALLBACK: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundFallbackContent'
          LOCATION: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationCoordinatesContent'
          LOCATION_URL: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundLocationUrlContent'
          POSTBACK: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundPostbackContent'
          UNKNOWN: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundUnknownContent'
      properties:
        type:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContentType'
      title: FacebookInboundContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        callbackData:
          type: string
          description: Additional client data to be sent over the notifyUrl. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
          writeOnly: true
        deliveryTimeWindow:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTimeWindow'
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. Each object in array can be one of available options. A valid destination is required.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Destination'
          writeOnly: true
        from:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
          writeOnly: true
        intermediateReport:
          type: boolean
          description: The [real-time intermediate delivery report](https://www.infobip.com/docs/api/channels/mms/get-outbound-mms-message-delivery-reports) containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
          writeOnly: true
        notifyUrl:
          type: string
          description: The URL on your call back server on to which a delivery report will be sent.
          externalDocs:
            description: Delivery report format.
            url: https://www.infobip.com/docs/api/channels/mms/get-outbound-mms-message-delivery-reports
          writeOnly: true
        regional:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Regional'
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled MMS. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          writeOnly: true
        messageSegments:
          type: array
          description: Content of the message being sent.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsAdvancedMessageSegment'
          writeOnly: true
        validityPeriod:
          type: integer
          format: int64
          description: The message validity period in minutes. When the period expires, it will not be allowed for the message to be sent. Validity period longer than 48h is not supported. Any bigger value will automatically default back to `2880`.
          writeOnly: true
        title:
          type: string
          description: Message title.
          maxLength: 66
          minLength: 0
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events.
          maxLength: 255
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events.
          maxLength: 255
          minLength: 0
          writeOnly: true
      required:
      - destinations
      - messageSegments
      title: MmsAdvancedMessage
    5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry:
      type: object
      description: SIP trunk service address country.
      properties:
        name:
          type: string
          description: Name of the country where SIP trunk is located.
        code:
          type: string
          description: Code of the country where SIP trunk is located.
      title: PublicCountry
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessage'
        options:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessageRequestOptions'
      required:
      - messages
      title: LineRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailRequestSchedulingSettings:
      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
          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 5 days in advance.'
      title: EmailRequestSchedulingSettings
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsRegisterTemplateRequest:
      type: object
      properties:
        providers:
          type: array
          description: List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that only supported providers with which template has not been registered yet should be used.
          example:
          - INDIA_VI
          items:
            type: string
            description: List of providers with which the template should be registered. For list of available providers please check [Get RCS template providers](#channels/rcs/rcs-service-management/rcs-template-management/rcs-template-providers) endpoint. Please note that only supported providers with which template has not been registered yet should be used.
            example: '["INDIA_VI"]'
          uniqueItems: true
      required:
      - providers
      title: RcsRegisterTemplateRequest
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundContentType:
      type: string
      enum:
      - TEXT
      - URL
      - AUDIO
      - VIDEO
      - FILE
      - IMAGE
      - FALLBACK
      - LOCATION
      - LOCATION_URL
      - POSTBACK
      - UNKNOWN
      title: FacebookInboundContentType
    30350ea3b42c85fe379e7561e2b43510ecd150d18a85f55710d4f6347f698f75.VerifyCodeRequest:
      type: object
      properties:
        code:
          type: string
          description: Verification code.
          example: '123456'
      required:
      - code
      title: VerifyCodeRequest
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButtonType:
      type: string
      enum:
      - URL
      - APP_LINK
      - DELIVERY_TRACKING
      - CHATBOT_SWITCH
      - MESSAGE_DELIVERY
      - BOT_KEYWORD
      - ADD_CHANNEL
      title: KakaoAlimButtonType
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Criteria:
      type: object
      description: Criteria type.
      discriminator:
        propertyName: type
        mapping:
          PHONE: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PhoneCriteria'
          SIP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SipCriteria'
          WEBRTC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WebRTCCriteria'
          APPLICATION: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationCriteria'
          WHATSAPP: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.WhatsAppCriteria'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CriteriaType'
      required:
      - type
      title: Criteria
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceRequest:
      type: object
      properties:
        name:
          type: string
          description: Conference name, will be auto-generated if not provided.
        recording:
          $ref: '#/components/schemas/4811a3a9108d5f90b8934012403f954f20270c436bdecbc318a80214cf54fc02.ConferenceRecordingRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
      required:
      - callsConfigurationId
      title: ConferenceRequest
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Destination:
      type: object
      description: List of destinations. First destination in the list is the first one to be executed. Subsequent destinations are executed only if the previous one fails.
      discriminator:
        propertyName: type
        mapping:
          APPLICATION: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ApplicationDestination'
          ENDPOINT: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestination'
          URL: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestination'
      properties:
        priority:
          type: integer
          format: int32
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType'
        weight:
          type: integer
          format: int32
      required:
      - type
      title: Destination
    46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.ottReportResponse:
      type: object
      allOf:
      - properties:
          results:
            type: array
            description: Collection of reports, one per every received message.
            items:
              $ref: '#/components/schemas/46339420b556d1893a150250c0e3220eb8057cd2fc4110e601753f705fc1f8c4.MoReport'
      - $ref: '#/components/schemas/3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.MessageCount'
      title: OTTReportResponse
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    526c8fd5dbec2ed6659284b76850ff4085b7915f78d3266fedb5e0b5300d882a.MarkupLanguageConfigResponsePage:
      type: object
      description: Markup language configurations response object.
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigResponse'
        paging:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.PageInfo'
      title: MarkupLanguageConfigResponsePage
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          IMAGE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderDetailsImageHeaderContent'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveOrderDetailsHeaderContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PegasusSipTrunkType:
      type: string
      description: SIP trunk type.
      enum:
      - STATIC
      - REGISTERED
      - PROVIDER
      - AUTHENTICATED
      title: PegasusSipTrunkType
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageResponseSmsMessageResponseDetails:
      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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageResponseDetails'
      title: MessageResponseSmsMessageResponseDetails
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppExpirationTimeUnit:
      type: string
      description: Time unit for in-app expiration.
      enum:
      - MINUTES
      - HOURS
      title: InAppExpirationTimeUnit
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConvStartedTrafficType:
      type: string
      description: Traffic type applied to the inbound or outbound RCS message. Null for non chargeable RCS messages.
      enum:
      - A2P_CONVERSATION
      - INTERACTIVE_SESSION
      title: RcsConvStartedTrafficType
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GenerateFlowRequestApiData:
      type: object
      properties:
        prompt:
          type: string
          description: Prompt for flow generation.
          example: Flow that contains form with name, surname and email of the user.
        responseId:
          type: string
          description: Optional identifier of a previous response. If provided, this request will update or modify the generatedFlow associated with the given responseId. Use this to refine or change an existing flow by referencing an earlier response.
          example: '12345'
      required:
      - prompt
      title: GenerateFlowRequestApiData
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CallApiOptions:
      type: object
      properties:
        method:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.HttpMethod'
        headers:
          type: object
          additionalProperties:
            type: string
            description: HTTP headers
          description: HTTP headers
        body:
          type: string
          description: HTTP body. The parameter can be constructed using variables.
        collectResponse:
          type: boolean
          description: 'If this field is set, the system will parse the response and save all its fields as variables inside scenario. Note: Parser ignores non-primitive fields and does not go deeper than the first level. For example, if the response is {"letters": "abcd", "numbers": 12345}, the system will store variables letters and numbers, with values abcd and 12345 respectively. The response cannot contain duplicate keys or predefined words. Check the example Call Api with response. Response that is parsed can only be in JSON or XML. Predefined words: from, to, startTime, answerTime and machineAnswered.'
      required:
      - body
      - method
      title: CallApiOptions
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.ActionCallRequest:
      type: object
      properties:
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        from:
          type: string
          description: Caller identifier. Must be a number in the [E.164](https://en.wikipedia.org/wiki/E.164) format for calls to `PHONE`, a string for calls to `WEBRTC` or `SIP`, and a Viber Voice number for calls to `VIBER`. Field is mandatory for `VIBER` endpoint and calls to emergency numbers.
        fromDisplayName:
          type: string
          description: Display name to show when placing calls towards WEBRTC endpoints. Can be any alphanumeric string.
        connectTimeout:
          type: integer
          format: int32
          description: Time to wait, in seconds, before the called party answers the call.
          maximum: 60
        recording:
          $ref: '#/components/schemas/6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest'
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionRequest'
        maxDuration:
          type: integer
          format: int32
          default: 28800
          description: Max duration in seconds.
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
      required:
      - endpoint
      title: ActionCallRequest
    eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupLanguageConfigRequest:
      type: object
      description: Markup language configuration request object.
      properties:
        name:
          type: string
          description: Configuration name.
        markupUrl:
          type: string
          description: URL where markup script is hosted.
        notifyUrl:
          type: string
          description: URL where notifications will be sent.
        errorUrl:
          type: string
          description: URL where error notifications will be sent.
        httpMethod:
          type: string
          description: HTTP method for callbacks (e.g., POST, GET).
          maxLength: 10
          minLength: 0
      required:
      - httpMethod
      - markupUrl
      - name
      title: MarkupLanguageConfigRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status:
      type: string
      description: Current bulk status.
      enum:
      - PENDING
      - PAUSED
      - PROCESSING
      - CANCELED
      - FINISHED
      - FAILED
      example: PENDING
      title: Status
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsIsTypingEventType:
      type: string
      description: Type of received event.
      enum:
      - TYPING_INDICATOR
      example: TYPING_INDICATOR
      title: RcsIsTypingEventType
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.SubscriptionInfo:
      type: object
      description: Messenger subscription info.
      properties:
        numSubscribersReceived:
          type: integer
          format: int32
          description: Number of subscribers matched.
          example: 1
        numSubscribersInvalidEntries:
          type: integer
          format: int32
          description: Number of invalid subscriber entries.
          example: 0
      title: SubscriptionInfo
    5c2cf40bcaa0da78551dad80ceca0bb519c9f9fe84d6b1fad64401849b63d9ac.ApplicationResponse:
      type: object
      properties:
        applicationCode:
          type: string
          description: Push application code.
        applicationId:
          type: string
          description: Push application ID.
        name:
          type: string
          description: Push application name.
        description:
          type: string
          description: Push application description.
        registrationsCount:
          type: integer
          format: int64
          description: Number of Push application registrations.
        apns:
          $ref: '#/components/schemas/fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.ApnsData'
        gcm:
          $ref: '#/components/schemas/fc58971973975508c3c8fc4221c7201147a075acf31dce7331f3a874d9fc423d.GcmData'
      required:
      - apns
      - applicationCode
      - applicationId
      - description
      - gcm
      - name
      - registrationsCount
      title: ApplicationResponse
    ae8a6eecccfb565f1840ac10e7bfb960a35d1e256ae31abf1bdea45a1d2f5557.CallLinkResponse:
      type: object
      properties:
        id:
          type: string
          description: 'Identifier of the created call link. To open a call link, an ID will be concatenated to the URL: https://call-link.com/.'
        url:
          type: string
          description: A URL to initiate the call.
      title: CallLinkResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Preview:
      type: object
      description: Allows for previewing the original message content once additional language configuration has been applied to it.
      properties:
        textPreview:
          type: string
          description: Preview of the message content as it should appear on the recipient’s device.
        messageCount:
          type: integer
          format: int32
          description: Number of SMS message parts required to deliver the message.
        charactersRemaining:
          type: integer
          format: int32
          description: Number of remaining characters in the last part of the SMS.
        configuration:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageConfiguration'
      title: Preview
    c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.ConferenceAndCall:
      type: object
      properties:
        conference:
          $ref: '#/components/schemas/c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Conference'
        call:
          $ref: '#/components/schemas/431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.Call'
      title: ConferenceAndCall
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateContent:
      type: object
      description: Template content.
      discriminator:
        propertyName: type
        mapping:
          CUSTOM: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.CustomTemplate'
          AUTHENTICATION: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.AuthenticationTemplate'
          PAYMENT_REQUEST: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.PaymentRequestTemplate'
          VOUCHER: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.VoucherTemplate'
          SERVICE_REVIEW: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ServiceReviewTemplate'
      properties:
        type:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ZbsTemplateType'
      required:
      - type
      title: ZbsTemplateContent
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidationPageResponse:
      type: object
      description: Validation get page response.
      properties:
        results:
          type: array
          description: Validated addresses for requested paging information.
          items:
            $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.GetValidation'
        paging:
          $ref: '#/components/schemas/45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.CursorPageInfo'
      required:
      - paging
      - results
      title: GetValidationPageResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindow:
      type: object
      description: Defines a scheduling object that allows setting up a detailed time window in which calls can be established. Consists of from, to and days properties. Days property is mandatory.
      properties:
        from:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint'
        to:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.TimeWindowPoint'
        days:
          type: array
          description: Days when scheduling call establishment will be attempted.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DayOfWeek'
      required:
      - days
      title: TimeWindow
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTemplateProviderStatusDetails:
      type: object
      description: List of template providers in the country and their template registration status.
      properties:
        providerName:
          type: string
          description: Name of the provider.
        status:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsProviderTemplateApiStatus'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when the status for this specific provider was last time updated.
      required:
      - providerName
      - status
      title: RcsTemplateProviderStatusDetails
    33e5f9b198702dad16ca1f81c1bb567a11b08d145013a25f78031b56a52d656b.SMSResponse:
      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. Typically, used to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs).
          readOnly: true
        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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSResponseDetails'
          readOnly: true
      title: SMSResponse
    431fb79b0e816230968e14ba1e1c6fadb75cfde9cb3c381f4217b2777f48153f.CallLog:
      type: object
      properties:
        callId:
          type: string
          description: Unique call ID.
          example: d8d84155-3831-43fb-91c9-bb897149a79d
          maxLength: 128
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        from:
          type: string
          description: Caller ID.
          example: '44790123456'
        to:
          type: string
          description: Callee ID.
          example: '44790987654'
        direction:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        state:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallState'
        startTime:
          type: string
          format: date-time
          description: Date and time for when the call has been created.
        answerTime:
          type: string
          format: date-time
          description: Date and time for when the call has been answered.
        endTime:
          type: string
          format: date-time
          description: Date and time for when the call has been finished.
        parentCallId:
          type: string
          description: Parent call ID.
          example: 3ad8805e-d401-424e-9b03-e02a2016a5e2
          maxLength: 128
        machineDetection:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MachineDetectionProperties'
        ringDuration:
          type: integer
          format: int64
          description: Ringing duration in seconds.
          example: 3
        callsConfigurationIds:
          type: array
          description: IDs of the calls configurations used during the call.
          example:
          - a1b06592152e08646b08c057
          items:
            type: string
            description: IDs of the calls configurations used during the call.
            example: '["a1b06592152e08646b08c057"]'
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        conferenceIds:
          type: array
          description: IDs of the conferences where the call was a participant.
          example:
          - 066675c6-0db6-0db9-b032-031964d09af4
          items:
            type: string
            description: IDs of the conferences where the call was a participant.
            example: '["066675c6-0db6-0db9-b032-031964d09af4"]'
        duration:
          type: integer
          format: int64
          description: Call duration in seconds.
          example: 5
        hasCameraVideo:
          type: boolean
          description: Indicates if camera was enabled during the call.
          example: false
        hasScreenshareVideo:
          type: boolean
          description: Indicates if screen sharing was enabled during the call.
          example: false
        errorCode:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo'
        customData:
          type: object
          additionalProperties:
            type: string
            example: '{"key1":"value1","key2":"value2"}'
          description: Custom data.
          example:
            key1: value1
            key2: value2
        dialogId:
          type: string
          description: Dialog ID.
          maxLength: 128
        sender:
          type: string
          description: Sender.
        hangupSource:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.HangupSource'
        externalId:
          type: string
          description: Client defined call ID.
      required:
      - endpoint
      title: CallLog
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.SeenReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        sentAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
        applicationId:
          type: string
          description: Application id that the message is linked to.
        entityId:
          type: string
          description: Entity id that the message is linked to.
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: SeenReport
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ToDestination'
        content:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent'
        options:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: KakaoAlimMessage
    a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMedia:
      type: object
      anyOf:
      - $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage'
      - $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo'
      description: Media information of included referral.
      discriminator:
        propertyName: type
        mapping:
          IMAGE: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaImage'
          VIDEO: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.ReferralMediaVideo'
      properties:
        type:
          $ref: '#/components/schemas/a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType'
      readOnly: false
      title: ReferralMedia
      writeOnly: true
    e2e56e613b621c92a292daf20c76b6dbff0520ca1b47769205b02fa7192a30b4.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
      title: MessageDeliveryReporting
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportsResponse:
      type: object
      properties:
        results:
          type: array
          description: List of MO report results.
          items:
            $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.MoReportResult'
        messageCount:
          type: integer
          format: int32
          description: Number of returned messages in this request.
        pendingMessageCount:
          type: integer
          format: int32
          description: Number of remaining messages on the server that have not been pulled yet.
      required:
      - messageCount
      - pendingMessageCount
      - results
      title: MoReportsResponse
    6423f137d264daaaab4ca521d6dfeb19cab29b6b25c3d2da0c1c3fb475a5e829.SipTrunkStatusRequest:
      type: object
      description: SIP trunk status request.
      properties:
        adminStatus:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkAdminStatus'
      required:
      - adminStatus
      title: SipTrunkStatusRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Language:
      type: object
      properties:
        languageCode:
          type: string
          description: '[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages.'
      title: Language
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallbackUrl:
      type: object
      description: Callback URL configuration.
      properties:
        url:
          type: string
          description: Callback URL.
        method:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MarkupHttpMethod'
      required:
      - url
      title: CallbackUrl
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.PageInfo:
      type: object
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.VoiceError:
      type: object
      description: Indicates whether the error occurred during the query execution.
      externalDocs:
        description: Response status and error codes
        url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes
      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.
      title: VoiceError
    a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording:
      type: object
      properties:
        callId:
          type: string
          description: Call ID.
          example: d8d84155-3831-43fb-91c9-10b5a8d628a0
          maxLength: 128
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        direction:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallDirection'
        files:
          type: array
          description: Call recording files.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingStatus'
        reason:
          type: string
          description: Reason for recording failure.
        callsConfigurationId:
          type: string
          description: Calls Configuration ID.
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        startTime:
          type: string
          format: date-time
          description: Date and time when the (first) call recording started.
        endTime:
          type: string
          format: date-time
          description: Date and time when the (last) call recording ended.
      required:
      - endpoint
      title: PublicCallRecording
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsFailoverOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
        validityPeriod:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTimeWindow'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
          maxLength: 255
          minLength: 0
        smsFailover:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DefaultSmsFailover'
        mmsFailover:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMmsFailover'
      title: RcsFailoverOptions
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageResponseStatus:
      type: string
      description: Message processing status.
      enum:
      - MESSAGE_ACCEPTED
      title: OpenChannelMessageResponseStatus
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.AdAccountStatus:
      type: string
      description: Ad account status.
      enum:
      - ACTIVE
      - DISABLED
      - UNSETTLED
      - PENDING_RISK_REVIEW
      - PENDING_SETTLEMENT
      - IN_GRACE_PERIOD
      - PENDING_CLOSURE
      - CLOSED
      - ANY_ACTIVE
      - ANY_CLOSED
      - UNKNOWN
      example: ACTIVE
      title: AdAccountStatus
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Hangup:
      type: object
      description: Hangup action terminates the call.
      properties:
        action:
          type: string
          description: Action discriminator.
          enum:
          - hangup
        errorCode:
          type: string
          default: REJECTED
          description: Error code to return when hanging up.
      required:
      - action
      title: Hangup
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultEventRequestOptions:
      type: object
      description: Options applicable to all events in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RequestSchedulingSettings'
      title: DefaultEventRequestOptions
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLanguage:
      type: object
      description: Sets the language parameters for the message being sent.
      properties:
        languageCode:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LanguageCode'
        singleShift:
          type: boolean
          default: false
          description: Uses a single shift table which enhances only the extension table of the GSM default alphabet. Allows you to selectively improve character support without altering the entire message.
        lockingShift:
          type: boolean
          default: false
          description: Uses a locking shift table which allows you to represent characters beyond the standard GSM default alphabet. This flexibility enables better language support.
      title: SmsLanguage
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookInboundRequest:
      type: object
      properties:
        results:
          type: array
          description: Collection of mobile originated messages.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.InboundMessageFacebookInboundContent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the results array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      title: FacebookInboundRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyWhatsAppContent'
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveVoiceButtonMessageActionWhatsAppContent'
      required:
      - body
      title: InteractiveVoiceButtonContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrMessagePrice:
      type: object
      description: Price object with traffic type information.
      properties:
        trafficType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsDlrTrafficType'
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: RcsDlrMessagePrice
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CallbackResponse:
      type: object
      discriminator:
        propertyName: command
        mapping:
          audio: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.AudioCallbackResponse'
          captureDtmf: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.CaptureDtmfCallbackResponse'
          dial: '#/components/schemas/0ea963ede06ee99578911cc0068f7474598729635091b55d2985483fad214d7b.DialCallbackResponse'
      properties:
        command:
          type: string
      required:
      - command
      title: CallbackResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingLog:
      type: object
      description: Conference recordings.
      properties:
        composedFiles:
          type: array
          description: File(s) with a recording of all conference participants.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
        callRecordings:
          type: array
          description: File(s) with a recording of one conference participant.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
      title: ConferenceRecordingLog
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory:
      type: string
      description: 'Billing category for the sender. Following billing categories are available:

        * `NON_CONVERSATIONAL`: Messages billed as standard RCS message that allows richer messaging experience. Never billed as `CONVERSATIONAL`.

        * `CONVERSATIONAL`: Billed as session in which user and agent can exchange a series of messages.'
      enum:
      - CONVERSATIONAL
      - NON_CONVERSATIONAL
      title: RcsSenderBillingCategory
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicSipTrunkServiceAddress:
      type: object
      properties:
        id:
          type: string
          description: SIP trunk service address ID.
        name:
          type: string
          description: SIP trunk service address name.
        street:
          type: string
          description: SIP trunk service address street.
        city:
          type: string
          description: SIP trunk service address city.
        postCode:
          type: string
          description: SIP trunk service address post code.
        suite:
          type: string
          description: SIP trunk service address suite.
        country:
          $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicCountry'
        region:
          $ref: '#/components/schemas/5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion'
      title: PublicSipTrunkServiceAddress
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DeliveryReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
        price:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessagePrice'
        status:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus'
        error:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageError'
        messageId:
          type: string
          description: Unique message ID.
        to:
          type: string
          description: Message destination address.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of sent messages.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        platform:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: DeliveryReport
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonActionType:
      type: string
      description: '`WEB_VIEW_URL` - opening of the external web content in webView, `OPEN_URL_IN_BROWSER` - opening of the external web content in device browser, `DEEP_LINK` - opening of particular mobile app screen over deep link.'
      enum:
      - WEB_VIEW_URL
      - DEEP_LINK
      - OPEN_URL_IN_BROWSER
      title: PrimaryButtonActionType
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingLocation:
      type: string
      enum:
      - SAO_PAULO
      - BOGOTA
      - FRANKFURT
      - JOHANNESBURG
      - JOHANNESBURG_1
      - NEW_YORK
      - PORTLAND
      - MOSCOW
      - SINGAPORE
      - ISTANBUL
      - KUALA_LUMPUR
      - JAKARTA
      - MUMBAI
      - HONG_KONG_1
      - HONG_KONG
      - RIYADH
      - CHENNAI
      title: RecordingLocation
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.UserTokenRefreshStatus:
      type: string
      description: Status of notification. This field is present only when the user stops or resumes Marketing Messages.
      enum:
      - REFRESHED
      - NOT_REFRESHED
      - UNKNOWN
      example: REFRESHED
      title: UserTokenRefreshStatus
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SwitchCase:
      type: object
      description: Switch-Case action takes a saved variable (obtained via either a Collect, Call API action or scenario parameters) and performs flow control based on it. It works similarly to the switch case block, using case-sensitive comparison.
      properties:
        switch:
          type: string
          description: Name of the variable whose value to inspect.
        case:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.CaseObject'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - case
      - switch
      title: Switch Case
    01b456ee89723218fe6e9044f9e602d2dda7aa7bf5bc0607681dd5bae7f811b9.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkScheduleResponse:
      type: object
      properties:
        externalBulkId:
          type: string
          description: The ID that uniquely identifies the sent bulk.
        bulks:
          type: array
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkInfo'
      required:
      - bulks
      - externalBulkId
      title: BulkScheduleResponse
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ToDestination'
        content:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContent'
        options:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.NonMsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Webhooks'
      required:
      - content
      - destinations
      - sender
      title: KakaoSangdamMessage
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckSyncRequest:
      type: object
      properties:
        sender:
          type: string
          description: Identifier of an RCS sender that will be used to send message.
        phoneNumbers:
          type: array
          description: A list of phone numbers (1 to 5) to check for RCS capability (for example, `["441134960001", "441134960002"]`).
          items:
            type: string
            xml:
              name: phoneNumbers
          maxItems: 500
          minItems: 1
        options:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CapabilityCheckOptions'
      required:
      - phoneNumbers
      - sender
      title: CapabilityCheckSyncRequest
      xml:
        name: CapabilityCheckSyncRequest
    655eaf80f7479f4a18447865649b33bdb754aaa97779726ffb72592cb1ac3ce5.MediaStreamConfigResponse:
      type: object
      discriminator:
        propertyName: type
        mapping:
          MEDIA_STREAMING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigResponse'
          WEBSOCKET_ENDPOINT: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigResponse'
      properties:
        id:
          type: string
          description: Media-stream configuration ID.
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResponseMediaStreamConfigType'
        name:
          type: string
          description: Media-stream configuration name.
        url:
          type: string
          description: Destination websocket or load balancer URL.
      title: MediaStreamConfigResponse
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Images:
      type: object
      description: Enumerate images shown on a call link page. Once an image is uploaded (by using the image upload API) a unique ID returned in that response can be used to add a background image or a logo image.
      properties:
        logoImageId:
          type: string
          description: ID of an image shown as a logo on a call link page.
        backgroundImageId:
          type: string
          description: ID of an image shown as a background on a call link page.
      title: Images
    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
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButtonType:
      type: string
      enum:
      - URL
      - APP_LINK
      - BOT_KEYWORD
      - MESSAGE_DELIVERY
      title: KakaoChinguButtonType
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MediaUploadResponse:
      type: object
      properties:
        mediaId:
          type: string
          description: Identifier of the uploaded media returned by Zalo.
          example: dbuzvadgdaaq9jjam7
      required:
      - mediaId
      title: MediaUploadResponse
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DeliveryTime:
      type: object
      properties:
        hour:
          type: integer
          format: int32
        minute:
          type: integer
          format: int32
      title: DeliveryTime
    6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.PublicPlayRequest:
      type: object
      description: Call play request.
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the file will be played.
        timeout:
          type: integer
          format: int64
          description: The duration, in milliseconds, of the file to be played. If timeout is not defined, the file will be played until it ends.
        offset:
          type: integer
          format: int64
          description: The starting point, in milliseconds, from which the file will be played. If offset is not defined, the file will be played from its beginning.
        content:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent'
        stopOn:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicTermination'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      required:
      - content
      title: PublicPlayRequest
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppInboundContactProfile:
      type: object
      properties:
        name:
          type: string
          description: Display name of the end user.
        phoneNumber:
          type: string
          description: Sender's phone number. May be absent if the user has enabled the Meta username feature and you have not exchanged messages with them in the last 30 days.
        userId:
          type: string
          description: Business-scoped user ID (BSUID) assigned by Meta. Stable identifier for the end user, scoped to the receiving business.
        parentUserId:
          type: string
          description: Business-scoped user ID valid across all phone numbers in a linked business portfolio. Present only for managed businesses with portfolio linking enabled.
        username:
          type: string
          description: Meta username of the end user. Present only if the user has a Meta username.
      title: WhatsAppInboundContactProfile
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionResponse:
      type: object
      description: List of actions.
      properties:
        key:
          type: string
          description: Action key.
        type:
          $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionType'
        callbackData:
          type: string
          description: Callback data that will be sent along with the message.
        forwardUrl:
          type: string
          description: URL for HTTP forward action.
      required:
      - key
      - type
      title: ActionResponse
    6665694460cb56ab854a173ada36805c85c7ec55584901d2f06225baf9b586cb.CallRecordingRequest:
      type: object
      properties:
        recordingType:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingType'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Custom data.
        filePrefix:
          type: string
          description: 'Custom name for the recording''s zip file. Applicable only when SFTP server is enabled on [Voice settings page](https://portal.infobip.com/apps/voice/recording/settings).

            Using the same `filePrefix` will override the files on the SFTP server.'
        channels:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingChannels'
      required:
      - recordingType
      title: CallRecordingRequest
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.KakaoSangdamOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - BUTTON_LIST
      - TERMINATE_SESSION
      title: KakaoSangdamOutboundContentType
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion:
      type: string
      description: 'RBM agents can be hosted in one of three regions: North America, Europe, or Asia Pacific, to help businesses comply with regional and regulatory requirements. Select the region based on the country where you plan to launch the sender. Please note that the hosting region cannot be changed once the sender is created.'
      enum:
      - NORTH_AMERICA
      - EUROPE
      - ASIA_PACIFIC
      title: HostingRegion
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushResponse:
      type: object
      properties:
        bulks:
          type: array
          description: Array of push bulk responses
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushBulkResponse'
      required:
      - bulks
      title: PushResponse
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.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/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MarketingMessageClick:
      type: object
      properties:
        notificationType:
          type: string
          description: 'Tells the type of user event that took place. Possible events: MARKETING_CLICK.'
        from:
          type: string
          description: Token that represents the recipient. It is used to send Marketing Messages.
        to:
          type: string
          description: Page ID.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to the recipient.
        campaignId:
          type: string
          description: Campaign Id.
        clickedAt:
          type: string
          format: date-time
          description: 'Date and time when the marketing message was clicked. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
      required:
      - campaignId
      - clickedAt
      - from
      - messageId
      - notificationType
      - to
      title: MarketingMessageClick
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoTrafficType:
      type: string
      description: Traffic type applied to the MO message. Null for not chargeable messages.
      enum:
      - BASIC
      - SINGLE
      - RICH
      - RICH_MEDIA
      title: RcsMoTrafficType
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.WebhookRequest:
      type: object
      example:
        sender: 2235ca45-afdd-47c9-a326-cf66e9872dda
        destination: '2324435353424'
        content:
          body:
            type: TEXT
            text: Text of example message
        callbackData: Example callback data
      properties:
        sender:
          type: string
          description: Open Channel sender ID registered on Infobip platform. In UUID format.
        destination:
          type: string
          description: Unique end user destination ID.
          maxLength: 255
          minLength: 0
        message:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageContent'
        callbackData:
          type: object
          description: Additional data that can be used for identifying a message response. Included in the inbound message request,  sent as response to inbound message.
      required:
      - destination
      - message
      - sender
      title: WebhookRequest
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMessageInteractionType:
      type: string
      description: 'The interaction type of the message that was sent. Note: this describes the message structure, not the billing category, which may differ.'
      enum:
      - BASIC_MESSAGE
      - SINGLE_MESSAGE
      - RICH_MESSAGE
      - RICH_MEDIA_MESSAGE
      title: RcsMessageInteractionType
    808c7c71509cd326700719db91283dfccde220d396434fc49825c692ac7499fd.RcsBulkSendTemplateRequest:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/a09fd2f38320e8e77c07ff55b0f3c0f934582962897bb3b86f1a032582a1cc60.RcsSendTemplateRequest'
      required:
      - messages
      title: RcsBulkSendTemplateRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMessageContent:
      type: object
      description: Message content.
      properties:
        subject:
          type: string
          description: 'Message subject.


            Note: This field is required if `templateId` is not present.'
          maxLength: 1000
          minLength: 1
        text:
          type: string
          description: Body of the message.
        html:
          type: string
          description: The message's body in HTML format. If both `html` and `text` fields are included, the `text` field will be disregarded, and the message will be sent using the `html` content.
        ampHtml:
          type: string
          description: 'The message''s body in AMP HTML format. If you include `ampHtml`, you must also include `html`, which will be displayed if AMP is not supported. Keep in mind that not all email clients support AMP HTML. For guidance on configuring the Gmail client, please visit this link: https://developers.google.com/gmail/ampemail/ .'
        templateId:
          type: string
          description: 'The Template ID with predefined email content created through the Infobip web interface or API. When `templateId` is specified, the `html` and `text` fields will be disregarded.


            Note: `templateId` only supports the `Broadcast` value; `Content` and `Flow` templates are not supported.'
        attachments:
          type: array
          description: File attachments.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaAttachment'
        inlineImages:
          type: array
          description: Allows for inserting an image file inside the HTML code of the email by using `cid:FILENAME` instead of providing an external link to the image.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailMediaInlineImage'
        defaultPlaceholders:
          type: string
          description: 'General placeholders: `{"ph1": "Success"}` will replace the key `{{ph1}}` with the value Success throughout the email, including the `subject`, `text`, and HTML. If there are multiple recipients in the To field, this placeholder will use the same value for the key ph1 for all recipients.'
        landingPagePlaceholders:
          type: string
          description: 'Personalize Opt-Out Landing Page by inserting placeholders. Insert placeholder or tag while designing landing page. Value should be defined as: `{"unsubscribe": "Unsubscribe"}`'
        optoutLandingPageId:
          type: string
          description: The Opt-Out Landing Page ID specifies the page to be displayed when an end user clicks the unsubscribe link. If the ID is not provided, the default opt-out landing page will be used. Create a landing page over Infobip web interface and use its ID, for example, `1_23456.`
        templateLanguageVersion:
          type: string
          default: '1'
          description: Indicates the version of the template language to be used in the current message template. Use version 1 for the older template language and version 2 to access features of the new template language. If not specified, version 1 will be used by default.
        headers:
          type: string
          description: 'Additional email headers for customization that can be provided in a form of JSON. Example: `headers={"X-CustomHeader": "Header value"}`.


            There are a few exceptions of headers which are not adjustable through this option: `To`, `Cc`, `Bcc`, `From`, `Subject`, `Content-Type`, `DKIM-Signature`, `Content-Transfer-Encoding`, `Return-Path`, `MIME-Version`'
      title: EmailMessageContent
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiPageDetails:
      type: object
      description: Paging response.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
        size:
          type: integer
          format: int32
          description: Requested page size.
      required:
      - page
      - size
      title: ApiPageDetails
    58f57942de1c194257c321b1824e5d3941d9e9f538a9f08ddcb73e6025439f43.MediaStreamConfigRequest:
      type: object
      discriminator:
        propertyName: type
        mapping:
          MEDIA_STREAMING: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaStreamingConfigRequest'
          WEBSOCKET_ENDPOINT: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.WebsocketEndpointConfigRequest'
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RequestMediaStreamConfigType'
        name:
          type: string
          description: Media-stream configuration name.
          maxLength: 128
          minLength: 0
        url:
          type: string
          description: Destination websocket or load balancer URL.
      required:
      - name
      - type
      - url
      title: MediaStreamConfigRequest
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.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
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SimulatorCallEndpointType:
      type: string
      enum:
      - SIP
      - PHONE
      - WEBRTC
      - WHATSAPP
      title: SimulatorCallEndpointType
    a012797e45a148c14a09b350fd3670874eb3f365931c630a0c2efc32c7293ff3.TokenResponseModel:
      type: object
      properties:
        token:
          type: string
          description: The access token used to connect client SDKs to Infobip WebRTC platform.
        expirationTime:
          type: string
          description: Time point until which token is valid. The default value is 8h. If it expires, the user must be provided with the new valid token in order to continue using Infobip WebRTC platform. There is no notification about token expiry, you must track that by yourself.
          example: '2022-05-01T14:25:55.123Z'
      title: TokenResponseModel
    eaaf11bb9830fc826a8597df01bea6f2a14ef6d1ed129a4f6623981d52827778.MarkupRequest:
      type: object
      description: Markup language request object.
      properties:
        callback:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Callback'
        endpoint:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.CallEndpoint'
        from:
          type: string
          description: Phone number from which the call originated from.
          example: '44790123456'
        externalId:
          type: string
          description: Unique identifier of the call.
        notifyUrl:
          type: string
          description: If set, the system will send a notification to this URL when the call ends.
        machineDetection:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetection'
      required:
      - callback
      - endpoint
      - from
      title: MarkupRequest
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpointType:
      type: string
      enum:
      - PHONE
      - SIP
      - WEBRTC
      - VIBER
      - WHATSAPP
      - WEBSOCKET
      title: CallEndpointType
    39bb6975d36d214ea076d974c69ec0b82edda805f4c6bf36a3f6f7d154c98fa0.PageInfo:
      type: object
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
          minimum: 0
        size:
          type: integer
          format: int32
          description: Requested page size.
          minimum: 1
        totalPages:
          type: integer
          format: int32
          description: The total number of pages of the results matching the requested parameters.
          minimum: 0
        totalResults:
          type: integer
          format: int64
          description: The total number of the results matching the requested parameters.
          minimum: 0
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PageInfo
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.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/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.SingleMessageStatus:
      type: object
      description: Indicates whether the message is successfully sent, not sent, delivered, not delivered, waiting for delivery or any other possible status.
      externalDocs:
        description: Response status and error codes
        url: https://www.infobip.com/docs/essentials/api-essentials/response-status-and-error-codes
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
        id:
          type: integer
          format: int32
          description: Status ID.
        name:
          type: string
          description: Status name.
        description:
          type: string
          description: Human-readable description of the status.
      title: SingleMessageStatus
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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
      writeOnly: true
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedMessageDeliveryReporting:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/sms-over-api#push-retry-cycle-notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. Defaults to `false`.
        notify:
          type: boolean
          description: 'Notify enables you to specify your preferences for receiving DLRs. If set to false, no DLR will be sent. Note: When no webhook is specified in the request and notify is set to ''true'' or not defined, your Subscription settings will apply.'
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: AdvancedMessageDeliveryReporting
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
      required:
      - body
      title: InteractiveLocationRequestContent
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.DeliveryReport:
      type: object
      allOf:
      - $ref: '#/components/schemas/31df1a57142f86aa8caefaa914e5a897a1c5c119e96ae8d3d5f19b12a525e2b7.Report'
      title: DeliveryReport
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContent:
      type: object
      description: Event content.
      discriminator:
        propertyName: type
        mapping:
          TYPING_INDICATOR: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventTypingIndicatorContent'
      properties:
        type:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType'
      title: WhatsAppOutboundEventContent
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.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/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.GetTemplateResponse:
      type: object
      properties:
        name:
          type: string
          description: Template name.
        templateContent:
          $ref: '#/components/schemas/58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateContent'
      required:
      - name
      - templateContent
      title: GetTemplateResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.DocumentContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        mediaUrl:
          type: string
          description: URL of a document sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Maximum document size is 100MB.
          maxLength: 2048
          minLength: 1
        caption:
          type: string
          description: Caption of the document.
          maxLength: 3000
          minLength: 0
        filename:
          type: string
          description: File name of the document.
          maxLength: 240
          minLength: 0
      required:
      - mediaUrl
      title: DocumentContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.FlexContainer:
      type: object
      discriminator:
        propertyName: type
        mapping:
          BUBBLE: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.BubbleFlexContainer'
          CAROUSEL: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.CarouselFlexContainer'
      properties:
        type:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.ContainerType'
      title: FlexContainer
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.TemplateResult:
      type: object
      properties:
        templateCode:
          type: string
      required:
      - templateCode
      title: TemplateResult
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DtmfType:
      type: string
      default: RFC2833
      description: DTMF type.
      enum:
      - RFC2833
      - INBAND
      title: DtmfType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number. Must be in international format and comply with [WhatsApp's requirements](https://www.infobip.com/docs/whatsapp/get-started/sender-registration#phone-number-what-you-need-to-know).
          maxLength: 24
          minLength: 1
        to:
          type: string
          description: Message recipient number in international format or WhatsApp business-scoped user ID.
          maxLength: 150
          minLength: 1
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
        content:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveLocationRequestContent'
        callbackData:
          type: string
          description: Custom client data that will be included in a [Delivery Report](#channels/whatsapp/receive-whatsapp-delivery-reports).
          maxLength: 4000
          minLength: 0
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/whatsapp/receive-whatsapp-delivery-reports), [Seen report format](#channels/whatsapp/receive-whatsapp-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        context:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext'
      required:
      - content
      - from
      - to
      title: InteractiveLocationRequestMessage
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEventRequest:
      type: object
      properties:
        events:
          type: array
          description: An array of event objects of the events to be sent.
          items:
            $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokEvent'
        options:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.DefaultEventRequestOptions'
      required:
      - events
      title: TikTokEventRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.VideoContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        mediaUrl:
          type: string
          description: URL of a video sent in a WhatsApp message. Must be a valid URL starting with `https://` or `http://`. Supported video types are `MP4`, `3GPP`. Maximum video size is 16MB.
          maxLength: 2048
          minLength: 1
        caption:
          type: string
          description: Caption of the video.
          maxLength: 3000
          minLength: 0
      required:
      - mediaUrl
      title: VideoContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IpCoreGeneralStatus:
      type: string
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: IpCoreGeneralStatus
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. A valid destination is required.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ToDestination'
        content:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent'
        options:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.NonMsisdnMessageFailoverOptions'
        webhooks:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.AdvancedWebhooksWithSeen'
      required:
      - content
      - destinations
      - sender
      title: ViberBotMessage
    b888d833f5e2077036527211f9d9a5502285e1c742cd8459a9d3ad85cb1fa1f5.PreviewResponse:
      type: object
      properties:
        originalText:
          type: string
          description: Message content supplied in the request.
        previews:
          type: array
          description: Allows for previewing the original message content once additional language configuration has been applied to it.
          items:
            $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Preview'
      title: PreviewResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingEventRequest:
      type: object
      properties:
        open:
          type: boolean
          description: Boolean value corresponding to whether opens for a message needs to be tracked or not.
          example: true
        clicks:
          type: boolean
          description: Boolean value corresponding to whether clicks for a message needs to be tracked or not.
          example: true
        unsubscribe:
          type: boolean
          description: Boolean value corresponding to whether unsubscribe for a message needs to be tracked or not.
          example: false
      title: TrackingEventRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ResponseMediaStreamConfigType:
      type: string
      description: Media stream configuration type.
      enum:
      - MEDIA_STREAMING
      - WEBSOCKET_ENDPOINT
      title: ResponseMediaStreamConfigType
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageContext:
      type: object
      description: Context object to define WhatsApp-specific metadata about a message.
      properties:
        replyToMessageId:
          type: string
          description: Inbound message ID used for a reply. Contextual bubble will not appear for template messages.
      required:
      - replyToMessageId
      title: MessageContext
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.RequestSchedulingSettings'
        priority:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.ClientPriority'
      title: TikTokMessageRequestOptions
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.Identity:
      type: object
      description: Information about the identity of the end user.
      properties:
        acknowledged:
          type: boolean
          description: Indicates whether identity is acknowledged.
          readOnly: false
          writeOnly: true
        hash:
          type: string
          description: Identifier for the latest user_identity_changed system notification
          readOnly: false
          writeOnly: true
        createdAt:
          type: string
          format: date-time
          description: 'Indicates when the identity was changed. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          readOnly: false
          writeOnly: true
      title: Identity
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DtmfOptions:
      type: object
      properties:
        maxInputLength:
          type: integer
          format: int32
          description: Maximum acceptable number of digits. Capturing is stopped after this number of digits has been entered. If not set, maximum value will be used.
          maximum: 64
          minimum: 1
        mappedValues:
          type: object
          additionalProperties:
            type: string
            description: 'Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter "English" menu, you can define {"1":"English"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks.'
          description: 'Map of expected collected DTMF values with some real meaning. (Example: if you have multilingual IVR, and option for users to press 1 to enter "English" menu, you can define {"1":"English"}, so the reporting and analysis will be easier). When this option is defined additional variable is present in the scenario. If you set your capture action variable name to myVar, then you will get additional variable myVar_Meaning containing the mapped value for a collected DTMF. Keys can contain only digits and asterisks.'
      required:
      - maxInputLength
      title: DtmfOptions
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.NonMsisdnSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.RegionalOptions'
        destinationMatching:
          type: array
          description: The SMS failover destination matching.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.FailoverDestinationPair'
      required:
      - text
      title: NonMsisdnSmsFailover
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.DtmfCaptureRequest:
      type: object
      properties:
        maxLength:
          type: integer
          format: int32
          description: Maximum number of digits to capture.
        timeout:
          type: integer
          format: int32
          description: The duration, in milliseconds, to wait for the first DTMF digit response.
        terminator:
          type: string
          description: Digit used to end input if less than `maxLength` digits have been pressed.
        digitTimeout:
          type: integer
          format: int32
          description: Duration, in milliseconds, to wait for a DTMF digit in-between individual digit inputs. If not set, `digitTimeout` will use the same duration as `timeout`.
        playContent:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicPlayContent'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      required:
      - maxLength
      - timeout
      title: DtmfCaptureRequest
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.DeliveryReport'
      title: DeliveryReports
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveMultiProductSectionContent:
      type: object
      description: An array of multi product sections.
      properties:
        title:
          type: string
          description: Title of the section. Required, if the message has more than one section.
          maxLength: 24
          minLength: 0
        productRetailerIds:
          type: array
          description: An array of product-unique identifiers as defined in the [catalog](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). 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](https://www.infobip.com/docs/whatsapp/manage-integration#enable-meta-catalog-for-product-based-messaging). If product retailer ID doesn't exist in your catalog, the product won't be displayed.
      required:
      - productRetailerIds
      title: InteractiveMultiProductSectionContent
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TimeUnitValueRange:
      type: string
      description: Message failover validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      - DAYS
      example: MINUTES
      title: TimeUnitValueRange
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionsResponse:
      type: object
      properties:
        actions:
          type: array
          description: List of actions.
          items:
            $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionResponse'
      required:
      - actions
      title: ActionsResponse
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedWebhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.AdvancedMessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: AdvancedWebhooks
    5cec81334b90b810e64e8923d2a0d906614be46012f19935bf49fd13e921d8b2.PublicRegion:
      type: object
      description: SIP trunk service address region.
      properties:
        name:
          type: string
          description: Name of the region from the country where SIP trunk is located.
        code:
          type: string
          description: Code of the region from the country where SIP trunk is located.
        countryCode:
          type: string
          description: Code of the country where SIP trunk is located.
      title: PublicRegion
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.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/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryDay'
        from:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryTime'
        to:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Destination:
      type: object
      description: Destinations to which you are sending a message, such as phone number, email address, or unique ID.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
        to:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To'
      title: Destination
      writeOnly: true
    a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkStatusResponse:
      type: object
      description: Bulk status response object.
      properties:
        bulkId:
          type: string
          description: Unique ID of the bulk.
        status:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.BulkStatus'
      required:
      - status
      title: BulkStatusResponse
    3307df001c42dd833d79f33c79b6946b4d01c30ce33030254141df9a2298b3c8.MessageCount:
      type: object
      properties:
        messageCount:
          type: integer
          format: int32
          description: Number of returned messages in this request.
          readOnly: false
          writeOnly: true
        pendingMessageCount:
          type: integer
          format: int32
          description: Number of remaining new messages on Infobip servers ready to be returned in the next request.
          readOnly: false
          writeOnly: true
      title: MessageCount
    7b23cc7ec456214e90b61e3d5abd3aaf7422ea4b20f1cdd2d4e9c44fbceaf035.SMSAdvancedBinaryRequest:
      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 to fetch [delivery reports](#channels/sms/get-outbound-sms-message-delivery-reports) and [message logs](#channels/sms/get-outbound-sms-message-logs). Anything above 100 characters passed in the request will be clipped during processing and returned in response, reports and 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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SMSBinaryMessage'
        sendingSpeedLimit:
          $ref: '#/components/schemas/87cf6d665490382407be009353007f071b1d6d4a375e96d31d3bf0b04b7fb3c7.SendingSpeedLimit'
      required:
      - messages
      title: SMSAdvancedBinaryRequest
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContent:
      type: object
      description: Event content.
      discriminator:
        propertyName: type
        mapping:
          TYPING_INDICATOR: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundTypingIndicatorContent'
      properties:
        type:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbOutboundEventContentType'
      required:
      - type
      title: AppleMfbOutboundEventContent
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ProcessedLocation:
      type: string
      description: Location of recording file after processing.
      enum:
      - UPLOADING
      - UPLOADED
      - HOSTED
      title: ProcessedLocation
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderStatus:
      type: string
      description: Status of the sender.
      enum:
      - BANNED
      - CONNECTED
      - DELETED
      - DISCONNECTED
      - FLAGGED
      - MIGRATED
      - PENDING
      - RATE_LIMITED
      - RESTRICTED
      - UNKNOWN
      - UNVERIFIED
      example: CONNECTED
      title: WhatsAppSenderStatus
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushRequestNotificationOptions:
      type: object
      description: JSON object that contains notification options.
      properties:
        title:
          type: string
          description: Notification title displayed within the notification. Requires iOS 10+ or Android 4.1+ (may depend on Android custom firmware)
          maxLength: 45
          minLength: 0
        soundEnabled:
          type: boolean
          description: Sound when a notification arrives on a device.
        soundName:
          type: string
          description: 'Name of the custom sound played when a notification arrives on a device. The audio file should be located in the app with max 30 seconds length. File extension is required for [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/How-to-use-custom-notification-sound%3F) and optional for [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/How-to-use-custom-notification-sound%3F). (Example: notification_sound.wav). Check Android and iOS usage details. To play a custom sound, `soundEnabled` must be set to `true`.'
        vibrationEnabled:
          type: boolean
          description: Notification vibration (Android only).
        isSilent:
          type: boolean
          description: Set to true to send silent push message. Such messages aren’t displayed on device lock screen and in the notification center. Silent messages can be used to deliver custom data to your mobile application or to trigger an in-app notification.
        badge:
          type: integer
          format: int32
          description: Badge counter (iOS only).
        contentUrl:
          type: string
          description: URL of the image displayed in the notification. Rich push notifications are available on devices with [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/Rich-notifications) 10 and [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/Rich-notifications) 4.1.+. Supported on iOS since MM SDK version 2.5.8. Supported on Android since MM SDK version 1.6.4.
        category:
          type: string
          description: 'Category id for actionable notification. Supported on [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/Interactive-notifications) since MM SDK version 1.6.16. Supported on [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/Interactive-Notifications) since MM SDK version 2.6.9. Predefined category ids: mm_accept_decline - Accept & Decline button actions.'
        showInApp:
          type: boolean
          description: Show notification in application.
        inAppStyle:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppStyle'
        inAppExpirationPeriod:
          type: integer
          format: int64
          description: Sets validity period for in-app notification. Users will only see in-app if they received it to their device within validity period, which starts from sending time. Time unit for this parameter is set by property of inAppExpirationTimeUnit. Default value is 48h. Supported on Android since version 3.4.0, on iOS since version 8.2.1
          minimum: 0
        inAppExpirationTimeUnit:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.InAppExpirationTimeUnit'
        inAppDismissTitle:
          type: string
          description: Specifies custom title for `Dismiss` button. Supported on Android since version 3.4.0, on iOS since version 8.2.1.
        inAppOpenTitle:
          type: string
          description: Specifies custom title for `Open` button. Supported on Android since version 3.4.0, on iOS since version 8.2.1.
        primaryButtonAction:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonAction'
        inboxTopic:
          type: string
          description: A case sensitive topic name to save a message to an inbox. If the topic name does not exist for a specified account, message sending will be rejected.
      title: PushRequestNotificationOptions
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AmdStatus:
      type: string
      description: The result of the machine detection process.
      enum:
      - HUMAN
      - MACHINE
      - MACHINE_EOM_BEEP
      - MACHINE_EOM_SILENCE
      - MACHINE_EOM_TIMEOUT
      example: HUMAN
      title: AmdStatus
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InboundMessageInstagramDmInboundContent:
      type: object
      description: Collection of mobile originated messages.
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        sender:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        integrationType:
          type: string
          description: Integration type.
        receivedAt:
          type: string
          format: date-time
          description: 'Date and time when Infobip received the message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        keyword:
          type: string
          description: Keyword extracted from the message text.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        pairedMessageId:
          type: string
          description: Message ID of paired outgoing message if matched by Infobip platform.
        callbackData:
          type: string
          description: Callback data sent through ‛callbackData‛ field when sending message.
        message:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContent'
        price:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessagePrice'
      required:
      - integrationType
      - message
      - messageId
      - price
      - receivedAt
      - sender
      - to
      title: InboundMessageInstagramDmInboundContent
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.ContactName:
      type: object
      properties:
        name:
          type: string
          description: Contact name
          readOnly: false
          writeOnly: true
        phoneNumber:
          type: string
          description: Sender's phone number.
          writeOnly: true
        userId:
          type: string
          description: User ID
          readOnly: false
          writeOnly: true
        parentUserId:
          type: string
          description: parent user ID.
          readOnly: false
          writeOnly: true
        username:
          type: string
          description: Username.
          readOnly: false
          writeOnly: true
      title: Contact
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MoDestinationTo:
      type: object
      properties:
        to:
          type: string
          description: Message destination address.
          example: '41793026777'
      title: Destination as To
    52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionModel:
      type: object
      description: Conversions collection.
      properties:
        ctwaClickId:
          type: string
          description: ctwaClickId is unique identifier of each click on the ad that clicks to WhatsApp. ctwaClickId is contained within the inbound message originating from the ad within the referral object. Check payload [here](https://www.infobip.com/docs/api/channels/whatsapp/whatsapp-inbound-messages/receive-whatsapp-inbound-messages).
          example: ARAkLkA8rmlFeiCktEJQ-QT
        type:
          $ref: '#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.MetaConversionType'
        details:
          $ref: '#/components/schemas/52c80a2bd29a734b52d9eb3ddb9b5d8ef0cb7c55640245f275763458f4c36a60.ConversionDetails'
        conversionTime:
          type: string
          format: date-time
          description: Time when the conversion happened. Must be in the format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Date must not be older than 7 days. If omitted then current time of submission is used.
          example: '2024-05-14T10:11:45.057Z'
      required:
      - ctwaClickId
      - type
      title: MetaConversionModel
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.SeenReport:
      type: object
      description: Collection of reports, one per every message.
      properties:
        messageId:
          type: string
          description: The ID of the sent message.
        from:
          type: string
          description: Number which sent the message.
        to:
          type: string
          description: Sender provided during the activation process.
        sentAt:
          type: string
          format: date-time
          description: Tells when the message was sent.
        seenAt:
          type: string
          format: date-time
          description: Tells when the message was seen.
        applicationId:
          type: string
          description: Application id that the message is linked to.
        entityId:
          type: string
          description: Entity id that the message is linked to.
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: SeenReport
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.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
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.IfThenElse:
      type: object
      description: If-Then-Else action provides simple branching based on a condition. If the condition evaluates to true, the then block is executed, otherwise the else block is executed. Only one of the blocks is required to be non-empty.
      properties:
        if:
          type: string
          description: The expression to evaluate
        then:
          type: array
          description: The actions to execute if condition is evaluated to true.
          items:
            type: object
            description: The actions to execute if condition is evaluated to true.
        else:
          type: array
          description: The actions to execute if condition is evaluated to false.
          items:
            type: object
            description: The actions to execute if condition is evaluated to false.
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - if
      title: If Then Else
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ViberVideoMessage:
      type: object
      properties:
        from:
          type: string
          description: Registered Viber Sender name.
          maxLength: 20
          minLength: 2
        to:
          type: string
          description: 'Message recipient number. Must be in international format and must be internationally reachable (Example: `385977666618`).'
          pattern: ^[0-9]{1,15}$
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 50
          minLength: 1
        content:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.VideoContent'
        callbackData:
          type: string
          description: Custom client's data that will be included in Delivery Report.
          maxLength: 4000
          minLength: 1
        trackingData:
          type: string
          description: Custom client's data that will be passed back with user's reply.
          maxLength: 100
          minLength: 1
        smsFailover:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SmsFailover'
        notifyUrl:
          type: string
          description: The URL on your callback server to which delivery and seen reports will be sent. [Delivery report format](#channels/viber/receive-viber-delivery-reports), [Seen report format](#channels/viber/receive-viber-seen-reports).
          maxLength: 2048
          minLength: 0
        urlOptions:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.UrlOptions'
        entityId:
          type: string
          description: Required for entity use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
        applicationId:
          type: string
          description: Required for application use in a send request for outbound traffic. Returned in notification events. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
          writeOnly: true
      required:
      - content
      - from
      - to
      title: ViberVideoMessage
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DomainInfo:
      type: object
      description: Domain get response.
      properties:
        domainName:
          type: string
          description: Name of the requested domain.
        dataAccess:
          $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.ApiDomainAccess'
        readBounces:
          type: boolean
          description: Read bounces permission.
        createBounces:
          type: boolean
          description: Create bounces permission.
        deleteBounces:
          type: boolean
          description: Delete bounces permission.
        readComplaints:
          type: boolean
          description: Read complaints permission.
        createComplaints:
          type: boolean
          description: Create complaints permission.
        deleteComplaints:
          type: boolean
          description: Delete complaints permission.
        readOverquotas:
          type: boolean
          description: Read overquotas permission.
        deleteOverquotas:
          type: boolean
          description: Delete overquotas permission.
      required:
      - createBounces
      - createComplaints
      - dataAccess
      - deleteBounces
      - deleteComplaints
      - deleteOverquotas
      - domainName
      - readBounces
      - readComplaints
      - readOverquotas
      title: DomainInfo
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundTextContent'
          IMAGE: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundImageContent'
          SHARE_POST: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundSharePostContent'
          REFERRAL_AD: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundReferralAdContent'
          REFERRAL_SHORT_LINK: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundReferralShortLinkContent'
          REACTION: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundReactionContent'
      properties:
        type:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokInboundContentType'
      title: TikTokInboundContent
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TextContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        text:
          type: string
          description: Content of the message being sent.
          maxLength: 1000
          minLength: 1
        button:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.ButtonWithAction'
      required:
      - text
      title: TextContent
    450b8e1c5aa2576ea4225d97920eb07c6a588176f5f842cc401b6c579419dc38.IntegrationType:
      type: object
      properties:
        integrationType:
          type: string
          description: Integration type.
          enum:
          - VIBER
          readOnly: false
          writeOnly: true
      title: IntegrationType
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.UrlDestinationResponse:
      type: object
      discriminator:
        propertyName: type
        mapping:
          ENDPOINT: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.EndpointDestinationResponse'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DestinationType'
      required:
      - type
      title: UrlDestinationResponse
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Transcription:
      type: object
      properties:
        language:
          $ref: '#/components/schemas/61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language'
        sendInterimResults:
          type: boolean
          default: false
          description: Flag indicating whether interim transcription results should be sent.
        customDictionary:
          type: array
          description: Array of custom words used for more accurate transcription.
          items:
            type: string
            description: Array of custom words used for more accurate transcription.
        advancedFormatting:
          type: boolean
          default: false
          description: Toggles enhanced text formatting features like punctuation, proper casing, numeral normalization, and disfluency filtering. Defaults to `false`.
        provider:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Provider'
      required:
      - language
      title: Transcription
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.TemplateButton:
      type: object
      description: List of template buttons.
      properties:
        type:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ButtonType'
        title:
          type: string
          description: Button title.
        content:
          type: string
          description: Button content.
      title: TemplateButton
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateStatus:
      type: string
      description: Current approval status of the template in the review process.
      enum:
      - PENDING
      - APPROVED
      - DECLINED
      example: APPROVED
      title: TemplateStatus
    8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.DeliveryReport'
      title: DeliveryReports
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsResponse:
      type: object
      properties:
        results:
          type: array
          description: Array of voice message logs, one object per each message.
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.LogsReport'
      title: LogsResponse
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Address:
      type: object
      description: Address information.
      properties:
        street:
          type: string
          description: Street name.
          writeOnly: true
        city:
          type: string
          description: City name.
          writeOnly: true
        state:
          type: string
          description: State name.
          writeOnly: true
        zip:
          type: string
          description: Zip value.
          writeOnly: true
        country:
          type: string
          description: Country name.
          writeOnly: true
        countryCode:
          type: string
          description: Country code value.
          writeOnly: true
        type:
          type: string
          description: Type of an address. Can be HOME, WORK.
          writeOnly: true
      title: Address
      writeOnly: true
    58b7723d552ea7166ae4b26f13a2e9dab0154f96a724621e17ccb41009cc81fb.BrandMessagesTemplateTypes:
      type: string
      enum:
      - TEXT
      - IMAGE
      - IMAGE_WIDE
      - ITEM_LIST
      title: BrandMessagesTemplateTypes
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTextContent'
          TYPING_INDICATOR: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTypingIndicatorContent'
          LIST_PICKER_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundListPickerContent'
          TIME_PICKER_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundTimePickerContent'
          AUTHENTICATION_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundAuthContent'
          APPLE_PAY_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundPayResponseContent'
          CUSTOM_INTERACTIVE_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCustomInteractiveContent'
          CLOSE_CONVERSATION: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundCloseConversationContent'
          QUICK_REPLY: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundQuickReplyContent'
          FORM_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundFormContent'
          INVITATION_RESPONSE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundInvitationContent'
          ROADSIDE_ASSISTANCE: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundRoadsideAssistanceContent'
      properties:
        type:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbInboundContentType'
      required:
      - type
      title: AppleMfbInboundContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.ForEach:
      type: object
      description: For-each action is a control statement that executes a block of code for each of the values within the supplied list. The Supplied list of values can be static or dynamic (defined as user variable).
      properties:
        for-each:
          type: string
          description: Variable name that will be used inside the loop to represent single value from supplied list of values.
        in:
          type: string
          description: List of values that will be iterated over. Must be delimited with specified `delimiter`.
        delimiter:
          type: string
          default: ','
          description: Delimiter for separating values in the list of values.
        do:
          type: array
          description: Array of actions to execute.
          items:
            type: object
            description: Array of actions to execute.
      required:
      - do
      - for-each
      - in
      title: For Each
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonAction:
      type: object
      description: Defines which action to perform on notification tap or on in-app notification primary button tap. More information for [Android](https://github.com/infobip/mobile-messaging-sdk-android/wiki/How-to-define-specific-action-on-notification-or-in-app-primary-button-tap(open-url,-deeplink)%3F), [iOS](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/How-to-define-specific-action-on-notification-or-in-app-primary-button-tap(open-url,-deeplink)%3F), [Cordova](https://github.com/infobip/mobile-messaging-cordova-plugin/wiki/How-to-define-specific-action-on-notification-or-in-app-primary-button-tap(open-url,-deeplink)%3F), [React Native](https://github.com/infobip/mobile-messaging-react-native-plugin/wiki/How-to-define-specific-action-on-notification-or-in-app-primary-button-tap(open-url,-deeplink)%3F).
      properties:
        resource:
          type: string
          description: Defines which URL or path should be opened.
        type:
          $ref: '#/components/schemas/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PrimaryButtonActionType'
      title: PrimaryButtonAction
    61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpDetailResponse:
      type: object
      properties:
        id:
          type: string
          description: Dedicated IP identifier.
        ip:
          type: string
          deprecated: true
          description: Dedicated IP address.
        ipAddresses:
          type: array
          description: List of IP addresses that are paired together.
          items:
            type: string
          minItems: 1
          uniqueItems: true
        pools:
          type: array
          description: IP pools which have assigned the provided dedicated IP.
          items:
            $ref: '#/components/schemas/61cea6785aa06882a92b0d6cc8c922ce1d44b92bfbdfd6cde0df0f73fb2499d6.IpPoolResponse'
          minItems: 0
          uniqueItems: true
      required:
      - id
      - ip
      - ipAddresses
      - pools
      title: IpDetailResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveRowContent:
      type: object
      description: An array of rows sent within a section. Section must contain at least one row. Message can have up to ten rows.
      properties:
        id:
          type: string
          description: Identifier of the row. It must be unique across all sections.
          maxLength: 200
          minLength: 1
        title:
          type: string
          description: Title of the row.
          maxLength: 24
          minLength: 1
        description:
          type: string
          description: Description of the row.
          maxLength: 72
          minLength: 0
      required:
      - id
      - title
      title: InteractiveRowContent
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentUpdateResult:
      type: object
      description: List of consent update results.
      properties:
        channel:
          type: string
          description: Channel identifier.
          example: MESSENGER
        event:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.ConsentEvent'
        sender:
          type: string
          description: Business identifier (Facebook page ID).
          example: '112345678901234'
        from:
          type: string
          description: End-user identifier (page-scoped user ID).
          example: '6662136340512053'
        createdAt:
          type: string
          description: ISO 8601 timestamp of the event.
          example: 2024-01-14T12:00:00.000+0000
        channelData:
          $ref: '#/components/schemas/cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.MessengerConsentChannelData'
      required:
      - channel
      - channelData
      - createdAt
      - event
      - from
      - sender
      title: MessengerConsentUpdateResult
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    01e84c3b4dd6fb6c49761ac60f0bbc50e5117905a6beb7547645113e59aaeb46.PreviewRequest:
      type: object
      properties:
        text:
          type: string
          description: Content of the message being sent.
        languageCode:
          type: string
          description: '[Language code](https://www.infobip.com/docs/sms/language#national-language-identifier) for the correct character set. `AUTODETECT` lets the platform select the character set based on message content only for supported languages.'
          pattern: ^(TR|ES|PT|AUTODETECT)$
        transliteration:
          type: string
          description: The transliteration of your sent message from one script to another. [Transliteration](https://www.infobip.com/docs/sms/language#sms-transliteration) is used to replace characters which are not recognized as part of your defaulted alphabet. `ALL` means that the transliteration process will recognize all supported languages.
          pattern: ^(TURKISH|GREEK|CYRILLIC|SERBIAN_CYRILLIC|BULGARIAN_CYRILLIC|CENTRAL_EUROPEAN|BALTIC|PORTUGUESE|COLOMBIAN|NON_UNICODE|NONE|ALL)$
      required:
      - text
      title: PreviewRequest
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.WebhookRecording:
      type: object
      description: Recording of the call.
      properties:
        composedFiles:
          type: array
          description: List of composed files.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.File'
        callRecordings:
          type: array
          description: List of call recordings.
          items:
            $ref: '#/components/schemas/2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.FileRecording'
      title: WebhookRecording
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.IndiaDltOptions:
      type: object
      description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.VideoContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        text:
          type: string
          description: Text to be displayed alongside the video.
          maxLength: 1000
          minLength: 1
        mediaUrl:
          type: string
          description: URL of the video being sent. Must be a valid URL starting with https:// or http://. The resource must allow HEAD request with 'Content-Length' header. Supported video types are .3gp, .m4v, .mov, .mp4. Maximum video size is 200 MB.
          maxLength: 1000
          minLength: 0
        thumbnailUrl:
          type: string
          description: 'URL of the thumbnail being sent. Must be a valid URL starting with https:// or http://. Supported thumbnail types are .jpg, .jpeg, .png.Recommended resolution: 800 px x 800 px.'
        mediaDuration:
          type: integer
          format: int32
          description: How long is the video. Maximum video duration is 600s.
          maximum: 600
          minimum: 1
        buttonTitle:
          type: string
          description: Button text.
          maxLength: 30
          minLength: 1
      required:
      - mediaDuration
      - mediaUrl
      - thumbnailUrl
      title: VideoContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DefaultSmsFailover:
      type: object
      description: Failover SMS message to be sent if the original message could not be delivered. Please note that either SMS failover or MMS failover can be set, but not both.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        text:
          type: string
          description: Content of the message being sent.
        validityPeriod:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.ValidityPeriod'
        regional:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RegionalOptions'
      required:
      - text
      title: DefaultSmsFailover
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateLang:
      type: string
      description: Language code for the template body.
      enum:
      - ar
      - hy
      - be
      - bs
      - bg
      - my
      - hr
      - cs
      - da
      - nl
      - en
      - fi
      - fr
      - ka
      - de
      - el
      - he
      - hu
      - id
      - it
      - ja
      - ne
      - 'no'
      - fa
      - pl
      - ro
      - ru
      - sr
      - sk
      - sl
      - es
      - sv
      - th
      - tr
      - uk
      - vi
      - zh-Hans
      - zh-Hant
      - pt_BR
      - pt_PT
      - fr_FR
      - es_ES
      example: en
      title: TemplateLang
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.CreateAudienceRequest:
      type: object
      properties:
        name:
          type: string
          description: Custom audience name.
          example: My CRM Audience
          maxLength: 255
          minLength: 1
        description:
          type: string
          description: Custom audience description.
          example: Q3 campaign target users
          maxLength: 1024
          minLength: 0
        adAccountId:
          type: string
          description: Facebook ad account ID.
          example: act_3339405976215927
          maxLength: 100
          minLength: 1
        pageId:
          type: string
          description: Facebook page ID linked to marketing messages.
          example: '108968269613427'
          maxLength: 100
          minLength: 1
      required:
      - adAccountId
      - name
      - pageId
      title: CreateAudienceRequest
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    a381f86553e288851808282b347a5f8bd7ba34b9b6feb33f5946feb4892476be.StatisticsResponse:
      type: object
      properties:
        totalSent:
          type: integer
          format: int64
          description: Total number of sent messages.
        delivered:
          type: integer
          format: int64
          description: Total number of delivered messages.
        seen:
          type: integer
          format: int64
          description: Total number of seen messages.
        errors:
          $ref: '#/components/schemas/999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.ErrorInfo'
        delivery:
          $ref: '#/components/schemas/999e23a63911c41e6f288f288564c4bc2e6a35a6f2a9edba53ecac8c52fe9339.DeliveryInfo'
      required:
      - delivered
      - delivery
      - errors
      - seen
      - totalSent
      title: StatisticsResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeoLocationInfoWrapper:
      type: object
      description: Geolocation data such as Country and City.
      properties:
        countryName:
          type: string
          description: Country where the user action is recorded.
        city:
          type: string
          description: City where the user action is recorded.
      title: GeoLocationInfoWrapper
    a4e0c51a24a360282e1a40c61554d239555404b786d84603912030fc4cdbb512.MediaType:
      type: string
      enum:
      - IMAGE
      - VIDEO
      title: Type
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.DeliveryReport'
      title: DeliveryReports
    0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageRequest:
      type: object
      example:
        sender: '2324435353424'
        destination: 2235ca45-afdd-47c9-a326-cf66e9872dda
        content:
          body:
            text: Text of the example message.
            type: TEXT
        responseWebhook:
          callbackData: exampleCallbackData
        metadata:
          field: value
      properties:
        sender:
          type: string
          description: Unique end user sender ID.
          maxLength: 255
          minLength: 0
        destination:
          type: string
          description: Open Channel destination ID registered on Infobip platform, required to be in UUID format.
        content:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelMessageContent'
        responseWebhook:
          $ref: '#/components/schemas/0a37b8c521b3309d1bbd0669d19fc7f2f157d68a68747b5e7ad23e5b0f5e47e8.OpenChannelWebhookData'
        metadata:
          type: object
          additionalProperties:
            type: object
          description: Metadata which will be passed through message to be used in product business logic.
      required:
      - content
      - destination
      - sender
      title: OpenChannelMessageRequest
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.WhatsAppSenderQualityRating:
      type: string
      description: Quality of the sender.
      enum:
      - HIGH
      - LOW
      - MEDIUM
      - UNKNOWN
      example: HIGH
      title: WhatsAppSenderQualityRating
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.ProviderLaunchStatus:
      type: string
      description: 'Launch status for this specific provider. Possible values:

        * `PENDING`: Status returned when the launch request has not yet been submitted to the provider.

        * `IN_PROGRESS`: Status returned when the launch process with the provider has started.

        * `COMPLETED`: Status returned when the launch process with the provider has successfully finished.

        * `REJECTED`: Status returned when the launch process with the provider has finished unsuccessfully.

        * `NOT_REQUESTED`: Status returned when the provider has been excluded from the launch process.

        '
      enum:
      - PENDING
      - IN_PROGRESS
      - COMPLETED
      - REJECTED
      - NOT_REQUESTED
      title: ProviderLaunchStatus
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpoint:
      type: object
      description: Call endpoint. Represents the callee for a call.
      discriminator:
        propertyName: type
        mapping:
          PHONE: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkPhoneEndpoint'
      example:
        phoneNumber: '41792030000'
        type: PHONE
      properties:
        type:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.BulkEndpointType'
      title: CallEndpoint
    c18e27d419b307552daa9403b0085ee796da1a5e57e2a4e6fb73f406471574fc.Participant:
      type: object
      properties:
        callId:
          type: string
          description: Participant call ID.
          maxLength: 128
        endpoint:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallEndpoint'
        state:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantState'
        joinTime:
          type: string
          format: date-time
          description: Date and time when the participant has joined.
        leaveTime:
          type: string
          format: date-time
          description: Date and time when the participant has left.
        media:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.MediaProperties'
        role:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role'
      required:
      - endpoint
      title: Participant
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsLogSmsMessageContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessagePrice'
        status:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageStatus'
        error:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.MessageError'
        platform:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Platform'
        content:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
        mccMnc:
          type: string
          description: Mobile country and network codes.
      title: SmsLogSmsMessageContent
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.VKontakteData:
      type: object
      description: VKontakte-specific data used if the message is sent through a VKontakte channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        templateName:
          type: string
          description: Template name
          writeOnly: true
        templateData:
          type: object
          additionalProperties:
            type: object
            writeOnly: true
          description: JSON object where the keys are names of parameters in the template.
          writeOnly: true
      title: VKontakteData
      writeOnly: true
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.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/be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.SendingSpeedLimit'
      title: RequestSchedulingSettings
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.CardAllowedTemplateButtonContent:
      type: object
      description: Card buttons. Define buttons only for `quick reply` or `dynamic URL` buttons (in the required order). For static URL button, omit the buttons section.
      discriminator:
        propertyName: type
        mapping:
          QUICK_REPLY: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateQuickReplyButtonContent'
          URL: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.TemplateUrlButtonContent'
      properties:
        type:
          type: string
      required:
      - type
      title: CardAllowedTemplateButtonContent
    e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.LogTikTokOutboundMessageContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessagePrice'
        status:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageStatus'
        error:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.MessageError'
        platform:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.Platform'
        content:
          $ref: '#/components/schemas/e2cbdd2d36d35e3e9c85bc5344135c1a087d73d9cf6c9dc8cf1c258211186c7c.TikTokOutboundMessageContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogTikTokOutboundMessageContent
    62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoReportResponse:
      type: object
      properties:
        results:
          type: array
          description: Results.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoReport'
      title: MMSMoReportResponse
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogPrice:
      type: object
      properties:
        pricePerMessage:
          type: number
          format: double
          description: Price per one SMS.
          readOnly: true
        currency:
          type: string
          description: The currency in which the price is expressed.
          readOnly: true
      title: LogPrice
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.DialogRecordingLog:
      type: object
      description: Dialog recordings.
      properties:
        composedFiles:
          type: array
          description: File(s) with a recording of both dialog calls.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicRecordingFile'
        callRecordings:
          type: array
          description: File(s) with a recording of individual dialog calls.
          items:
            $ref: '#/components/schemas/a8c993b4bcabd2960dfaf3986394e0fe85cd1c09dc98b0a81b51403a00c8f97c.PublicCallRecording'
      title: DialogRecordingLog
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotificationResponse:
      type: object
      properties:
        from:
          type: string
          description: Registered WhatsApp sender number.
          minLength: 1
        content:
          allOf:
          - $ref: '#/components/schemas/0b5f1ca361e90fa0a3f8b907dc53fa34f06ccd85fde4d07f80394e60f5f23c99.MarketingUpdateNotification'
          description: Content of the notification.
        createdAt:
          type: string
          format: date-time
          description: 'Tells when the event occurred. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
      title: whatsappMarketingUpdateNotificationResponse
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.CameraFacingMode:
      type: string
      default: FRONT
      description: In the case of a video call on mobile phones camera will be back or front depending on this value. It is 'FRONT' by default.
      enum:
      - FRONT
      - BACK
      title: CameraFacingMode
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestDeviceStatus:
      type: string
      description: 'Status of the test number. It''ll be updated by Infobip platform automatically and notification about test number status update will be sent to client''s webhook. Following statuses are available:

        * `PENDING`: Test device registration is pending until 3rd party action will be executed.

        * `WAITING_FOR_TESTER_ACCEPTANCE`: Waiting for user to accept request to become a tester.

        * `APPROVED`: User has accepted to become a tester and test messages can be sent to that number.

        * `EXPIRED`: If user does not accept invitation within 24h, status of test number will be moved to EXPIRED.

        * `UNSUPPORTED`: Test number is not supported for RCS traffic.

        * `FAILED`: Failed mostly because of some internal service error during request processing. Please contact support.'
      enum:
      - PENDING
      - WAITING_FOR_TESTER_ACCEPTANCE
      - APPROVED
      - EXPIRED
      - UNSUPPORTED
      - FAILED
      title: RcsTestDeviceStatus
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase:
      type: string
      description: 'Use case for the sender. Following use cases are available:

        * `OTP`: Used for senders that only send one time passwords.

        * `TRANSACTIONAL`: Used for senders that send only essential, necessary and time-sensitive messages.

        * `PROMOTIONAL`: Used for senders that send promotional messages.

        * `MULTI_USE`: Used for senders that have multiple use cases.'
      enum:
      - OTP
      - TRANSACTIONAL
      - PROMOTIONAL
      - MULTI_USE
      title: RcsUseCase
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Tracking:
      type: object
      description: 'Allows you to set up tracking parameters to track conversion metrics. For more details, see: [SMS with conversion tracking](https://www.infobip.com/docs/sms/sms-over-api#send-sms-with-conversion-tracking).'
      properties:
        useConversionTracking:
          type: boolean
          description: Indicates if a message has to be tracked for conversion rates. Default "false".
        conversionTrackingName:
          type: string
          description: Sets a custom conversion type naming convention, e.g. `ONE_TIME_PIN` or `SOCIAL_INVITES`.
      title: Tracking
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventContent:
      type: object
      description: Conversation Started event details.
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsConversationStartedEventType'
      required:
      - type
      title: RcsConversationStartedEventContent
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FailoverDestinationPair:
      type: object
      description: The SMS failover destination matching.
      properties:
        initial:
          type: string
          description: The initial destination address specified in the request.
        failover:
          type: string
          description: 'The failover destination address to be used instead of the original destination address. Addresses must be in international format (Example: `41793026727`)'
      required:
      - failover
      - initial
      title: FailoverDestinationPair
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.LogViberBotOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice'
        status:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageStatus'
        error:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageError'
        platform:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.Platform'
        content:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: LogViberBotOutboundContent
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.PushData:
      type: object
      description: Push-specific data used if the message is sent through a Push channel.
      properties:
        text:
          type: string
          description: Text of the message that will be sent.
          maxLength: 2000
          minLength: 1
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        customPayload:
          type: object
          additionalProperties:
            type: object
            writeOnly: true
          description: Additional custom data delivered with the Push message.
          writeOnly: true
        notificationOptions:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.NotificationOptions'
        targetOnlyPrimaryDevices:
          type: boolean
          description: Set to true to only send messages to push devices which are marked as primary devices. By default, messages will be sent to all targeted devices, including both primary and non-primary.
          writeOnly: true
        includeNotificationsDisabledDevices:
          type: boolean
          description: Flag which shows if devices with disabled notifications are included.
          writeOnly: true
        personSubscriptions:
          type: array
          description: Key set of custom attributes on person for additional filtering.
          items:
            type: string
            description: Key set of custom attributes on person for additional filtering.
            writeOnly: true
          uniqueItems: true
          writeOnly: true
        deviceSubscriptions:
          type: array
          description: Key set of custom attributes on device for additional filtering.
          items:
            type: string
            description: Key set of custom attributes on device for additional filtering.
            writeOnly: true
          uniqueItems: true
          writeOnly: true
      title: PushData
      writeOnly: true
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParam:
      type: object
      description: Variable parameter definition for template placeholders.
      maxLength: 8
      properties:
        type:
          $ref: '#/components/schemas/9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParamType'
        name:
          type: string
          description: Name or identifier of the parameter, used to reference it in the template. Must have the same name as the placeholder in the template content.
          example: orderId
          maxLength: 50
          minLength: 0
        example:
          type: string
          description: Example value for the parameter, used for template preview and validation.
          example: ORD-12345
          maxLength: 125
          minLength: 0
      required:
      - example
      - name
      - type
      title: TemplateParam
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsEventOptions:
      type: object
      description: Event options.
      properties:
        platform:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.Platform'
        deliveryTimeWindow:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTimeWindow'
      title: RcsEventOptions
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundTextContent'
          URL: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundUrlContent'
          AUDIO: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundAudioContent'
          VIDEO: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundVideoContent'
          FILE: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundFileContent'
          IMAGE: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundImageContent'
          LOCATION: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundLocationCoordinatesContent'
          LOCATION_URL: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundLocationUrlContent'
          POSTBACK: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundPostbackContent'
          SHARE: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundShareContent'
          STORY_MENTION: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MentionInstagramDmInboundStoryContent'
          PRODUCT: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundProductContent'
          UNKNOWN: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundUnknownContent'
      properties:
        type:
          $ref: '#/components/schemas/8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.InstagramDmInboundContentType'
      title: InstagramDmInboundContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.UrlTrackingWebhook:
      type: object
      properties:
        notificationType:
          type: string
          description: 'Tells the type of user event that took place. Possible events: CLICKED'
        recipient:
          type: string
          description: Recipient of the message.
        url:
          type: string
          description: The link the recipient has clicked.
        sendDateTime:
          type: integer
          format: int64
          description: This is timestamp epoch millis when we received event for CLICK.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent to the recipient.
        bulkId:
          type: string
          description: The ID that uniquely identifies a list of messages. This is either defined by user in the request or auto generated.
        callbackData:
          type: string
          description: The callback data sent through the callbackData field in your fully featured message.
        recipientInfo:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.RecipientInfo'
        geoLocationInfo:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.GeoLocationInfoWrapper'
        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).
        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).
      title: UrlTrackingWebhook
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessage:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: An array of destination objects for where messages are being sent. Each object in array can be one of available options. A valid destination is required.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestination'
        content:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundContent'
        options:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationMessageOptions'
        webhooks:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Webhooks'
      required:
      - content
      - destinations
      title: MmsUnificationMessage
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.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/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.SendingSpeedLimit'
      title: RequestSchedulingSettings
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.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: Id of your registered DTL content template that matches this message's text.
        principalEntityId:
          type: string
          description: Your assigned DTL principal entity id.
        telemarketerId:
          type: string
          description: Your assigned Telemarketer ID. (required for Aggregators)
      required:
      - principalEntityId
      title: IndiaDltOptions
    cc99cb7b0e48638be90df2dee94fb1aaadb95bcd09a6944a79bd00ca6a59df77.NotificationMessageReoptin:
      type: string
      description: Is Reoptin ENABLED or DISABLED.
      enum:
      - ENABLED
      - DISABLED
      - UNKNOWN
      example: ENABLED
      title: NotificationMessageReoptin
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Record:
      type: object
      description: Record action records a portion of the call. The recording starts at the moment where the Record action is added in the IVR.
      properties:
        record:
          type: integer
          format: int32
          description: The duration to record for in seconds; null for unlimited.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - record
      title: Record
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Name:
      type: object
      description: Contains information about the name and last of a contact.
      properties:
        firstName:
          type: string
          description: First name of a contact. Mandatory value.
          writeOnly: true
        lastName:
          type: string
          description: Last name of a contact.
          writeOnly: true
        middleName:
          type: string
          description: Middle name of a contact.
          writeOnly: true
        nameSuffix:
          type: string
          description: 'Name suffix of a contact. '
          writeOnly: true
        namePrefix:
          type: string
          description: Name prefix of a contact.
          writeOnly: true
        formattedName:
          type: string
          description: Full name as it normally appears. Mandatory value.
          writeOnly: true
      required:
      - firstName
      - formattedName
      title: Name
      writeOnly: true
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.LineMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.RequestSchedulingSettings'
      title: LineMessageRequestOptions
    6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordingMetadata:
      type: object
      description: Recording metadata
      properties:
        composedFiles:
          type: array
          description: Composed recording files.
          items:
            $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.RecordedFile'
        callRecordings:
          type: array
          description: Call recording data.
          items:
            $ref: '#/components/schemas/6ee61eb40f9e4619d309dfe8df9b479488b43bcde7df95f6a044b2e14abf591e.CallRecording'
      title: RecordingMetadata
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundContent:
      type: object
      description: Content of the failover message being sent.
      properties:
        title:
          type: string
          description: Message title.
          maxLength: 66
          minLength: 0
        messageSegments:
          type: array
          description: Content of the message being sent.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MmsOutboundSegment'
      required:
      - messageSegments
      title: MmsOutboundContent
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToManyOptions:
      type: object
      properties:
        parallel:
          type: boolean
          default: false
          description: Flag indicating that parallel (`true`), or sequential (`false`) Dial to Many will be executed.
        senderId:
          type: string
          description: Must be a valid [E.164](https://en.wikipedia.org/wiki/E.164) number; the parameter can be constructed using variables
        maxCallDuration:
          type: integer
          format: int32
          description: If set, call transfer will be limited by `maxCallDuration` seconds; must be a positive number, no upper bound.
          minimum: 1
      title: DialToManyOptions
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    be899aa87631e28acaf5aa6d4ae5df630595a5bf087810b506602819a5d8b742.PushOutboundContentType:
      type: string
      enum:
      - TEXT
      - IMAGE
      title: PushOutboundContentType
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.PublicStartTranscriptionRequest:
      type: object
      properties:
        transcription:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Transcription'
      title: PublicStartTranscriptionRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SmsMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.UrlOptions'
        includeSmsCountInResponse:
          type: boolean
          default: false
          description: Set to true to return `messageCount` in the response. The `messageCount` is the total count of SMS submitted in the request. SMS messages have a character limit and messages longer than the limit will be split into multiple SMS. Not compatible with `binary` message content type.
        conversionTracking:
          $ref: '#/components/schemas/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.Tracking'
      title: SmsMessageRequestOptions
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.PlayOptions:
      type: object
      properties:
        loopCount:
          type: integer
          format: int32
          description: Number of times the file will be played.
          maximum: 10
          minimum: 1
      title: PlayOptions
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SbcHosts:
      type: object
      description: Infobip SBC (Session Border Controller) hosts.
      properties:
        primary:
          type: array
          items:
            type: string
        backup:
          type: array
          items:
            type: string
        subnets:
          type: array
          items:
            type: string
      title: SbcHosts
    53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppressionRequest:
      type: object
      description: Suppressions request.
      properties:
        suppressions:
          type: array
          description: Email addresses to delete from the suppression list. Number of destinations cannot exceed 10,000.
          items:
            $ref: '#/components/schemas/53ea038e2044401649ce25e79296cd97fe7d6f7f97d15a035e41419183f810a1.DeleteSuppression'
          maxItems: 10
          minItems: 1
      required:
      - suppressions
      title: DeleteSuppressionRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToMany:
      type: object
      description: 'Dial to Many action performs a call redirection to multiple destinations, joining the user’s call only with the destination that answered the call first. After Dial to Many action the following actions are forbidden: Say, Collect, Dial, Dial to Many, Dial to Conversations, Play, Record and Play from Recording.'
      properties:
        dialToMany:
          type: array
          items:
            $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Numbers'
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.DialToManyOptions'
        actionId:
          type: integer
          format: int32
          description: User-defined ID of an action that can be used with go-to action.
      required:
      - dialToMany
      - options
      title: Dial To Many
    243664b2993460e9e9a3aa6c63ab422a58e22db15efe4cb007ed315aff543dd9.MmsReportRequest:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsReportSingle'
      title: MmsReportRequest
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkUpdateStatusRequest:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkStatus'
      required:
      - status
      title: BulkUpdateStatusRequest
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.IysRecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: IysRecipientType
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoMessageSegment:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoTextSegment'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoLinkSegment'
      description: All parts of the received message.
      title: MmsMoMessageSegment
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonHeaderContent:
      type: object
      description: Header of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonTextHeaderContent'
          VIDEO: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonVideoHeaderContent'
          IMAGE: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonImageHeaderContent'
          DOCUMENT: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonDocumentHeaderContent'
      properties:
        type:
          type: string
      required:
      - type
      title: InteractiveUrlButtonHeaderContent
    61f95109c33ad36c729390593c474a655f9ca0e00403d6dbc107cf0f6c5cf04b.Language:
      type: string
      enum:
      - af-ZA
      - sq-AL
      - am-ET
      - ar-KW
      - ar-AE
      - ar-BH
      - ar-DZ
      - ar-EG
      - ar-IL
      - ar-IQ
      - ar-JO
      - ar-LB
      - ar-LY
      - ar-MA
      - ar-OM
      - ar-PS
      - ar-QA
      - ar-SA
      - ar-SY
      - ar-TN
      - ar-YE
      - hy-AM
      - az-AZ
      - eu-ES
      - bn-IN
      - bn-BD
      - bs-BA
      - bg-BG
      - my-MM
      - ca-ES
      - zh-CN
      - zh-HK
      - zh-TW
      - hr-HR
      - cs-CZ
      - da-DK
      - nl-NL
      - nl-BE
      - en-AU
      - en-CA
      - en-GB
      - en-GH
      - en-HK
      - en-IE
      - en-IN
      - en-KE
      - en-NG
      - en-NZ
      - en-PH
      - en-PK
      - en-SG
      - en-TZ
      - en-US
      - en-ZA
      - et-EE
      - fil-PH
      - fi-FI
      - fr-BE
      - fr-CA
      - fr-CH
      - fr-FR
      - gl-ES
      - ka-GE
      - de-AT
      - de-CH
      - de-DE
      - el-GR
      - gu-IN
      - he-IL
      - hi-IN
      - hu-HU
      - is-IS
      - id-ID
      - ga-IE
      - it-CH
      - it-IT
      - ja-JP
      - jv-ID
      - kn-IN
      - kk-KZ
      - km-KH
      - ko-KR
      - lo-LA
      - lv-LV
      - lt-LT
      - mk-MK
      - ms-MY
      - ml-IN
      - mt-MT
      - mr-IN
      - mn-MN
      - ne-NP
      - no-NO
      - fa-IR
      - pl-PL
      - pt-PT
      - pt-BR
      - pa-Guru-IN
      - ro-RO
      - ru-RU
      - sr-RS
      - si-LK
      - sk-SK
      - sl-SI
      - es-BO
      - es-AR
      - es-CL
      - es-CO
      - es-CR
      - es-CU
      - es-DO
      - es-EC
      - es-ES
      - es-GQ
      - es-GT
      - es-HN
      - es-MX
      - es-NI
      - es-PA
      - es-PE
      - es-PR
      - es-PY
      - es-SV
      - es-US
      - es-UY
      - es-VE
      - su-ID
      - sw-TZ
      - sw-KE
      - sv-SE
      - ta-IN
      - ta-LK
      - ta-MY
      - ta-SG
      - te-IN
      - th-TH
      - tr-TR
      - uk-UA
      - ur-IN
      - ur-PK
      - uz-UZ
      - vi-VN
      - zu-ZA
      title: Language
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Label:
      type: string
      description: Indicates character of the content.
      enum:
      - PROMOTIONAL
      - TRANSACTIONAL
      title: Label
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookMessageRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.RequestSchedulingSettings'
      title: FacebookMessageRequestOptions
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.AddExistingCallRequest:
      type: object
      properties:
        connectOnEarlyMedia:
          type: boolean
          default: false
          description: Indicates whether to add an existing call on early media. Otherwise, the call will be added after being established. This field is applicable for `OUTBOUND` calls only. Cannot be `true` when `ringbackGeneration` is enabled.
        ringbackGeneration:
          $ref: '#/components/schemas/efc1265916a727aef4eb46ff2e01c3e0ad0c1ad70cf38d568ed99c04a9a73fa0.RingbackGeneration'
        role:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Role'
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
      title: AddExistingCallRequest
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.RecordingSortColumn:
      type: string
      enum:
      - DESTINATION_DATA
      - DESTINATION_TYPE
      - CALL_LINK_CONFIG_ID
      - CALL_LINK_ID
      - START_TIME_BEFORE
      - START_TIME_AFTER
      title: RecordingSortColumn
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusContent:
      type: object
      description: The content object to build a message that will be sent.
      properties:
        action:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveOrderStatusActionContent'
        body:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent'
        footer:
          $ref: '#/components/schemas/f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFooterContent'
      required:
      - action
      title: InteractiveOrderStatusContent
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.LogResponseMmsUnificationLogMmsOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationLogMmsOutboundContent'
        cursor:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.CursorPageInfo'
      title: LogResponseMmsUnificationLogMmsOutboundContent
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress:
      type: object
      description: List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.
      properties:
        url:
          type: string
          description: A publicly accessible URI associated with the sender. Must use the HTTP or HTTPS protocol. Maximum URL length is 2048 characters.
          maxLength: 2048
          minLength: 1
        label:
          type: string
          description: Label for the URI. Must be plain text (no URLs, HTML or markup).
          maxLength: 25
          minLength: 1
      required:
      - label
      - url
      title: WebsiteWebAddress
    08fdb52de63aac13de3ed81c2cf06532bc7e9a861dae97f83fafd7a6d53a779e.RecordingStartRequest:
      type: object
      properties:
        recording:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.RecordingRequest'
      title: RecordingStartRequest
    c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionRequest:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/c8cb45a488f0d2ea03cc082d0f61afb1c3b35cdd297a9f7abb6df8ac5619a483.ActionType'
        forwardUrl:
          type: string
          description: URL for HTTP forward action. Required when type is HTTP_FORWARD.
        callbackData:
          type: string
          description: Callback data that will be sent along with the message.
      required:
      - type
      title: ActionRequest
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveBodyContent:
      type: object
      description: Body of a message containing one or more [interactive elements](https://www.infobip.com/docs/whatsapp/message-types-and-templates/free-form-messages#available-interactive-formats).
      properties:
        text:
          type: string
          description: Content of the message body.
          maxLength: 1024
          minLength: 1
      required:
      - text
      title: InteractiveBodyContent
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AudioCodec:
      type: string
      description: Audio codec.
      enum:
      - PCMU
      - PCMA
      - G729
      title: AudioCodec
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContentType:
      type: string
      description: Message type, describing type of message which is going to be sent over RCS
      enum:
      - TEXT
      - FILE
      - CARD
      - CAROUSEL
      - TEXT
      - FILE
      - CARD
      - CAROUSEL
      title: FreeFormRcsApiMtContentType
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveFlowActionMode:
      type: string
      default: PUBLISHED
      description: Mode of the flow, can be either 'DRAFT' or 'PUBLISHED'. If mode is 'DRAFT' header, body, footer and callToActionButton data will be not shown for end user.
      enum:
      - DRAFT
      - PUBLISHED
      title: InteractiveFlowActionMode
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationSingle:
      type: object
      anyOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DestinationTo'
      title: Destination
    267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.Webhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/267b6ecf9b18ace076c5287f2f55ab493690ff43a19cc6531a331c0c908f8fd5.MessageDeliveryReporting'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
      title: Webhooks
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.InteractiveUrlButtonActionContent:
      type: object
      description: Allows you to specify the content of the button and its URL.
      properties:
        displayText:
          type: string
          description: Content of the button.
          maxLength: 20
          minLength: 1
        url:
          type: string
          description: URL to load in the device's default web browser when tapped by the WhatsApp user.
          maxLength: 2048
          minLength: 1
      required:
      - displayText
      - url
      title: InteractiveUrlButtonActionContent
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.CallingPermissionActionName:
      type: string
      description: Name of calling permission related action.<br>`START_CALL` - The action of establishing a new call with the end user.<br>`SEND_CALL_PERMISSION_REQUEST` - The action of sending new call permissions request messages to end user.
      enum:
      - START_CALL
      - SEND_CALL_PERMISSION_REQUEST
      example: SEND_CALL_PERMISSION_REQUEST
      title: CallingPermissionActionName
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.ActivityType:
      type: string
      description: Type of activity that occurred.
      enum:
      - CONNECTED
      - DISCONNECTED
      title: ActivityType
    43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransactionType:
      type: string
      description: Type of the transaction.
      enum:
      - UPI
      - BR
      - UNKNOWN
      example: UPI
      title: PaymentTransactionType
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.SipTrunkRegistrationStatus:
      type: string
      description: SIP trunk registration status.
      enum:
      - REGISTERED
      - UNREGISTERED
      title: SipTrunkRegistrationStatus
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButton:
      type: object
      description: Buttons to include in the message. Optional value. Max 5 buttons.
      discriminator:
        propertyName: type
        mapping:
          APP_LINK: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguAppLinkButton'
          URL: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguUrlButton'
          MESSAGE_DELIVERY: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguMessageDeliveryButton'
          BOT_KEYWORD: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguBotKeywordButton'
      properties:
        buttonText:
          type: string
          description: Text of the button. Max 28 characters.
          maxLength: 28
          minLength: 1
          writeOnly: true
        type:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoChinguButtonType'
      required:
      - buttonText
      title: KakaoChinguButton
      writeOnly: true
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateWebhookResponse:
      type: object
      description: Webhook response containing RCS test number update events
      properties:
        results:
          type: array
          description: Collection of RCS test number update events
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsTestNumberUpdateEvent'
      required:
      - results
      title: RcsTestNumberUpdateWebhookResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.BulkInfo:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies the message within the bulk.
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the email is to be sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
          example: '2021-01-02T01:00:00.123Z'
      required:
      - bulkId
      - sendAt
      title: BulkInfo
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTextContent'
          IMAGE: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundImageContent'
          LOCATION: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundLocationContent'
          VIDEO: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundVideoContent'
          AUDIO: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundAudioContent'
          DOCUMENT: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundDocumentContent'
          SENDER_ACTION: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundSenderActionContent'
          TEMPLATE: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundTemplateContent'
          COMMENT: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundCommentContent'
          POST: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundPostContent'
          OPT_IN_FOLLOWUP: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundOptInFollowupContent'
          MARKETING_MESSAGE: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundMarketingMessageContent'
      properties:
        type:
          $ref: '#/components/schemas/747c7e4c0b03b254cdcbef02225bbd858a3bba6d956caa5ac2689fea92b213b0.FacebookOutboundContentType'
      required:
      - type
      title: FacebookOutboundContent
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    62b589527d7474f21f086ddb07e8698e9fcfbbe16400c91718f1ab58d998c3f1.MMSMoWebhookRequest:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMoWebhookResult'
        messageCount:
          type: integer
          format: int32
          description: Number of returned messages in this request.
        pendingMessageCount:
          type: integer
          format: int32
          description: Number of remaining new messages on Infobip servers ready to be returned in the next request.
      title: MMSMoWebhookRequest
    3c57fc8acf96933d1896c672a41450fccb946974464fd5e3ce94ed2b207c06af.Payment:
      type: object
      properties:
        referenceId:
          type: string
          description: Unique identifier generated by the payment service provider.
          example: '72123248136'
        paymentId:
          type: string
          description: Unique identifier of the payment.
          example: '16085194825'
        paymentStatus:
          $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentStatus'
        currency:
          $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentCurrency'
        totalAmountValue:
          type: integer
          format: int32
          description: Value of the payment amount.
          example: 21000
        totalAmountOffset:
          type: integer
          format: int32
          description: Offset of the payment amount.
          example: 100
        transactions:
          type: array
          description: Transactions of the payment.
          items:
            $ref: '#/components/schemas/43838506232bad6c43fa70e5764e200c02c98fad735eeaad33d3b47abc8da5d2.PaymentTransaction'
        callbackData:
          type: object
          description: Custom parameters corresponding to the transaction. Available only for PayU UPI Payments and Razorpay.
      required:
      - currency
      - paymentStatus
      - referenceId
      - totalAmountOffset
      - totalAmountValue
      - transactions
      title: Payment
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogResponseLogKakaoChinguOutboundContent:
      type: object
      properties:
        results:
          type: array
          description: An array of message log results, one object per each message log entry.
          items:
            $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.LogKakaoChinguOutboundContent'
        cursor:
          $ref: '#/components/schemas/3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.CursorPageInfo'
      title: LogResponseLogKakaoChinguOutboundContent
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.ClickToCallApiMessage:
      type: object
      description: Array of click to call messages to be sent.
      properties:
        from:
          type: string
          description: Numeric sender ID. Will be shown to _destinationA_.
        fromB:
          type: string
          description: Numeric sender ID in E.164 format. If set, it will be shown to _destinationB_. If not set, _from_ or _destinationA_ will be shown to _destinationB_, depending on the value of _anonymization_.
        destinationA:
          type: string
          description: 'Original destination address. Address must be in the international format (Example: `41793026727`).'
        destinationB:
          type: string
          description: 'Destination address to which the call will be transferred after successful answering. Address must be in the international format (Example: `41793026727`).'
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. It can be defined by you or Infobip will generate unique message ID for this specific call. The field is not mandatory.
        audioFileUrl:
          type: string
          description: An audio file can be delivered as a voice message to the recipients. An audio file must be uploaded online, so that the existing URL can be available for file download. Size of the audio file must be below 4 MB. Supported formats of the provided file are aac, aiff, m4a, mp2, mp3, mp4 (audio only), ogg, wav and wma. Our platform needs to have permission to make GET and HEAD HTTP requests on the provided URL. Standard http ports (like 80, 8080, etc.) are advised.
        text:
          type: string
          description: Text of the message that will be played before call transfer. SSML (Speech Synthesis Markup Language) is supported and can be used to fully customize pronunciation of the provided text.
        language:
          type: string
          description: If the message is in text format, language in which the message is written must be defined for correct pronunciation. In the Languages section, you can find the list of languages that we support. If not set, default language is `English [en].`
          externalDocs:
            description: Voice Text-To-Speech Languages
            url: https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages
        voice:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Voice'
        anonymization:
          type: boolean
          description: 'If set, same numeric sender (defined in _from_) is used for both calls (towards _destinationA_ and _destinationB_). If not set, _destinationA_ will be shown to _destinationB_. If _fromB_ is set up, _anonymization_ will not be applied; _from_ will be shown to _destinationA_ and _fromB_ will be shown to _destinationB_. Default value is `false`. '
        notifyUrl:
          type: string
          description: The URL on your callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        notifyContentVersion:
          type: integer
          format: int32
          description: Specifies the version of the report model to be sent. Can be `1` ([deprecated version 1](#programmable-communications/voice/receive-voice-delivery-reports-deprecated)) or `2` ([current version 2](#programmable-communications/voice/receive-voice-delivery-reports)). The default is version 2.
        maxDuration:
          type: integer
          format: int32
          description: Maximum duration of transferred call in seconds. If set, when _maxDuration_ is reached call will be terminated.
        warningTime:
          type: integer
          format: int32
          description: Time before the end of the transferred call, in seconds, when warning beep sound will be played. For example, if _maxDuration_ is set to `60` and warningTime is set to `5`, this means that warning beep will be played on `55.` second of the transferred call, or `5` seconds before it's end.
        retry:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.Retry'
        machineDetection:
          type: string
          description: Used for enabling detection of answering machine after the call has been answered on `destinationA`. It can be set to `hangup` which means if a machine is detected, the call is hung up. If `machineDetection` is used, there is a minimum of 4 seconds detection time, which can result in delay of playing the message. Answering machine detection is additionally charged. For more information please contact your account manager.
          externalDocs:
            description: Answering Machine Detection
            url: https://www.infobip.com/docs/voice-and-video/getting-started#answering-machine-detection-add-ons-and-options
        deliveryTimeWindow:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryTimeWindow'
      required:
      - destinationA
      - destinationB
      - from
      title: ClickToCallApiMessage
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessage'
        options:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ViberBotMessageRequestOptions'
      required:
      - messages
      title: ViberBotRequest
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonResponse:
      type: object
      properties:
        validationErrors:
          type: array
          description: Errors found during validation of the uploaded file.
          items:
            $ref: '#/components/schemas/0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.AddFlowJsonValidationError'
      required:
      - validationErrors
      title: AddFlowJsonResponse
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.WhatsAppOutboundEventContentType:
      type: string
      enum:
      - TYPING_INDICATOR
      title: WhatsAppOutboundEventContentType
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.OmniResponseDetails:
      type: object
      description: Array of sent message objects, one object per every message.
      properties:
        to:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.To'
        status:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Status'
        messageId:
          type: string
          description: The ID that uniquely identifies the sent message.
      readOnly: true
      title: OmniResponseDetails
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageErrorGroup:
      type: string
      description: Error group name that describes which category the error code belongs to.
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: MessageErrorGroup
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendResponse:
      type: object
      properties:
        bulkId:
          type: string
          description: The ID that uniquely identifies a list of message responses.
        messages:
          type: array
          description: List of message response details.
          items:
            $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.ResponseDetails'
      required:
      - messages
      title: SendResponse
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoMessagePrice:
      type: object
      description: Price object with traffic type information.
      properties:
        trafficType:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsMoTrafficType'
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: RcsMoMessagePrice
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.TemplateParamType:
      type: string
      description: Type of template parameter.
      enum:
      - TEXT
      example: TEXT
      title: TemplateParamType
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Organization:
      type: object
      description: Company information.
      properties:
        company:
          type: string
          description: Company name.
          writeOnly: true
        department:
          type: string
          description: Department name.
          writeOnly: true
        title:
          type: string
          description: Title value
          writeOnly: true
      title: Organization
      writeOnly: true
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryTime:
      type: object
      description: Exact time of day in which the sending ends. Time is expressed in the UTC time zone. If set, use it together with the `from` property with minimum 1 hour difference.
      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
          writeOnly: true
        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
          writeOnly: true
      title: DeliveryTime
      writeOnly: true
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Error:
      type: object
      description: Indicates whether the error occurred during the query execution.
      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.
      title: Error
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationReason:
      type: string
      description: 'Reason is provided when validMailbox status is unknown.

        1. INBOX_FULL - The user quota exceeded / The user inbox is full / The user doesn''t accept any more requests.

        2. UNEXPECTED_FAILURE - The mail Server returned a temporary error.

        3. THROTTLED - The mail server is not allowing us momentarily because of too many requests.

        4. TIMED_OUT - The mail Server took a longer time to respond / there was a delay in the network.

        5. TEMP_REJECTION - Mail server temporarily rejected.

        6. UNABLE_TO_CONNECT - Unable to connect to the Mail Server.

        '
      enum:
      - TIMED_OUT
      - TEMP_REJECTION
      - THROTTLED
      - INBOX_FULL
      - UNABLE_TO_CONNECT
      - UNEXPECTED_FAILURE
      title: ValidationReason
    9389c24e0e9ed01ee6b8f8356a2a69457800d0649274de6f0e7a1954857d6488.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    7916e19109f991cfe966f390ef0d36117967291fa90eff57d8c8cb768f38352e.RecordingSortColumn:
      type: string
      enum:
      - CALL_TYPE
      - ROOM_NAME
      - ROOM_ID
      - START_TIME
      - END_TIME
      title: RecordingSortColumn
    3995f10686be3e5fc42bb37b4419fd7fe2425eaa12f76cbe136803640cfabe2c.ToDestination:
      type: object
      description: An array of destination objects for where messages are being sent. A valid destination is required.
      properties:
        to:
          type: string
          description: The destination address of the message.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: Destination
    1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/1907be504c1be9d07aa876a6a409d4bd97224dac497dfecd7d8092e77aac7215.DeliveryReport'
      title: DeliveryReports
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.RecordedIvrFile:
      type: object
      description: Array of recorded files metadata, one for each recorded file.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the sent message.
        from:
          type: string
          description: Numeric sender ID.
        to:
          type: string
          description: Destination address.
        scenarioId:
          type: string
          description: Scenario key.
        groupId:
          type: string
          description: Differentiates recordings made by separate Record actions.
        url:
          type: string
          description: Relative URL path to the recorded file. To download the audio, just perform a GET request using the relative URL of a specific file. The returned audio data is encoded as PCM 16bit 8kHz WAVE audio. The files are available on Infobip servers for 2 months.
        recordedAt:
          type: string
          format: date-time
          description: The time the recording took place.
      title: RecordedIvrFile
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimData:
      type: object
      description: Kakao AlimTalk-specific data used if the message is sent through a Kakao AlimTalk channel.
      properties:
        text:
          type: string
          description: Text of the message.
          maxLength: 1000
          minLength: 1
          writeOnly: true
        validityPeriod:
          type: integer
          format: int32
          description: The message validity period. Unless specified differently in validityPeriodTimeUnit, it is expressed in minutes. When the period expires, the message will be automatically sent using the next OMNI step. Validity period longer than 48h is not supported (in this case, it will be automatically set to 48h). Additionally, period should be longer than 30 seconds.
          writeOnly: true
        validityPeriodTimeUnit:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.TimeUnit'
        templateCode:
          type: string
          description: Code of the template. Max 30 characters.
          maxLength: 30
          minLength: 1
          writeOnly: true
        buttons:
          type: array
          description: Buttons to include in the message. Optional value. Max 5 buttons.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.KakaoAlimButton'
          maxItems: 5
          minItems: 1
          writeOnly: true
        title:
          type: string
          description: Title of the message.
          maxLength: 50
          minLength: 0
          writeOnly: true
        groupKey:
          type: string
          description: Group key of the profile. Required if the template was created using it.
          writeOnly: true
      title: KakaoAlimData
      writeOnly: true
    8a2ea8872469b182f7474a94d4bf931da42a6e2a1d1ba07898b1bc7dcdc85cd2.Contact:
      type: object
      description: Contact information. Exists in case of WhatsApp Message.
      properties:
        name:
          type: string
          description: Contact name.
        phoneNumber:
          type: string
          description: Sender's phone number.
        userId:
          type: string
          description: User ID.
        parentUserId:
          type: string
          description: Parent user ID.
        username:
          type: string
          description: Username.
      title: Contact
    ff7f7515e81995b140ab1c879b88d9d297a14922c035a187e237cd81e7c216a0.WebhookNotificationType:
      type: string
      description: Type of the email platform event.
      enum:
      - HIGH_BOUNCE_RATE_WARNING
      - HIGH_BOUNCE_RATE_BLOCKED
      title: WebhookNotificationType
    e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Contact:
      type: object
      properties:
        addresses:
          type: array
          description: Address information.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Address'
          writeOnly: true
        birthday:
          type: string
          description: Birthday information, YYYY-MM-DD formatted string.
          writeOnly: true
        emails:
          type: array
          description: Email information.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Email'
          writeOnly: true
        name:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Name'
        org:
          $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Organization'
        phones:
          type: array
          description: Phone information.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Phone'
          writeOnly: true
        urls:
          type: array
          description: Url information.
          items:
            $ref: '#/components/schemas/e204fb2d0d1568cbfe90b245006e95aab18e580484154f085b8348d2e991bc11.Url'
          writeOnly: true
      required:
      - name
      title: Contact
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.AnswerRequest:
      type: object
      properties:
        customData:
          type: object
          additionalProperties:
            type: string
          description: Optional parameter to update a call's custom data.
        recording:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CallRecordingRequest'
      title: AnswerRequest
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetection:
      type: object
      description: This action detects answering machines at the beginning of a call. It allows for detailed configuration of actions to be executed at various stages of the detection process.
      properties:
        answeringMachineDetection:
          type: boolean
          description: Indicates whether machine detection should be performed.
        options:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.AnsweringMachineDetectionOptions'
        onDetecting:
          type: array
          description: Array of actions to execute while detection is in progress. A maximum of two actions of specific types (`Play`, `Say`, `Collect`) can be defined.
          items:
            type: object
            description: Array of actions to execute while detection is in progress. A maximum of two actions of specific types (`Play`, `Say`, `Collect`) can be defined.
        onMachineDetected:
          type: array
          description: Array of actions to execute when a machine is detected, or when the end of the message is reached if `endOfMessageDetectionTimeout` is set. Actions defined in `onDetecting` are interrupted before these actions begin. If you do not intend to continue the scenario after `onMachineDetected`, include a `Hangup` action at the end of this section to terminate the call.
          items:
            type: object
            description: Array of actions to execute when a machine is detected, or when the end of the message is reached if `endOfMessageDetectionTimeout` is set. Actions defined in `onDetecting` are interrupted before these actions begin. If you do not intend to continue the scenario after `onMachineDetected`, include a `Hangup` action at the end of this section to terminate the call.
        onTimeout:
          type: array
          description: Array of actions to execute when a machine is detected and the `endOfMessageDetectionTimeout` is reached. If you do not intend to continue the scenario after `onTimeout`, include a `Hangup` action at the end of this section to terminate the call.
          items:
            type: object
            description: Array of actions to execute when a machine is detected and the `endOfMessageDetectionTimeout` is reached. If you do not intend to continue the scenario after `onTimeout`, include a `Hangup` action at the end of this section to terminate the call.
        onHumanDetected:
          type: array
          description: Array of actions to execute when a human is detected. Actions defined in `onDetecting` are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after `onHumanDetected`, include a `Hangup` action at the end of this section to terminate the call.
          items:
            type: object
            description: Array of actions to execute when a human is detected. Actions defined in `onDetecting` are interrupted before these actions begin. To avoid this interruption, omit this section and define the remaining scenario after this action. If you do not intend to continue the scenario after `onHumanDetected`, include a `Hangup` action at the end of this section to terminate the call.
      required:
      - answeringMachineDetection
      - onMachineDetected
      title: Machine Detection (Advanced)
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestination:
      type: object
      description: '---'
      oneOf:
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationSingle'
      - $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationDestinationGroup'
      title: MmsUnificationDestination
    0089ea7cf06f0b77e4c88a7276c6f25dd5c0c5bbab819756fc42c548980cae19.GetFlowJsonResponse:
      type: object
      properties:
        externalDownloadUrl:
          type: string
          description: External link to download the Flow JSON file.
          example: https://example.com
      required:
      - externalDownloadUrl
      title: GetFlowJsonResponse
    6a832d7980b0224fa17e623a753d9dcd3d97aedf6ae653c996ab303ad0c7f980.BusinessVertical:
      type: string
      description: Business vertical.
      enum:
      - AUTOMOTIVE
      - BEAUTY_AND_SPA_AND_SALON
      - CLOTHING_AND_APPAREL
      - EDUCATION
      - ENTERTAINMENT
      - EVENT_PLANNING_AND_SERVICE
      - FINANCE_AND_BANKING
      - FOOD_AND_GROCERY
      - PUBLIC_SERVICE
      - HOTEL_AND_LODGING
      - MEDICAL_AND_HEALTH
      - NON_PROFIT
      - PROFESSIONAL_SERVICES
      - SHOPPING_AND_RETAIL
      - TRAVEL_AND_TRANSPORTATION
      - RESTAURANT
      - OTHER
      - UNKNOWN
      example: PROFESSIONAL_SERVICES
      title: BusinessVertical
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.PriceInfo:
      type: object
      description: Sent email price.
      properties:
        pricePerMessage:
          type: number
          format: double
          description: Price per message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: PriceInfo
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.CursorPageInfo:
      type: object
      description: Cursor information.
      properties:
        limit:
          type: integer
          format: int32
          description: Requested limit.
        nextCursor:
          type: string
          description: The `cursor` value you will use in your next request to fetch the subsequent set of results.
      readOnly: true
      title: CursorPageInfo
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.NumberPresentationFormat:
      type: string
      description: Format in which numbers are sent to a SIP trunk.
      enum:
      - E164
      - INTERNATIONAL
      - US_NATIONAL
      title: NumberPresentationFormat
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionMode:
      type: object
      description: Machine detection mode configuration
      discriminator:
        propertyName: type
        mapping:
          SYNC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.SyncMachineDetectionMode'
          ASYNC: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.AsyncMachineDetectionMode'
      properties:
        type:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.MachineDetectionModeType'
      title: MachineDetectionMode
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RecordingSortColumn:
      type: string
      enum:
      - ENDPOINT_TYPE
      - ROUTE_ID
      - CORRELATION_ID
      - START_TIME
      - END_TIME
      title: RecordingSortColumn
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageError:
      type: object
      description: Indicates whether an [error](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes) occurred during the query execution.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.MessageErrorGroup'
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: '[Error name](https://www.infobip.com/docs/essentials/response-status-and-error-codes#error-codes).'
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Indicates whether the error is recoverable or not.
      title: MessageError
    ApiRequestError:
      type: object
      properties:
        serviceException:
          $ref: '#/components/schemas/ApiRequestErrorDetails'
      title: ApiRequestError
    91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbRequest:
      type: object
      properties:
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.AppleMfbMessage'
        options:
          $ref: '#/components/schemas/91c858d6e55640d2b6750e23f7ec3df534ca8bee928e5f9b25341eaf73842f14.DefaultMessageRequestOptions'
      required:
      - messages
      title: AppleMfbRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo:
      type: object
      description: Reason why the call has finished.
      properties:
        id:
          type: integer
          format: int32
          description: Unique ErrorCode ID.
          example: 10000
        name:
          type: string
          description: Unique ErrorCode name in machine-readable format.
          example: NORMAL_HANGUP
        description:
          type: string
          description: ErrorCode description in human-readable format.
          example: The call has ended with hangup initiated by caller, callee or API
      title: ErrorCodeInfo
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ActionStatus:
      type: string
      description: Action status.
      enum:
      - PENDING
      - IN_PROGRESS
      - COMPLETED
      - FAILED
      title: ActionStatus
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          SUGGESTION: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundSuggestionContent'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.RcsInboundEventContentType'
      required:
      - type
      title: RcsInboundEventContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryDay'
        from:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime'
        to:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    f9ccb6cb799d6a02d85ff0940902b67433383f1a3c972733a815fa9a18d16bea.editStructure:
      type: object
      description: Template structure. Format depends on the template category.
      title: editStructure
    707907921d4508c2925eddc2449f10db322ecc083be424f87c50fe97ccd8be40.ConferenceLogResponse:
      type: object
      properties:
        conferenceId:
          type: string
          description: Unique conference ID.
          example: e8a7c0f5-0f0b-4ccf-84a4-1b7e5f699001
          maxLength: 128
        name:
          type: string
          description: Conference name, requested or autogenerated on creation.
          example: Example conference
        platform:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Platform'
        startTime:
          type: string
          format: date-time
          description: Date and time for when the conference has been created.
        endTime:
          type: string
          format: date-time
          description: Date and time for when the conference ended.
        duration:
          type: integer
          format: int64
          description: Conference duration in seconds.
          example: 55
        sessions:
          type: array
          description: List of participant sessions.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ParticipantSession'
        recording:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ConferenceRecordingLog'
        errorCode:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.ErrorCodeInfo'
      title: ConferenceLogResponse
    14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/14dcd0f25fe0ff2584924b9f91668496573ab31a7e8cac75f9f81e79874514cb.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    1e938b22275568ebc747d21724b50c9be18ff5770eb33c37b76fda4633c14bde.RouteStatusRequest:
      type: object
      description: Route status request object.
      properties:
        routeStatus:
          $ref: '#/components/schemas/287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.RouteStatus'
      required:
      - routeStatus
      title: RouteStatusRequest
    97cb4ba23432eb0e600ef0617ae1982d499839ef41226973c71dfb335b3071b8.Destination:
      type: object
      description: Array of message destination addresses. Maximum number of destination addresses is 20k.
      properties:
        to:
          type: string
          description: 'Message destination addresses. Destination address must be in the E.164 standard format (Example: `41793026727`).'
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
      required:
      - to
      title: Destination
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLogsResponse:
      type: object
      properties:
        results:
          type: array
          description: Results.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MMSMtLog'
      title: MMSMtLogsResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReports:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.DeliveryReport'
      title: DeliveryReports
    2188fec7c48e989bb7053521bdef9d76d71def96483c5304f01cd7e0878f8f14.Messages:
      type: object
      description: Call link messaging settings.
      properties:
        welcomeText:
          type: string
          default: Welcome to Call Link.
          description: Message shown when a call link is opened.
        inactiveText:
          type: string
          default: This link is not active.
          description: Message shown when a call link is not active.
        expirationText:
          type: string
          default: Link is expired.
          description: Message shown when a call link is expired.
      title: Messages
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.LogStatus:
      type: object
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
          readOnly: true
        groupName:
          type: string
          description: Status group name that describes which category the status code belongs to, e.g. PENDING, UNDELIVERABLE, DELIVERED, EXPIRED, REJECTED.
          readOnly: true
        id:
          type: integer
          format: int32
          description: Status ID.
          readOnly: true
        name:
          type: string
          description: '[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes).'
          readOnly: true
        description:
          type: string
          description: Human-readable description of the status.
          readOnly: true
        action:
          type: string
          description: Action that should be taken to recover from the error.
          readOnly: true
      title: LogStatus
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    a15a35d4e9d79ecb7047887a88973e9a539c66701b3c993c3c3be69782dd8aba.BulkResponse:
      type: object
      description: Bulk response object.
      properties:
        bulkId:
          type: string
          description: Unique ID of the bulk.
        sendAt:
          type: string
          format: date-time
          description: Timestamp when bulk is scheduled.
      title: BulkResponse
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsMoLinkSegment:
      type: object
      properties:
        contentType:
          type: string
          description: Content type of the message segment `image/jpeg`.
        url:
          type: string
          description: URL from which content can be downloaded.
      title: Link segment
    287f18f04e9f129a7bc94ed3ae48e2480e2673b8fdf041ab5125fde9674634b8.DeliveryDay:
      type: string
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.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
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsUnificationLogMmsOutboundContent:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        title:
          type: string
          description: Message title.
        mccMnc:
          type: string
          description: Mobile country and network codes.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessagePrice'
        status:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageStatus'
        error:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MessageError'
        platform:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.Platform'
        content:
          $ref: '#/components/schemas/faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.MmsOutboundContent'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: MmsUnificationLogMmsOutboundContent
    f30d78c250ad1209aef755ddde02bb131e1749b705985f0e9f1b007c900b98e2.NameContent:
      type: object
      description: Contains information about contact's name.
      properties:
        firstName:
          type: string
          description: Contact's first name.
        lastName:
          type: string
          description: Contact's last name.
        middleName:
          type: string
          description: Contact's middle name.
        nameSuffix:
          type: string
          description: Contact's name suffix.
        namePrefix:
          type: string
          description: Contact's name prefix.
        formattedName:
          type: string
          description: Contact's full name as it normally appears.
      required:
      - firstName
      - formattedName
      title: NameContent
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.EmailUnificationLog:
      type: object
      description: An array of message log results, one object per each message log entry.
      properties:
        text:
          type: string
          description: Message text.
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric.
        destination:
          type: string
          description: Message destination address.
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request.
          example: BULK-ID-123-xyz
        messageId:
          type: string
          description: Unique message ID for which a log is requested.
        sentAt:
          type: string
          format: date-time
          description: 'Date and time when the message was sent. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        doneAt:
          type: string
          format: date-time
          description: 'Date and time when the Infobip services finished processing the message (i.e., delivered to the destination, network, etc.). Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
        messageCount:
          type: integer
          format: int32
          description: The number of messages content was split to.
        price:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessagePrice'
        status:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageStatus'
        error:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.MessageError'
        platform:
          $ref: '#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      title: EmailUnificationLog
    20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.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/20085a4036d67f66ebf204560d55d58a7c131c15d42c8ed9442747c488e08630.SendingSpeedLimit'
      title: RequestSchedulingSettings
    c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSender:
      type: object
      properties:
        senderName:
          type: string
          description: Unique identifier of Sender entity for RCS channel within Infobip platform.
        senderStatus:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderStatus'
        billingCategory:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsSenderBillingCategory'
        useCase:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsUseCase'
        hostingRegion:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.HostingRegion'
        brand:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.RcsBrand'
        googleAgentId:
          type: string
          description: Google Agent ID associated with this sender.
        displayName:
          type: string
          description: The name of the sender displayed to the user on mobile device.
        description:
          type: string
          description: The description of the sender displayed to the user on mobile device.
        color:
          type: string
          description: Theme color of the sender that is visible to the user on mobile device. Must be in hex format and contrast ratio must be at least 4.5:1 for white.
        phones:
          type: array
          description: List of phone contacts associated with the sender and displayed to the user on mobile device. Required if email and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Phone'
        emails:
          type: array
          description: List of email contacts associated with the sender and displayed to the user on mobile device. Required if phone and website are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.Email'
        websites:
          type: array
          description: List of websites associated with the sender and displayed to the user on mobile device. Required if phone and email are not provided. Currently, only one entry is supported.
          items:
            $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.WebsiteWebAddress'
        bannerUrl:
          type: string
          description: URL of the banner image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 1440 x 448 resolution (width x height). Maximum 204,800 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
        logoUrl:
          type: string
          description: URL of the logo image associated with the sender and displayed to the user on mobile device. It must be in JPG / JPEG or PNG format and it must be in 224 x 224 resolution (width x height). Maximum 51,200 bytes. Maximum URL length is 2048 characters.
          maxLength: 2048
        privacy:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PrivacyWebAddress'
        termsOfService:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.TermsWebAddress'
        platform:
          $ref: '#/components/schemas/c4d4776b979fea48176211c392051aca0dae21d75b7a9ca349c8f2eb95a84913.PlatformParameters'
        updatedAt:
          type: string
          format: date-time
          description: Timestamp when sender has been updated last time.
      required:
      - bannerUrl
      - billingCategory
      - brand
      - color
      - description
      - displayName
      - hostingRegion
      - logoUrl
      - privacy
      - senderName
      - senderStatus
      - termsOfService
      - updatedAt
      - useCase
      title: RcsSender
    8bb20f43a591755a249613f66cc72e7e0fcc9b313d81a59f9ca0e0ff261ac181.MessagePrice:
      type: object
      description: Sent message price.
      properties:
        pricePerMessage:
          type: number
          description: Price per one message.
        currency:
          type: string
          description: The currency in which the price is expressed.
      title: MessagePrice
    b5f674fb4d8d190ed269baf3b9aaf29827a4d03ec2de31bb6b608809be9a182b.IvrData:
      type: object
      properties:
        scenarioId:
          type: string
          description: The ID that uniquely identifies the IVR scenario.
          readOnly: false
          writeOnly: false
        scenarioName:
          type: string
          description: Name of IVR scenario.
          readOnly: false
          writeOnly: false
        collectedDtmfs:
          type: string
          description: JSON object showing the result of every CollectAction in IVR scenario in the form of key/value pairs, where the key is CollectAction variable and pair is collected DTMF.
          readOnly: false
          writeOnly: false
        collectedMappedDtmfs:
          type: string
          description: JSON object showing the result of every CollectAction in IVR scenario with the mapped, meaningful, values you defined in CollectAction `mappedValues` option.
          readOnly: false
          writeOnly: false
        spokenInput:
          type: string
          description: JSON object showing the result of every CaptureSpeech action with full text spoken by the user.
          readOnly: false
          writeOnly: false
        matchedSpokenInput:
          type: string
          description: JSON object showing the result of every CaptureSpeech action with only the key phrases that matched user spoken input.
          readOnly: false
          writeOnly: false
      title: IvrData
    45c843446703ba5f4438a6f721c629420452796de20bd3dd9adfccde3ed2ffff.ValidationRequest:
      type: object
      description: Validation request
      properties:
        to:
          type: string
          description: The email address to be validated.
      required:
      - to
      title: ValidationRequest
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.SendingSpeedLimit'
      title: RequestSchedulingSettings
    382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContent:
      type: object
      description: Message content.
      discriminator:
        propertyName: type
        mapping:
          TEMPLATE: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundTemplateContent'
      properties:
        type:
          $ref: '#/components/schemas/382231ebb2fc250c93965563ed41f4ba8228460e52f6052a582e69b931876454.KakaoAlimOutboundContentType'
      title: KakaoAlimOutboundContent
    b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContent:
      type: object
      description: Rcs message contents.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.TextRcsApiMtContent'
          FILE: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FileRcsApiMtContent'
          CARD: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CardRcsApiMtContent'
          CAROUSEL: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.CarouselRcsApiMtContent'
      properties:
        type:
          $ref: '#/components/schemas/b839d8c276f6f1ef62ce2dce758ba402953b31f455d6d08549a7147d79f50d62.FreeFormRcsApiMtContentType'
      title: FreeFormRcsApiMtContent
    6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.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/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryDay'
        from:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryTime'
        to:
          $ref: '#/components/schemas/6a8bbdacebad88e7e0de8bdfd30e29e04d114b9f00175a0482b9e26b742d85d5.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    faad2f34157fead7bc36bdf18ea6d8be6674c0ceb93de05135894a2bf0f2aa1b.ErrorMmsReport:
      type: object
      description: Indicates whether the error occurred during the query execution.
      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: Indicator of whether the error is permanent.
      title: ErrorMmsReport
    13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.UpdateScenarioResponse:
      type: object
      properties:
        createTime:
          type: string
          format: date-time
          description: Creation timestamp.
        description:
          type: string
          description: Scenario description.
        id:
          type: string
          description: Scenario key. It is used for launching IVR scenario.
        name:
          type: string
          description: Scenario name.
        notifyUrl:
          type: string
          description: The URL on the client's callback server on which the Delivery report will be sent.
        notifyContentType:
          type: string
          description: Preferred Delivery report content type. Can be `application/json` or `application/xml`.
        record:
          type: boolean
          description: Indicates if all calls using the scenario should be recorded.
        script:
          $ref: '#/components/schemas/13d6cf838c63455fe28fcf6ab1b4447c03d816f87ce89525d3cd759ca08a7b1a.Script'
        updateTime:
          type: string
          format: date-time
          description: Update timestamp.
        lastUsageDate:
          type: string
          format: date
          description: Last usage date. `null` for scenarios that are used last time before `2024-01-01`.
      title: UpdateScenarioResponse
    34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.TrackingResponse:
      type: object
      description: Tracking details of the domain.
      properties:
        clicks:
          type: boolean
          description: Indicates whether tracking of clicks is enabled.
        opens:
          type: boolean
          description: Indicates whether tracking of opens is enabled.
        unsubscribe:
          type: boolean
          description: Indicates whether tracking of unsubscribes is enabled.
      title: TrackingResponse
  responses:
    ApiError400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E400
            description: Request cannot be processed.
            action: Check the syntax, violations and adjust the request.
            violations: []
            resources: []
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E400</errorCode>\n  <description>Request cannot be processed.</description>\n  <action>Check the syntax, violations and adjust the request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
    ApiError404:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E404
            description: Not found - request URL doesn't exist on the API server or resource is not found.
            action: Check the resources and adjust your request.
            violations: []
            resources: []
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E404</errorCode>\n  <description>Not found - request URL doesn't exist on the API server or resource is not found.</description>\n  <action>Check the resources and adjust your request.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
    ApiException429:
      description: Too Many Requests
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: TOO_MANY_REQUESTS
                text: Too many requests
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>TOO_MANY_REQUESTS</messageId>\n      <text>Too many requests</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException404:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: NOT_FOUND
                text: Not found
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>NOT_FOUND</messageId>\n      <text>Not found</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: BAD_REQUEST
                text: Bad request
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>BAD_REQUEST</messageId>\n      <text>Bad request</text>\n    </serviceException>\n  </requestError>\n</ApiException>\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: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E403</errorCode>\n  <description>Insufficient permissions to access the requested resource.</description>\n  <action>Repeat the request with new or different credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Scopes</name>\n      <url>https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes</url>\n    </resource>\n  </resources>\n</ApiError>\n"
    ApiException401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: UNAUTHORIZED
                text: Unauthorized
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>UNAUTHORIZED</messageId>\n      <text>Unauthorized</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiException500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: GENERAL_ERROR
                text: Something went wrong. Please contact support.
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>GENERAL_ERROR</messageId>\n      <text>Something went wrong. Please contact support.</text>\n    </serviceException>\n  </requestError>\n</ApiException>\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: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E429</errorCode>\n  <description>Too many requests sent.</description>\n  <action>Check request rate limit specified in the API endpoint documentation resource.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>Throttling handling errors</name>\n      <url>https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors</url>\n    </resource>\n  </resources>\n</ApiError>\n"
    ApiException403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiException'
          example:
            requestError:
              serviceException:
                messageId: FORBIDDEN
                text: Forbidden
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiException'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n  <requestError>\n    <serviceException>\n      <messageId>FORBIDDEN</messageId>\n      <text>Forbidden</text>\n    </serviceException>\n  </requestError>\n</ApiException>\n"
    ApiError401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
          example:
            errorCode: E401
            description: The request lacks valid authentication credentials for the requested resource.
            action: Check the resources and adjust authentication credentials.
            violations: []
            resources:
            - name: API Authentication
              url: https://www.infobip.com/docs/essentials/api-authentication
        application/xml:
          schema:
            $ref: '#/components/schemas/ApiError'
          example: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E401</errorCode>\n  <description>The request lacks valid authentication credentials for the requested resource.</description>\n  <action>Check the resources and adjust authentication credentials.</action>\n  <violations/>\n  <resources>\n    <resource>\n      <name>API Authentication</name>\n      <url>https://www.infobip.com/docs/essentials/api-authentication</url>\n    </resource>\n  </resources>\n</ApiError>\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: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiError>\n  <errorCode>E500</errorCode>\n  <description>Something went wrong.</description>\n  <action>Contact the support.</action>\n  <violations/>\n  <resources/>\n</ApiError>\n"
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      description: 'This is the most secure authorization type and the one with the most flexibility.


        API 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

        be 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.

        Finally, the loss of an API key is easily manageable.


        You can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically

        with [dedicated API](#platform-&-connectivity/settings).


        API key Authorization header example:


        ```shell

        Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9

        ```

        '
      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

        with the Basic type.


        In this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic

        authentication header can be constructed in three steps:


        * Username and password are concatenated using the colon `(:)` as a separator `username:password`.

        * The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.

        * Encoded string is added as credentials after the `"Basic "` type.


        Example:


        ```shell

        Username: "Aladdin"

        Password: "openSesame"


        Concatenated string: "Aladdin:openSesame"


        Base64 encoded string: "QWxhZGRpbjpvcGVuU2VzYW1l"


        Authorization header: "Basic QWxhZGRpbjpvcGVuU2VzYW1l"

        ```


        > **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding

        > strings.

        '
      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

        credentials 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

        used to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually

        terminated by making an appropriate API call.


        You can find more details on the creation and behavior of the session at

        the [dedicated documentation page](#platform-connectivity/account-management/create-session).


        After obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:


        ```shell

        Authorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394

        ```

        '
      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

        the 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.

        You can use the token to authorize your API calls until it expires. You can find out more about the process in

        the [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).


        You can include your access token in the Authorization HTTP request header like this:


        ```http

        Authorization: Bearer <access_token>

        ```'
      flows:
        clientCredentials:
          tokenUrl: https://api.infobip.com/auth/1/oauth2/token
          scopes: {}