openapi: 3.2.0
info:
  title: Infobip OpenAPI Specification Platform 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: platform
  description: 'Modular tools to scale and automate your business.

    '
  x-type: category
  x-displayName: Platform
paths:
  /2fa/2/applications:
    get:
      tags:
      - platform
      summary: Get all 2FA applications
      description: An application is a container for 2FA message templates. Use this method to list your applications.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: get-2fa-applications
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Multiple applications response:
                  summary: Multiple applications response
                  value:
                  - applicationId: 0933F3BC087D2A617AC6DCB2EF5B8A61
                    name: Test application BASIC 1
                    configuration:
                      pinAttempts: 10
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 2h
                      verifyPinLimit: 1/3s
                      sendPinPerApplicationLimit: 10000/1d
                      sendPinPerPhoneNumberLimit: 3/1d
                    enabled: true
                  - applicationId: 5F04FACFAA4978F62FCAEBA97B37E90F
                    name: Test application BASIC 2
                    configuration:
                      pinAttempts: 12
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 10m
                      verifyPinLimit: 2/1s
                      sendPinPerApplicationLimit: 10000/1d
                      sendPinPerPhoneNumberLimit: 5/1h
                    enabled: true
                  - applicationId: B450F966A8EF017180F148AF22C42642
                    name: Test application BASIC 3
                    configuration:
                      pinAttempts: 15
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 1h
                      verifyPinLimit: 30/10s
                      sendPinPerApplicationLimit: 10000/3d
                      sendPinPerPhoneNumberLimit: 10/20m
                    enabled: true
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Multiple applications response:
                  summary: Multiple applications response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationResponses>\n  <item>\n    <applicationId>0933F3BC087D2A617AC6DCB2EF5B8A61</applicationId>\n    <name>Test application BASIC 1</name>\n    <configuration>\n      <pinAttempts>10</pinAttempts>\n      <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n      <pinTimeToLive>2h</pinTimeToLive>\n      <verifyPinLimit>1/3s</verifyPinLimit>\n      <sendPinPerApplicationLimit>10000/1d</sendPinPerApplicationLimit>\n      <sendPinPerPhoneNumberLimit>3/1d</sendPinPerPhoneNumberLimit>\n    </configuration>\n    <enabled>true</enabled>\n  </item>\n  <item>\n    <applicationId>5F04FACFAA4978F62FCAEBA97B37E90F</applicationId>\n    <name>Test application BASIC 2</name>\n    <configuration>\n      <pinAttempts>12</pinAttempts>\n      <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n      <pinTimeToLive>10m</pinTimeToLive>\n      <verifyPinLimit>2/1s</verifyPinLimit>\n      <sendPinPerApplicationLimit>10000/1d</sendPinPerApplicationLimit>\n      <sendPinPerPhoneNumberLimit>5/1h</sendPinPerPhoneNumberLimit>\n    </configuration>\n    <enabled>true</enabled>\n  </item>\n  <item>\n    <applicationId>B450F966A8EF017180F148AF22C42642</applicationId>\n    <name>Test application BASIC 3</name>\n    <configuration>\n      <pinAttempts>15</pinAttempts>\n      <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n      <pinTimeToLive>1h</pinTimeToLive>\n      <verifyPinLimit>30/10s</verifyPinLimit>\n      <sendPinPerApplicationLimit>10000/3d</sendPinPerApplicationLimit>\n      <sendPinPerPhoneNumberLimit>10/20m</sendPinPerPhoneNumberLimit>\n    </configuration>\n    <enabled>true</enabled>\n  </item>\n</ApplicationResponses>\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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 50
        numberOfTimeUnits: 10
        timeUnit: m
    post:
      tags:
      - platform
      summary: Create 2FA application
      description: Create and configure a new 2FA application.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: create-2fa-application
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest'
            examples:
              Application request:
                summary: Application request
                value:
                  name: 2fa application name
                  enabled: true
                  configuration:
                    pinAttempts: 5
                    allowMultiplePinVerifications: true
                    pinTimeToLive: 10m
                    verifyPinLimit: 2/4s
                    sendPinPerApplicationLimit: 5000/12h
                    sendPinPerPhoneNumberLimit: 2/1d
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest'
            examples:
              Application request:
                summary: Application request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationRequest>\n  <name>2fa application name</name>\n  <enabled>true</enabled>\n  <configuration>\n    <pinAttempts>5</pinAttempts>\n    <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n    <pinTimeToLive>10m</pinTimeToLive>\n    <verifyPinLimit>2/4s</verifyPinLimit>\n    <sendPinPerApplicationLimit>5000/12h</sendPinPerApplicationLimit>\n    <sendPinPerPhoneNumberLimit>2/1d</sendPinPerPhoneNumberLimit>\n  </configuration>\n</ApplicationRequest>\n"
      responses:
        '201':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Creating new application response:
                  summary: Creating new application response
                  value:
                    applicationId: '1234567'
                    name: Application name
                    configuration:
                      pinAttempts: 5
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 10m
                      verifyPinLimit: 2/4s
                      sendPinPerApplicationLimit: 5000/12h
                      sendPinPerPhoneNumberLimit: 2/1d
                    enabled: true
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Creating new application response:
                  summary: Creating new application response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationResponse>\n  <applicationId>1234567</applicationId>\n  <name>Application name</name>\n  <configuration>\n    <pinAttempts>5</pinAttempts>\n    <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n    <pinTimeToLive>10m</pinTimeToLive>\n    <verifyPinLimit>2/4s</verifyPinLimit>\n    <sendPinPerApplicationLimit>5000/12h</sendPinPerApplicationLimit>\n    <sendPinPerPhoneNumberLimit>2/1d</sendPinPerPhoneNumberLimit>\n  </configuration>\n  <enabled>true</enabled>\n</ApplicationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 10
        timeUnit: m
  /2fa/2/applications/{appId}:
    get:
      tags:
      - platform
      summary: Get 2FA application
      description: Get a single 2FA application to see its configuration details.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: get-2fa-application
      parameters:
      - name: appId
        in: path
        description: ID of application for which configuration view was requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Single application response:
                  summary: Single application response
                  value:
                    applicationId: '1234567'
                    name: Application name
                    configuration:
                      pinAttempts: 5
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 10m
                      verifyPinLimit: 2/4s
                      sendPinPerApplicationLimit: 5000/12h
                      sendPinPerPhoneNumberLimit: 2/1d
                    enabled: true
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Single application response:
                  summary: Single application response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationResponse>\n  <applicationId>1234567</applicationId>\n  <name>Application name</name>\n  <configuration>\n    <pinAttempts>5</pinAttempts>\n    <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n    <pinTimeToLive>10m</pinTimeToLive>\n    <verifyPinLimit>2/4s</verifyPinLimit>\n    <sendPinPerApplicationLimit>5000/12h</sendPinPerApplicationLimit>\n    <sendPinPerPhoneNumberLimit>2/1d</sendPinPerPhoneNumberLimit>\n  </configuration>\n  <enabled>true</enabled>\n</ApplicationResponse>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 10
        timeUnit: m
    put:
      tags:
      - platform
      summary: Update 2FA application
      description: Change configuration options for your existing 2FA application.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: update-2fa-application
      parameters:
      - name: appId
        in: path
        description: ID of application that should be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest'
            examples:
              Application request:
                summary: Application request
                value:
                  name: 2fa application name
                  enabled: true
                  configuration:
                    pinAttempts: 5
                    allowMultiplePinVerifications: true
                    pinTimeToLive: 10m
                    verifyPinLimit: 2/4s
                    sendPinPerApplicationLimit: 5000/12h
                    sendPinPerPhoneNumberLimit: 2/1d
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest'
            examples:
              Application request:
                summary: Application request
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationRequest>\n  <name>2fa application name</name>\n  <enabled>true</enabled>\n  <configuration>\n    <pinAttempts>5</pinAttempts>\n    <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n    <pinTimeToLive>10m</pinTimeToLive>\n    <verifyPinLimit>2/4s</verifyPinLimit>\n    <sendPinPerApplicationLimit>5000/12h</sendPinPerApplicationLimit>\n    <sendPinPerPhoneNumberLimit>2/1d</sendPinPerPhoneNumberLimit>\n  </configuration>\n</ApplicationRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Updating application response:
                  summary: Updating application response
                  value:
                    applicationId: '1234567'
                    name: Application name
                    configuration:
                      pinAttempts: 5
                      allowMultiplePinVerifications: true
                      pinTimeToLive: 10m
                      verifyPinLimit: 2/4s
                      sendPinPerApplicationLimit: 5000/12h
                      sendPinPerPhoneNumberLimit: 2/1d
                    enabled: true
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse'
              examples:
                Updating application response:
                  summary: Updating application response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApplicationResponse>\n  <applicationId>1234567</applicationId>\n  <name>Application name</name>\n  <configuration>\n    <pinAttempts>5</pinAttempts>\n    <allowMultiplePinVerifications>true</allowMultiplePinVerifications>\n    <pinTimeToLive>10m</pinTimeToLive>\n    <verifyPinLimit>2/4s</verifyPinLimit>\n    <sendPinPerApplicationLimit>5000/12h</sendPinPerApplicationLimit>\n    <sendPinPerPhoneNumberLimit>2/1d</sendPinPerPhoneNumberLimit>\n  </configuration>\n  <enabled>true</enabled>\n</ApplicationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 10
        timeUnit: m
  /2fa/2/applications/{appId}/messages:
    get:
      tags:
      - platform
      summary: Get all 2FA message templates
      description: List all message templates in a 2FA application.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: get-2fa-message-templates
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message'
              examples:
                Multiple message template response:
                  summary: Multiple message template response
                  value:
                  - messageId: A89CE542F3F12
                    applicationId: 32G5F37A635KJ8BHJ675435E3A6EA434
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    senderId: Infobip 2FA
                  - messageId: AF33289C815F8
                    applicationId: A635KJ8BHJ6754432G5F3735E3A6EA43
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    language: en
                    voiceName: Joanna
                    senderId: Infobip 2FA
                    repeatDTMF: 1#
                    speechRate: 1.0
                  - messageId: 9C815F8AF3328
                    applicationId: HJ675435E3A6EA43432G5F37A635KJ8B
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    from: company@example.com
                    emailTemplateId: 1234
                    landingPageId: '1_23456'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message'
              examples:
                Multiple message template response:
                  summary: Multiple message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Messages>\n  <item>\n    <messageId>A89CE542F3F12</messageId>\n    <applicationId>32G5F37A635KJ8BHJ675435E3A6EA434</applicationId>\n    <messageText>Your pin is {{pin}}</messageText>\n    <pinLength>4</pinLength>\n    <pinType>ALPHANUMERIC</pinType>\n    <senderId>Infobip 2FA</senderId>\n  </item>\n  <item>\n    <messageId>AF33289C815F8</messageId>\n    <applicationId>A635KJ8BHJ6754432G5F3735E3A6EA43</applicationId>\n    <messageText>Your pin is {{pin}}</messageText>\n    <pinLength>4</pinLength>\n    <pinType>ALPHANUMERIC</pinType>\n    <language>en</language>\n    <voiceName>Joanna</voiceName>\n    <senderId>Infobip 2FA</senderId>\n    <repeatDTMF>1#</repeatDTMF>\n    <speechRate>1.0</speechRate>\n  </item>\n  <item>\n    <messageId>9C815F8AF3328</messageId>\n    <applicationId>HJ675435E3A6EA43432G5F37A635KJ8B</applicationId>\n    <pinLength>4</pinLength>\n    <pinType>ALPHANUMERIC</pinType>\n    <from>company@example.com</from>\n    <emailTemplateId>1234</emailTemplateId>\n    <landingPageId>1_23456</landingPageId>\n  </item>\n</Messages>\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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
    post:
      tags:
      - platform
      summary: Create 2FA SMS or Voice message template
      description: Once you have your [2FA application](#channels/sms/2fa/2fa-configuration/create-2fa-application), create one or more [message templates](#channels/sms/2fa/2fa-configuration/create-2fa-message-template) where your PIN will be dynamically included when you send the PIN message over SMS or Voice.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: create-2fa-message-template
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateSmsOrVoiceMessageRequest'
            examples:
              Create message template:
                summary: Create message template
                value:
                  pinType: NUMERIC
                  messageText: Your pin is {{pin}}
                  pinLength: 4
                  language: en
                  voiceName: Joanna
                  senderId: Infobip 2FA
                  repeatDTMF: 1#
                  speechRate: 1.0
              Create message template with placeholders:
                summary: Create message template with placeholders
                description: Create a message template with placeholders that can later be filled with different values for each PIN message
                value:
                  pinType: NUMERIC
                  messageText: Hello {{firstName}} your pin is {{pin}}
                  pinLength: 4
                  language: en
                  voiceName: Joanna
                  senderId: Infobip 2FA
                  repeatDTMF: 1#
                  speechRate: 1.0
              Create message template with DLT parameters:
                summary: Create message template with DLT parameters
                description: Create a message template with Distributed Ledger Technology (DLT) parameters required for sending SMS to India region
                value:
                  pinType: NUMERIC
                  messageText: Your pin is {{pin}}
                  pinLength: 4
                  language: en
                  voiceName: Joanna
                  senderId: Infobip 2FA
                  repeatDTMF: 1#
                  speechRate: 1.0
                  regional:
                    indiaDlt:
                      contentTemplateId: your-template-id
                      principalEntityId: your-entity-id
                      teleMarketerId: your-tele-marketer-id
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateSmsOrVoiceMessageRequest'
            examples:
              Create message template:
                summary: Create message template
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CreateSmsOrVoiceMessageRequest>\n  <pinType>NUMERIC</pinType>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</CreateSmsOrVoiceMessageRequest>\n"
              Create message template with placeholders:
                summary: Create message template with placeholders
                description: Create a message template with placeholders that can later be filled with different values for each PIN message
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CreateSmsOrVoiceMessageRequest>\n  <pinType>NUMERIC</pinType>\n  <messageText>Hello {{firstName}} your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</CreateSmsOrVoiceMessageRequest>\n"
              Create message template with DLT parameters:
                summary: Create message template with DLT parameters
                description: Create a message template with Distributed Ledger Technology (DLT) parameters required for sending SMS to India region
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CreateSmsOrVoiceMessageRequest>\n  <pinType>NUMERIC</pinType>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n  <regional>\n    <indiaDlt>\n      <contentTemplateId>your-template-id</contentTemplateId>\n      <principalEntityId>your-entity-id</principalEntityId>\n      <teleMarketerId>your-tele-marketer-id</teleMarketerId>\n    </indiaDlt>\n  </regional>\n</CreateSmsOrVoiceMessageRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage'
              examples:
                Message template response:
                  summary: Message template response
                  value:
                    messageId: B628A31410306DDB2BFB0D9CF1F3A3FF
                    applicationId: 19F2491982980DBC2C40E1597FD175AB
                    pinPlaceholder: '{{pin}}'
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    language: en
                    voiceName: Joanna
                    senderId: Infobip 2FA
                    repeatDTMF: 1#
                    speechRate: 1.0
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage'
              examples:
                Message template response:
                  summary: Message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsOrVoiceMessage>\n  <messageId>B628A31410306DDB2BFB0D9CF1F3A3FF</messageId>\n  <applicationId>19F2491982980DBC2C40E1597FD175AB</applicationId>\n  <pinPlaceholder>{{pin}}</pinPlaceholder>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</SmsOrVoiceMessage>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
  /2fa/2/applications/{appId}/messages/{msgId}:
    get:
      tags:
      - platform
      summary: Get 2FA message template
      description: Get a single 2FA message template from an application to see its configuration details.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: get-2fa-message-template
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      - name: msgId
        in: path
        description: Requested message ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 16A8B5FE2BCD6CA716A2D780CB3F3390
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message'
              examples:
                SMS message template response:
                  summary: SMS message template response
                  value:
                    messageId: A89CE542F3F12
                    applicationId: 32G5F37A635KJ8BHJ675435E3A6EA434
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    senderId: Infobip 2FA
                Voice message template response:
                  summary: Voice message template response
                  value:
                    messageId: AF33289C815F8
                    applicationId: A635KJ8BHJ6754432G5F3735E3A6EA43
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    language: en
                    voiceName: Joanna
                    senderId: Infobip 2FA
                    repeatDTMF: 1#
                    speechRate: 1.0
                Email message template response:
                  summary: Email message template response
                  value:
                    messageId: 9C815F8AF3328
                    applicationId: HJ675435E3A6EA43432G5F37A635KJ8B
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    from: company@example.com
                    emailTemplateId: 1234
                    landingPageId: '1_23456'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message'
              examples:
                SMS message template response:
                  summary: SMS message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Message>\n  <messageId>A89CE542F3F12</messageId>\n  <applicationId>32G5F37A635KJ8BHJ675435E3A6EA434</applicationId>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <senderId>Infobip 2FA</senderId>\n</Message>\n"
                Voice message template response:
                  summary: Voice message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Message>\n  <messageId>AF33289C815F8</messageId>\n  <applicationId>A635KJ8BHJ6754432G5F3735E3A6EA43</applicationId>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</Message>\n"
                Email message template response:
                  summary: Email message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Message>\n  <messageId>9C815F8AF3328</messageId>\n  <applicationId>HJ675435E3A6EA43432G5F37A635KJ8B</applicationId>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <from>company@example.com</from>\n  <emailTemplateId>1234</emailTemplateId>\n  <landingPageId>1_23456</landingPageId>\n</Message>\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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
    put:
      tags:
      - platform
      summary: Update 2FA SMS or Voice message template
      description: Change configuration options for your existing 2FA application SMS or Voice message template.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: update-2fa-message-template
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      - name: msgId
        in: path
        description: Requested message ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 16A8B5FE2BCD6CA716A2D780CB3F3390
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateSmsOrVoiceMessageRequest'
            examples:
              Update message template:
                summary: Update message template
                value:
                  pinType: ALPHANUMERIC
                  messageText: Your pin is {{pin}}
                  pinLength: 6
                  language: en
                  voiceName: Joanna
                  senderId: Infobip 2FA
                  repeatDTMF: 1#
                  speechRate: 1.0
              Add DLT parameters to message template:
                summary: Add DLT parameters to message template
                description: Add Distributed Ledger Technology (DLT) parameters required for sending SMS to India region to an existing message template
                value:
                  pinType: ALPHANUMERIC
                  messageText: Your pin is {{pin}}
                  pinLength: 6
                  language: en
                  voiceName: Joanna
                  senderId: Infobip 2FA
                  repeatDTMF: 1#
                  speechRate: 1.0
                  regional:
                    indiaDlt:
                      contentTemplateId: your-template-id
                      principalEntityId: your-entity-id
                      teleMarketerId: your-tele-marketer-id
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateSmsOrVoiceMessageRequest'
            examples:
              Update message template:
                summary: Update message template
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><UpdateSmsOrVoiceMessageRequest>\n  <pinType>ALPHANUMERIC</pinType>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>6</pinLength>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</UpdateSmsOrVoiceMessageRequest>\n"
              Add DLT parameters to message template:
                summary: Add DLT parameters to message template
                description: Add Distributed Ledger Technology (DLT) parameters required for sending SMS to India region to an existing message template
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><UpdateSmsOrVoiceMessageRequest>\n  <pinType>ALPHANUMERIC</pinType>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>6</pinLength>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n  <regional>\n    <indiaDlt>\n      <contentTemplateId>your-template-id</contentTemplateId>\n      <principalEntityId>your-entity-id</principalEntityId>\n      <teleMarketerId>your-tele-marketer-id</teleMarketerId>\n    </indiaDlt>\n  </regional>\n</UpdateSmsOrVoiceMessageRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage'
              examples:
                Message template response:
                  summary: Message template response
                  value:
                    messageId: B628A31410306DDB2BFB0D9CF1F3A3FF
                    applicationId: 19F2491982980DBC2C40E1597FD175AB
                    pinPlaceholder: '{{pin}}'
                    messageText: Your pin is {{pin}}
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    language: en
                    voiceName: Joanna
                    senderId: Infobip 2FA
                    repeatDTMF: 1#
                    speechRate: 1.0
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage'
              examples:
                Message template response:
                  summary: Message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><SmsOrVoiceMessage>\n  <messageId>B628A31410306DDB2BFB0D9CF1F3A3FF</messageId>\n  <applicationId>19F2491982980DBC2C40E1597FD175AB</applicationId>\n  <pinPlaceholder>{{pin}}</pinPlaceholder>\n  <messageText>Your pin is {{pin}}</messageText>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <language>en</language>\n  <voiceName>Joanna</voiceName>\n  <senderId>Infobip 2FA</senderId>\n  <repeatDTMF>1#</repeatDTMF>\n  <speechRate>1.0</speechRate>\n</SmsOrVoiceMessage>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
  /2fa/2/applications/{appId}/email/messages:
    post:
      tags:
      - platform
      summary: Create 2FA Email message template
      description: Once you have your [2FA application](#channels/sms/create-2fa-application), create one or more [Email message templates](https://www.infobip.com/docs/email/templates) where your PIN will be dynamically included when you send the PIN message over Email.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: create-2fa-email-message-template
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateEmailMessageRequest'
            examples:
              Create message template:
                summary: Create message template
                value:
                  pinType: NUMERIC
                  pinLength: 4
                  from: company@example.com
                  emailTemplateId: 1234
                  landingPageId: '1_23456'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateEmailMessageRequest'
            examples:
              Create message template:
                summary: Create message template
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><CreateEmailMessageRequest>\n  <pinType>NUMERIC</pinType>\n  <pinLength>4</pinLength>\n  <from>company@example.com</from>\n  <emailTemplateId>1234</emailTemplateId>\n  <landingPageId>1_23456</landingPageId>\n</CreateEmailMessageRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage'
              examples:
                Email message template response:
                  summary: Email message template response
                  value:
                    messageId: 9C815F8AF3328
                    applicationId: HJ675435E3A6EA43432G5F37A635KJ8B
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    from: company@example.com
                    emailTemplateId: 1234
                    landingPageId: '1_23456'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage'
              examples:
                Email message template response:
                  summary: Email message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><EmailMessage>\n  <messageId>9C815F8AF3328</messageId>\n  <applicationId>HJ675435E3A6EA43432G5F37A635KJ8B</applicationId>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <from>company@example.com</from>\n  <emailTemplateId>1234</emailTemplateId>\n  <landingPageId>1_23456</landingPageId>\n</EmailMessage>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 10
        timeUnit: m
  /2fa/2/applications/{appId}/email/messages/{msgId}:
    put:
      tags:
      - platform
      summary: Update 2FA Email message template
      description: Change configuration options for your existing 2FA application Email message template.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: update-2fa-email-message-template
      parameters:
      - name: appId
        in: path
        description: ID of application for which requested message was created.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      - name: msgId
        in: path
        description: Requested message ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 16A8B5FE2BCD6CA716A2D780CB3F3390
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateEmailMessageRequest'
            examples:
              Update message template:
                summary: Update message template
                value:
                  pinType: ALPHANUMERIC
                  pinLength: 6
                  from: company@example.com
                  emailTemplateId: 1234
                  landingPageId: '1_23456'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateEmailMessageRequest'
            examples:
              Update message template:
                summary: Update message template
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><UpdateEmailMessageRequest>\n  <pinType>ALPHANUMERIC</pinType>\n  <pinLength>6</pinLength>\n  <from>company@example.com</from>\n  <emailTemplateId>1234</emailTemplateId>\n  <landingPageId>1_23456</landingPageId>\n</UpdateEmailMessageRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage'
              examples:
                Email message template response:
                  summary: Email message template response
                  value:
                    messageId: 9C815F8AF3328
                    applicationId: HJ675435E3A6EA43432G5F37A635KJ8B
                    pinLength: 4
                    pinType: ALPHANUMERIC
                    from: company@example.com
                    emailTemplateId: 1234
                    landingPageId: '1_23456'
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage'
              examples:
                Email message template response:
                  summary: Email message template response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><EmailMessage>\n  <messageId>9C815F8AF3328</messageId>\n  <applicationId>HJ675435E3A6EA43432G5F37A635KJ8B</applicationId>\n  <pinLength>4</pinLength>\n  <pinType>ALPHANUMERIC</pinType>\n  <from>company@example.com</from>\n  <emailTemplateId>1234</emailTemplateId>\n  <landingPageId>1_23456</landingPageId>\n</EmailMessage>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          $ref: '#/components/responses/ApiException404'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 10
        timeUnit: m
  /2fa/2/pin:
    post:
      tags:
      - platform
      summary: Send 2FA PIN code over SMS
      description: Send a PIN code over SMS using a previously created [message template](#channels/sms/create-2fa-message-template).
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: send-2fa-pin-code-over-sms
      parameters:
      - name: ncNeeded
        in: query
        description: Indicates if [Number Lookup](https://www.infobip.com/docs/api/connectivity/number-lookup) is needed before sending the 2FA message. If the parameter value is true, Number Lookup will be requested before sending the SMS. If the value is false, the SMS will be sent without requesting Number Lookup. Field's default value is `true`.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'true'
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest'
            examples:
              Send PIN over SMS:
                summary: Send PIN over SMS
                value:
                  applicationId: '1234567'
                  messageId: '7654321'
                  from: Sender 1
                  to: '41793026727'
                  placeholders:
                    firstName: John
                  trackDelivery: false
              Send PIN over SMS with delivery report:
                summary: Send PIN over SMS with delivery report
                value:
                  applicationId: '1234567'
                  messageId: '7654321'
                  from: Sender 1
                  to: '41793026727'
                  placeholders:
                    firstName: John
                  trackDelivery: true
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest'
            examples:
              Send PIN over SMS:
                summary: Send PIN over SMS
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationRequest>\n  <applicationId>1234567</applicationId>\n  <messageId>7654321</messageId>\n  <from>Sender 1</from>\n  <to>41793026727</to>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>false</trackDelivery>\n</StartAuthenticationRequest>\n"
              Send PIN over SMS with delivery report:
                summary: Send PIN over SMS with delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationRequest>\n  <applicationId>1234567</applicationId>\n  <messageId>7654321</messageId>\n  <from>Sender 1</from>\n  <to>41793026727</to>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>true</trackDelivery>\n</StartAuthenticationRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over SMS:
                  summary: Send PIN over SMS
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: '41793026727'
                    ncStatus: NC_DESTINATION_REACHABLE
                    smsStatus: MESSAGE_SENT
                Send PIN over SMS with delivery report:
                  summary: Send PIN over SMS with delivery report
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: '41793026727'
                    ncStatus: NC_DESTINATION_REACHABLE
                    smsStatus: MESSAGE_SENT
                    externalMessageId: 32ddd1a1-9ace-4b99-95c0-add44c3363af
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over SMS:
                  summary: Send PIN over SMS
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>41793026727</to>\n  <ncStatus>NC_DESTINATION_REACHABLE</ncStatus>\n  <smsStatus>MESSAGE_SENT</smsStatus>\n</StartAuthenticationResponse>\n"
                Send PIN over SMS with delivery report:
                  summary: Send PIN over SMS with delivery report
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>41793026727</to>\n  <ncStatus>NC_DESTINATION_REACHABLE</ncStatus>\n  <smsStatus>MESSAGE_SENT</smsStatus>\n  <externalMessageId>32ddd1a1-9ace-4b99-95c0-add44c3363af</externalMessageId>\n</StartAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/pin/{pinId}/resend:
    post:
      tags:
      - platform
      summary: Resend 2FA PIN code over SMS
      description: If needed, you can resend the same (previously sent) PIN code over SMS.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: resend-2fa-pin-code-over-sms
      parameters:
      - name: pinId
        in: path
        description: ID of the pin code that has to be verified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value:
                  placeholders:
                    firstName: John
                  trackDelivery: false
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ResendPinRequest>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>false</trackDelivery>\n</ResendPinRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over SMS:
                  summary: Send PIN over SMS
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: '41793026727'
                    ncStatus: NC_DESTINATION_REACHABLE
                    smsStatus: MESSAGE_SENT
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over SMS:
                  summary: Send PIN over SMS
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>41793026727</to>\n  <ncStatus>NC_DESTINATION_REACHABLE</ncStatus>\n  <smsStatus>MESSAGE_SENT</smsStatus>\n</StartAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/pin/voice:
    post:
      tags:
      - platform
      summary: Send 2FA PIN code over Voice
      description: Send a PIN code over Voice using previously created [message template](#channels/sms/create-2fa-message-template).
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: send-2fa-pin-code-over-voice
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest'
            examples:
              Send PIN over SMS:
                summary: Send PIN over SMS
                value:
                  applicationId: '1234567'
                  messageId: '7654321'
                  from: Sender 1
                  to: '41793026727'
                  placeholders:
                    firstName: John
                  trackDelivery: false
              Send PIN over SMS with delivery report:
                summary: Send PIN over SMS with delivery report
                value:
                  applicationId: '1234567'
                  messageId: '7654321'
                  from: Sender 1
                  to: '41793026727'
                  placeholders:
                    firstName: John
                  trackDelivery: true
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest'
            examples:
              Send PIN over SMS:
                summary: Send PIN over SMS
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationRequest>\n  <applicationId>1234567</applicationId>\n  <messageId>7654321</messageId>\n  <from>Sender 1</from>\n  <to>41793026727</to>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>false</trackDelivery>\n</StartAuthenticationRequest>\n"
              Send PIN over SMS with delivery report:
                summary: Send PIN over SMS with delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationRequest>\n  <applicationId>1234567</applicationId>\n  <messageId>7654321</messageId>\n  <from>Sender 1</from>\n  <to>41793026727</to>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>true</trackDelivery>\n</StartAuthenticationRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over Voice:
                  summary: Send PIN over Voice
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: '41793026727'
                    callStatus: PENDING_ACCEPTED
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over Voice:
                  summary: Send PIN over Voice
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>41793026727</to>\n  <callStatus>PENDING_ACCEPTED</callStatus>\n</StartAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/pin/{pinId}/resend/voice:
    post:
      tags:
      - platform
      summary: Resend 2FA PIN code over Voice
      description: If needed, you can resend the same (previously sent) PIN code over Voice.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: resend-2fa-pin-code-over-voice
      parameters:
      - name: pinId
        in: path
        description: ID of the pin code that has to be verified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value:
                  placeholders:
                    firstName: John
                  trackDelivery: false
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ResendPinRequest>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <trackDelivery>false</trackDelivery>\n</ResendPinRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over Voice:
                  summary: Send PIN over Voice
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: '41793026727'
                    callStatus: PENDING_ACCEPTED
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse'
              examples:
                Send PIN over Voice:
                  summary: Send PIN over Voice
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>41793026727</to>\n  <callStatus>PENDING_ACCEPTED</callStatus>\n</StartAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/pin/email:
    post:
      tags:
      - platform
      summary: Send 2FA PIN code over Email
      description: Send a PIN code over Email using previously created [Email message template](#channels/sms/2fa/2fa-configuration/create-2fa-email-message-template).
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: send-2fa-pin-code-over-email
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationRequest'
            examples:
              Send PIN over Email:
                summary: Send PIN over Email
                value:
                  applicationId: '1234567'
                  messageId: '7654321'
                  to: john.smith@example.com
                  placeholders:
                    firstName: John
                  landingPagePlaceholders:
                    name: John
                    surname: Smith
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationRequest'
            examples:
              Send PIN over Email:
                summary: Send PIN over Email
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartEmailAuthenticationRequest>\n  <applicationId>1234567</applicationId>\n  <messageId>7654321</messageId>\n  <to>john.smith@example.com</to>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <landingPagePlaceholders>\n    <name>John</name>\n    <surname>Smith</surname>\n  </landingPagePlaceholders>\n</StartEmailAuthenticationRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse'
              examples:
                Send PIN over Email:
                  summary: Send PIN over Email
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: john.smith@example.com
                    emailStatus:
                      name: PENDING_ACCEPTED
                      description: Message accepted, pending for delivery.
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse'
              examples:
                Send PIN over Email:
                  summary: Send PIN over Email
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartEmailAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>john.smith@example.com</to>\n  <emailStatus>\n    <name>PENDING_ACCEPTED</name>\n    <description>Message accepted, pending for delivery.</description>\n  </emailStatus>\n</StartEmailAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/pin/{pinId}/resend/email:
    post:
      tags:
      - platform
      summary: Resend 2FA PIN code over Email
      description: If needed, you can resend the same (previously sent) PIN code over Email.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: resend-2fa-pin-code-over-email
      parameters:
      - name: pinId
        in: path
        description: ID of the pin code that has to be verified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequestViaEmail'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value:
                  placeholders:
                    firstName: John
                  landingPagePlaceholders:
                    name: John
                    surname: Smith
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequestViaEmail'
            examples:
              Resend PIN with placeholders:
                summary: Resend PIN with placeholders
                description: Resend PIN with custom placeholder values. This request body is optional and you should only use it if your message template contains custom placeholders.
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ResendPinRequestViaEmail>\n  <placeholders>\n    <firstName>John</firstName>\n  </placeholders>\n  <landingPagePlaceholders>\n    <name>John</name>\n    <surname>Smith</surname>\n  </landingPagePlaceholders>\n</ResendPinRequestViaEmail>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse'
              examples:
                Resend PIN over Email:
                  summary: Resend PIN over Email
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    to: john.smith@example.com
                    emailStatus:
                      name: PENDING_ACCEPTED
                      description: Message accepted, pending for delivery.
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse'
              examples:
                Resend PIN over Email:
                  summary: Resend PIN over Email
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><StartEmailAuthenticationResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <to>john.smith@example.com</to>\n  <emailStatus>\n    <name>PENDING_ACCEPTED</name>\n    <description>Message accepted, pending for delivery.</description>\n  </emailStatus>\n</StartEmailAuthenticationResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:pin:manage
      - 2fa:pin:send
  /2fa/2/pin/{pinId}/verify:
    post:
      tags:
      - platform
      summary: Verify a PIN
      description: Verify OTP to confirm successful phone number verification. pinId is received in the response after [sending the OTP message](#channels/sms/2fa/pin-sending-and-verification/send-2fa-pin-code-over-voice).
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: verify-2fa-phone-number
      parameters:
      - name: pinId
        in: path
        description: ID of the pin code that has to be verified.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 0933F3BC087D2A617AC6DCB2EF5B8A61
      requestBody:
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinRequest'
            examples:
              Verify PIN:
                summary: Verify PIN
                value:
                  pin: '1598'
          application/xml:
            schema:
              allOf:
              - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinRequest'
            examples:
              Verify PIN:
                summary: Verify PIN
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><VerifyPinRequest>\n  <pin>1598</pin>\n</VerifyPinRequest>\n"
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinResponse'
              examples:
                Verify PIN response:
                  summary: Verify PIN response
                  value:
                    pinId: 9C817C6F8AF3D48F9FE553282AFA2B67
                    msisdn: '41793026727'
                    verified: true
                    attemptsRemaining: 0
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinResponse'
              examples:
                Verify PIN response:
                  summary: Verify PIN response
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><VerifyPinResponse>\n  <pinId>9C817C6F8AF3D48F9FE553282AFA2B67</pinId>\n  <msisdn>41793026727</msisdn>\n  <verified>true</verified>\n  <attemptsRemaining>0</attemptsRemaining>\n</VerifyPinResponse>\n"
        '400':
          $ref: '#/components/responses/ApiException400'
        '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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /2fa/2/applications/{appId}/verifications:
    get:
      tags:
      - platform
      summary: Get 2FA verification status
      description: Check if a phone number (or email) is already verified for a specific 2FA application.
      externalDocs:
        description: Learn more about the workflow and setup
        url: https://www.infobip.com/docs/2fa-service/general-2fa-otp-setup
      operationId: get-2fa-verification-status
      parameters:
      - name: msisdn
        in: query
        description: Filter by msisdn (phone number or email) for which verification status is checked.
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: '385717284759547'
      - name: verified
        in: query
        description: Filter by verified (true or false).
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'false'
      - name: sent
        in: query
        description: Filter by message sent status (true or false).
        required: false
        style: form
        explode: true
        schema:
          type: boolean
        example: 'true'
      - name: appId
        in: path
        description: ID of 2-FA application for which phone number verification status is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 16A8B5FE2BCD6CA716A2D780CB3F3390
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerificationResponse'
              examples:
                Verification response list:
                  summary: Verification response list
                  value:
                    verifications:
                    - msisdn: '41793026727'
                      verified: true
                      verifiedAt: 1418364366
                      sentAt: 1418364246
                    - msisdn: '41793026746'
                      verified: false
                      verifiedAt: 1418364226
                      sentAt: 1418333246
            application/xml:
              schema:
                allOf:
                - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerificationResponse'
              examples:
                Verification response list:
                  summary: Verification response list
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><VerificationResponse>\n  <verifications>\n    <verifications>\n      <msisdn>41793026727</msisdn>\n      <verified>true</verified>\n      <verifiedAt>1418364366</verifiedAt>\n      <sentAt>1418364246</sentAt>\n    </verifications>\n    <verifications>\n      <msisdn>41793026746</msisdn>\n      <verified>false</verified>\n      <verifiedAt>1418364226</verifiedAt>\n      <sentAt>1418333246</sentAt>\n    </verifications>\n  </verifications>\n</VerificationResponse>\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/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
            application/xml:
              schema:
                $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException'
      security:
      - Basic: []
      - APIKeyHeader: []
      - IBSSOTokenHeader: []
      - OAuth2: []
      x-scopes:
      - 2fa:manage
      - 2fa:pin:send
  /account/1/balance:
    get:
      tags:
      - platform
      summary: Get current account balance
      description: Returns the current account balance displayed in the currency configured for the account.
      operationId: get-account-balance
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
  /account/1/free-messages:
    get:
      tags:
      - platform
      summary: Get remaining free messages
      description: Returns the remaining number of free messages available for the account.
      operationId: get-free-messages-count
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
  /account/1/total-balance:
    get:
      tags:
      - platform
      summary: Get account balance with free messages
      description: Returns the current account balance, monthly balance, monthly and total credit limit, currency details, and the remaining count of free messages per service type.
      operationId: get-total-account-balance
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
  /settings/1/accounts:
    get:
      tags:
      - platform
      summary: Get all sub accounts with filter
      description: This method allows you to get all sub accounts with custom filter
      operationId: get-all-accounts
      parameters:
      - name: name
        in: query
        description: Account name
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Number of account in response
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 40
      - name: enabled
        in: query
        description: Indicates whether the account is enabled
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse'
              examples:
                default_accounts_response:
                  summary: Get all subaccounts by filter
                  value:
                    accounts:
                    - key: accountKey
                      ownerKey: ownerKey
                      name: Account Name
                      enabled: true
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
  /settings/1/accounts/{accountKey}:
    put:
      tags:
      - platform
      summary: Update account
      description: This method allows you to update account. You can only update sub accounts
      operationId: update-account
      parameters:
      - name: accountKey
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest'
            examples:
              UpdateAccountRequest:
                summary: UpdateAccountRequest
                description: Example of UpdateAccountRequest
                value:
                  name: New Account Name
                  enabled: true
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account'
        '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:
      - account-management:manage
  /settings/1/accounts/{accountKey}/api-keys:
    get:
      tags:
      - platform
      summary: Get API keys by filter
      description: This method allows you to get API keys of some account by filter forwarded
      operationId: get-api-keys-by-filter-deprecated
      parameters:
      - name: accountKey
        in: path
        description: Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: name
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 40
      - name: enabled
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: publicApiKey
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys'
              examples:
                default_api_keys_response:
                  summary: Default API keys response
                  value:
                    apiKeys:
                    - key: 573711510E1C002E29679B12C7CB48AE
                      publicApiKey: <secrete api key>
                      accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                      name: ApiKey name
                      allowedIPs:
                      - 127.0.0.1
                      validFrom: '2026-07-09T06:04:54.988+00:00'
                      validTo: '2026-07-09T06:04:54.988+00:00'
                      enabled: true
                      permissions:
                      - ALL
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '500':
          $ref: '#/components/responses/ApiError500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
    post:
      tags:
      - platform
      summary: Create API key
      description: This method allows you to create an API key.
      operationId: create-api-key-deprecated
      parameters:
      - name: accountKey
        in: path
        description: Key of the main account the API key belongs to. Use the special `_` value to reference the account of the user making the API request or a standard account key such as `8F0792F86035A9F4290821F1EE6BC06A` to reference an account explicitly.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1'
            examples:
              default_create_api_key_v1_request:
                summary: Create API key v1 request
                value:
                  name: name
                  allowedIPs:
                  - 127.0.0.1
                  validTo: 2026-08-08T06:04:54.988+0000
                  validFrom: 2026-08-08T06:04:54.988+0000
                  enabled: true
                  permissions:
                  - ALL
        required: true
      responses:
        '201':
          description: Created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse'
        '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'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 0
        timeUnit: d
  /settings/1/accounts/{accountKey}/api-keys/{key}:
    get:
      tags:
      - platform
      summary: Get API key
      description: Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly
      operationId: get-api-key-deprecated
      parameters:
      - name: accountKey
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: key
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '500':
          $ref: '#/components/responses/ApiError500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
    put:
      tags:
      - platform
      summary: Update API key
      description: Key of the main account the API key belongs to. Use the special _ value to reference the account of the user making the API request or a standard account key such as 8F0792F86035A9F4290821F1EE6BC06A to reference an account explicitly.
      operationId: update-api-key-deprecated
      parameters:
      - name: accountKey
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: key
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1'
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse'
        '400':
          $ref: '#/components/responses/ApiError400'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          $ref: '#/components/responses/ApiError404'
        '500':
          $ref: '#/components/responses/ApiError500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
  /settings/2/api-keys:
    get:
      tags:
      - platform
      summary: Get API keys by filter
      description: This method allows you to fetch an API keys by filter. Only users with certain roles can fetch api keys; for example, Account Manager and Integrations Manager roles.
      operationId: get-api-keys-by-filter
      parameters:
      - name: accountId
        in: query
        description: Unique identifier for account this API keys belongs to. AccountId is optional and if not provided it will default to the account making the request.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: name
        in: query
        description: Name of this API Key.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Specify the API key response page you want to fetch, starting with 0. If not set, the response will contain first page. The highest allowed page value is 100.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: size
        in: query
        description: The number of API keys in one response page. If not set, the response will be limited to 100 API keys, which is also the highest allowed size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: orderBy
        in: query
        description: The ordering parameter of API keys in the response page. If not set, the API keys in the response will be ordered by API key id.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: orderDirection
        in: query
        description: The order direction of API keys in the response page. If not set, the API keys in the response will be in the ascending order.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: enabled
        in: query
        description: Is API key enabled.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
      - name: apiKeySecret
        in: query
        description: Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.
        required: false
        style: form
        explode: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse'
              examples:
                default_get_api_key_response:
                  summary: Get API keys response
                  value:
                    apiKeys:
                    - id: 573711510E1C002E29679B12C7CB48AE
                      apiKeySecret: <secret api key>
                      accountId: 8F0792F86035A9F4290821F1EE6BC06A
                      name: First ApiKey on my account
                      allowedIPs:
                      - 127.0.0.1
                      - 168.158.10.122
                      validFrom: '2023-09-01T10:00:00'
                      validTo: '2024-09-01T10:00:00'
                      enabled: true
                      permissions:
                      - PUBLIC_API
                      scopeGuids:
                      - 2fa:manage
                      - account-management:manage
                    paging:
                      page: 0
                      pageSize: 10
                      orderDirection: asc
                      totalCount: 1
                      totalPages: 1
                default_get_api_key_cpaasx_response:
                  summary: Get CPaasX API keys response
                  value:
                    apiKeys:
                    - id: 573711510E1C002E29679B12C7CB48AE
                      apiKeySecret: <secret api key>
                      accountId: 8F0792F86035A9F4290821F1EE6BC06A
                      name: First ApiKey on my account
                      allowedIPs:
                      - 127.0.0.1
                      - 168.158.10.122
                      validFrom: '2023-09-01T10:00:00'
                      validTo: '2024-09-01T10:00:00'
                      enabled: true
                      platform:
                      - key: 301493481C01BC01921AB1072S1A1AA1
                        applicationId: test-application
                        entityId: test-entity
                      - key: 12948B109237B1DB10237EB10E1B01B0
                        applicationId: default
                      - key: C365C6D6575A757D576D5987968D574D
                        applicationId: marketing-automation-application
                        entityId: promotional-traffic-entity
                        action: FILL
                    paging:
                      page: 0
                      pageSize: 10
                      orderDirection: asc
                      totalCount: 1
                      totalPages: 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: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create API key
      description: This method allows you to create an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.
      operationId: create-api-key
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest'
            examples:
              default_create_api_key_request:
                summary: Create API key request
                value:
                  accountId: 8F0792F86035A9F4290821F1EE6BC06A
                  name: First ApiKey on my account
                  allowedIPs:
                  - 127.0.0.1
                  - 168.158.10.122
                  validFrom: '2023-09-01T10:00:00'
                  validTo: '2024-09-01T10:00:00'
                  permissions:
                  - PUBLIC_API
                  scopeGuids:
                  - 2fa:manage
                  - account-management:manage
              default_create_cpaasx_api_key_request:
                summary: Create CPaaSX API key request
                value:
                  accountId: 8F0792F86035A9F4290821F1EE6BC06A
                  name: First ApiKey on my account
                  allowedIPs:
                  - 127.0.0.1
                  - 168.158.10.122
                  validFrom: '2023-09-01T10:00:00'
                  validTo: '2024-09-01T10:00:00'
                  platform:
                  - applicationId: test-application
                    entityId: test-entity
                  - applicationId: default
                  - applicationId: marketing-automation-application
                    entityId: promotional-traffic-entity
                    action: FILL
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey'
              examples:
                default_create_api_key_response:
                  summary: Create API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    permissions:
                    - PUBLIC_API
                    scopeGuids:
                    - 2fa:manage
                    - account-management:manage
                default_create_cpaasx_api_key_response:
                  summary: Create CPaaSX API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    platform:
                    - key: 301493481C01BC01921AB1072S1A1AA1
                      applicationId: test-application
                      entityId: test-entity
                    - key: 12948B109237B1DB10237EB10E1B01B0
                      applicationId: default
                    - key: C365C6D6575A757D576D5987968D574D
                      applicationId: marketing-automation-application
                      entityId: promotional-traffic-entity
                      action: FILL
        '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: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 0
        timeUnit: d
  /settings/2/api-keys/{apiKeyId}:
    get:
      tags:
      - platform
      summary: Get API key
      description: This method allows you to fetch an API key. Only users with certain roles can fetch api key; for example, Account Manager and Integrations Manager roles.
      operationId: get-api-key
      parameters:
      - name: apiKeyId
        in: path
        description: Unique identifier of api key to be returned.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey'
              examples:
                default_get_api_key_response:
                  summary: Get API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    permissions:
                    - PUBLIC_API
                    scopeGuids:
                    - 2fa:manage
                    - account-management:manage
                default_get_cpaasx_api_key_response:
                  summary: Get CPaaSX API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    platform:
                    - key: 301493481C01BC01921AB1072S1A1AA1
                      applicationId: test-application
                      entityId: test-entity
                    - key: 12948B109237B1DB10237EB10E1B01B0
                      applicationId: default
                    - key: C365C6D6575A757D576D5987968D574D
                      applicationId: marketing-automation-application
                      entityId: promotional-traffic-entity
                      action: FILL
        '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: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update API key
      description: This method allows you to update an API key. Only users with certain roles can create api keys; for example, Account Manager and Integrations Manager roles.
      operationId: update-api-key
      parameters:
      - name: apiKeyId
        in: path
        description: Unique identifier of api key to be updated.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequest'
            examples:
              default_update_api_key_request:
                summary: Update API key request
                value:
                  name: First ApiKey on my account
                  allowedIPs:
                  - 127.0.0.1
                  - 168.158.10.122
                  validFrom: '2025-09-01T10:00:00'
                  validTo: '2024-09-01T10:00:00'
                  permissions:
                  - PUBLIC_API
                  scopeGuids:
                  - 2fa:manage
                  - account:management
              default_update_cpaasx_api_key_request:
                summary: Update CPaaSX API key request
                value:
                  name: First ApiKey on my account
                  allowedIPs:
                  - 127.0.0.1
                  - 168.158.10.122
                  validFrom: '2025-09-01T10:00:00'
                  validTo: '2024-09-01T10:00:00'
                  platform:
                  - applicationId: marketing-automation-application
                    entityId: promotional-traffic-entity
                    action: FILL
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey'
              examples:
                default_update_api_key_response:
                  summary: Update API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    permissions:
                    - PUBLIC_API
                    scopeGuids:
                    - 2fa:manage
                    - account-management:manage
                default_update_cpaasx_api_key_response:
                  summary: Update CPaaSX API key response
                  value:
                    id: 573711510E1C002E29679B12C7CB48AE
                    apiKeySecret: <secret api key>
                    accountId: 8F0792F86035A9F4290821F1EE6BC06A
                    name: First ApiKey on my account
                    allowedIPs:
                    - 127.0.0.1
                    - 168.158.10.122
                    validFrom: '2024-09-01T10:00:00'
                    validTo: '2023-09-01T10:00:00'
                    enabled: true
                    platform:
                    - key: 301493481C01BC01921AB1072S1A1AA1
                      applicationId: test-application
                      entityId: test-entity
                    - key: 12948B109237B1DB10237EB10E1B01B0
                      applicationId: default
                    - key: C365C6D6575A757D576D5987968D574D
                      applicationId: marketing-automation-application
                      entityId: promotional-traffic-entity
                      action: FILL
        '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: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - account-management:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 40
        numberOfTimeUnits: 0
        timeUnit: d
  /auth/1/session:
    post:
      tags:
      - platform
      summary: Create session token
      description: This method allows you to <a href="https://www.infobip.com/docs/essentials/api-authentication#ibsso-token-header">create a session (login)</a> which by default will expire after 60 minutes. If you want to create a new token before the session expires, you'll need to <a href="#platform-connectivity/account-management/destroy-session">destroy it</a> first.
      operationId: create-session
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateSessionRequest'
            examples:
              default_create_session_request:
                summary: Create Session Request
                value:
                  username: username
                  password: password
                  unsafe: false
        required: true
      responses:
        '200':
          description: OK
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Session'
        '400':
          $ref: '#/components/responses/ApiException400'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Destroy session token
      description: This method allows you to destroy the session token.
      operationId: destroy-session
      responses:
        '200':
          description: OK
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /auth/1/oauth2/token:
    post:
      tags:
      - platform
      summary: Create OAuth2 token
      description: Generate OAuth2 access token that can later on be used to authenticate other Infobip API calls.
      operationId: create-oauth2-token
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenRequest'
      responses:
        '200':
          description: successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '429':
          $ref: '#/components/responses/ApiException429'
        4XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException'
        '500':
          $ref: '#/components/responses/ApiException500'
        5XX:
          description: Error responses
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException'
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /audit/1/logs/export:
    get:
      tags:
      - platform
      summary: Export Audit Logs
      description: This method allows you to search and export users' activities on the web interface.
      operationId: export-audit-logs
      parameters:
      - name: action
        in: query
        description: User's action. If nothing is provided, logs for all actions are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action'
        example: Create
      - name: description
        in: query
        description: Description of an action. If nothing is provided, logs for all descriptions are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: username
        example: username
      - name: from
        in: query
        description: 'Date and time filter with the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        example: '2023-01-01T00:00:00.000Z'
      - name: item
        in: query
        description: Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item'
        example: User
      - name: ipAddress
        in: query
        description: User's IP address. If nothing is provided, logs for all IP addresses are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 127.0.0.1
        example: 127.0.0.1
      - name: limit
        in: query
        description: Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          example: 10000
          maximum: 10000
          minimum: 1
        example: 10000
      - name: to
        in: query
        description: 'Date and time filter with the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2023-01-03T00:00:00Z'
        example: '2023-01-03T00:00:00.000Z'
      - name: userKey
        in: query
        description: User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: JD1I2JD9JD3DDHHGKCNN1PK2O1
        example: JD1I2JD9JD3DDHHGKCNN1PK2O1
      responses:
        '200':
          description: CSV File.
          content:
            text/csv:
              schema:
                type: string
        '400':
          description: Search result larger than the limit. Limit is 10000.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Search result larger than the limit. Limit is 10000.
                        validationErrors: null
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Search result larger than the limit. Limit is 10000.
                        validationErrors: null
            text/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Search result larger than the limit. Limit is 10000.
                        validationErrors: null
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      - IBSSOTokenHeader: []
      x-scopes:
      - audit-logs:read
      - account-management:manage
  /audit/1/logs:
    get:
      tags:
      - platform
      summary: Search Audit Logs
      description: This method allows you to track and search through users' activities on the web interface.
      operationId: search-audit-logs
      parameters:
      - name: action
        in: query
        description: User's action. If nothing is provided, logs for all actions are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action'
        example: Create
      - name: description
        in: query
        description: Description of an action. If nothing is provided, logs for all descriptions are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: username
        example: username
      - name: from
        in: query
        description: 'Date and time filter with the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. If nothing is provided, there will be no lower limit filter applied on a date and time of recorded activity returned in logs.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2023-01-01T00:00:00Z'
        example: '2023-01-01T00:00:00.000Z'
      - name: item
        in: query
        description: Use it as a filter to apply to the action field to narrow down the logs returned. if nothing is provided, logs with all items are returned.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item'
        example: User
      - name: ipAddress
        in: query
        description: User's IP address. If nothing is provided, logs for all IP addresses are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 127.0.0.1
        example: 127.0.0.1
      - name: limit
        in: query
        description: Max number of user activities returned in logs. Accepts values from `1` to `10000`. Defaults to `10000`.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          example: 10000
          maximum: 10000
          minimum: 1
        example: 10000
      - name: to
        in: query
        description: 'Date and time filter with the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`. If nothing is provided, there will be no upper limit filter applied on a date and time of recorded user activity returned in logs.'
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2023-01-03T00:00:00Z'
        example: '2023-01-03T00:00:00.000Z'
      - name: userKey
        in: query
        description: User's key can be found on the user's profile page at the Infobip portal. If nothing is provided, the logs for all user keys are returned.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: JD1I2JD9JD3DDHHGKCNN1PK2O1
        example: JD1I2JD9JD3DDHHGKCNN1PK2O1
      responses:
        '200':
          description: List of audit logs.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.SearchResult'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - action: Create
                    description: User 'username' created user!
                    id: 80265c56-b644-4fb9-a5ab-83example5b3384
                    ipAddress: 127.0.0.1
                    item: User
                    timestamp: '2026-07-23T00:00:00Z'
                    username: username
        '400':
          description: Search result larger than the limit. Limit is 10000.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Search result larger than the limit. Limit is 10000.
                        validationErrors: null
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      - IBSSOTokenHeader: []
      x-scopes:
      - audit-logs:read
      - account-management:manage
  /provisioning/1/applications:
    get:
      tags:
      - platform
      summary: Get applications
      description: Get a paginated list of applications.
      operationId: get-applications
      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: 1000
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageApplication'
        '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:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create application
      description: Create an application associated with the specified `applicationId`.
      operationId: create-application
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/1/applications/{applicationId}:
    get:
      tags:
      - platform
      summary: Get application
      description: Get an application for the specified `applicationId`.
      operationId: get-application
      parameters:
      - name: applicationId
        in: path
        description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-application
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Modify application
      description: Modify a resource `name` property.
      operationId: modify-application
      parameters:
      - name: applicationId
        in: path
        description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-application
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyApplication'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete application
      description: Delete an application associated with the specified `applicationId`. <br>Deleting an application will reset all resources that were linked to that application to application = default and entity = null. You should ensure that any configuration (like resource associations, inbound message configurations, subscriptions, bots, API Keys etc) related to given application are appropriately reassigned to other applications before attempting to delete the application.
      operationId: delete-application
      parameters:
      - name: applicationId
        in: path
        description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-application
      responses:
        '200':
          description: OK
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/1/entities:
    get:
      tags:
      - platform
      summary: Get entities
      description: Get a paginated list of entities.
      operationId: get-entities
      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: 1000
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageEntity'
        '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:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create entity
      description: 'Create an entity associated with the specified `entityId`. <br>An entity attached to a submitted message will get auto created if it doesn''t exit yet. It will get the entityId and entityName being the value passed on a message. '
      operationId: create-entity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Entity'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/1/entities/{entityId}:
    get:
      tags:
      - platform
      summary: Get entity
      description: Get an entity for the specified `entityId`.
      operationId: get-entity
      parameters:
      - name: entityId
        in: path
        description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-entity
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Entity'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Modify entity
      description: Modify a resource `name` property.
      operationId: modify-entity
      parameters:
      - name: entityId
        in: path
        description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-entity
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyEntity'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete entity
      description: Delete an entity associated with the specified `entityId`. <br> Deleting an entity will reset all resources that were linked to that entity to application = default and entity = null. You should ensure that any configuration (like resource associations, inbound message configurations, subscriptions, bots, API Keys etc) related to given entity are appropriately reassigned to other entities before attempting to delete the entity.
      operationId: delete-entity
      parameters:
      - name: entityId
        in: path
        description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
        example: test-entity
      responses:
        '200':
          description: OK
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/1/associations:
    get:
      tags:
      - platform
      summary: Get resource associations
      description: Get a paginated list of resource associations.
      operationId: get-resource-associations
      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: 1000
          minimum: 1
      - name: resourceType
        in: query
        description: The type of resource to be used.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType'
      - name: channel
        in: query
        description: The channel for which the resource will be used.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType'
      - name: applicationId
        in: query
        description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-application
      - name: entityId
        in: query
        description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-entity
      - name: resourceId
        in: query
        description: The unique identifier of the resource. It depends on both the `resourceType` and `channel`.<br/>Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.<br/>Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-resource
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageResourceAssociation'
        '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:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create resource association
      description: Create a resource association.
      operationId: create-resource-association
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationRequest'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete resource association
      description: Delete a resource association.
      operationId: delete-resource-association
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationRequest'
        required: true
      responses:
        '204':
          description: No Content
          content:
            application/json: {}
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.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/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/1/associations/single:
    get:
      tags:
      - platform
      summary: Get resource association
      description: Get an exact resource association.
      operationId: get-resource-association
      parameters:
      - name: resourceType
        in: query
        description: The type of resource to be used.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType'
      - name: channel
        in: query
        description: The channel for which the resource will be used.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType'
      - name: applicationId
        in: query
        description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
        required: true
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-application
      - name: entityId
        in: query
        description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. If no entity is associated with this resource, set the entityId to `null`.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-entity
      - name: resourceId
        in: query
        description: The unique identifier of the resource. It depends on both the `resourceType` and `channel`.<br/>Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.<br/>Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel.
        required: true
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
        example: test-resource
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - application-entity:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /numbers/1/numbers/available:
    get:
      tags:
      - platform
      summary: Get available numbers
      description: Use this method to get all the numbers available to buy. Use the query parameters to filter the returned numbers for specific details.
      externalDocs:
        description: Read more about number types
        url: https://www.infobip.com/docs/numbers/types
      operationId: get-available-numbers
      parameters:
      - name: capabilities
        in: query
        description: An array of communication channels the number is able to support.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType'
      - name: country
        in: query
        description: The number's country code.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: state
        in: query
        description: 'US Numbers only: US state'
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: npa
        in: query
        description: 'US numbers only: area code.'
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: nxx
        in: query
        description: 'US numbers only: the 3 digits following the area code.'
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: limit
        in: query
        description: Number of records returned per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
      - name: number
        in: query
        description: Searched number.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Page number. Use it with `limit` for paging purposes.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numbers:
                    - numberKey: 78D8394AC3EG0460B4CF0E723FC31B49
                      number: '79029555551'
                      country: RU
                      type: VIRTUAL_LONG_NUMBER
                      capabilities:
                      - SMS
                      shared: false
                      price:
                        pricePerMonth: 15
                        setupPrice: 0
                        initialMonthPrice: 9.193549
                        currency: EUR
                    - numberKey: 3B9D1EACAB7FBDRN%EE03592BFCD6BE
                      number: '79029555525'
                      country: RU
                      type: VIRTUAL_LONG_NUMBER
                      capabilities:
                      - SMS
                      shared: false
                      price:
                        pricePerMonth: 15
                        setupPrice: 0
                        initialMonthPrice: 9.193549
                        currency: EUR
                    numberCount: 2
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-additionalInfo:
        markdown: '### Related

          - [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)

          '
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 2
  /numbers/1/numbers:
    get:
      tags:
      - platform
      summary: List owned numbers
      description: Use this method to get all the owned numbers for this account.
      operationId: list-owned-numbers
      parameters:
      - name: limit
        in: query
        description: Number of records returned per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
      - name: number
        in: query
        description: Searched number.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: page
        in: query
        description: Page number. Use with `limit` for paging purposes.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numbers:
                    - numberKey: 6FED0BC540BFADD9B05ED7D89AAC22FA
                      number: '447860041117'
                      country: GB
                      countryName: United Kingdom
                      type: VIRTUAL_LONG_NUMBER
                      capabilities:
                      - SMS
                      shared: false
                      price:
                        pricePerMonth: 5
                        setupPrice: 0
                        currency: EUR
                      network: 02 (Telefonica UK Ltd)
                      keywords:
                      - test
                      - stop
                      additionalSetupRequired: false
                      editPermissions:
                        canEditNumber: true
                        canEditConfiguration: true
                      applicationId: default
                    numberCount: 1
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-additionalInfo:
        markdown: '### Related

          - [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)

          '
      x-throttling-info:
      - type: token
        replenishRate: 1
        requestedTokens: 1
        burstCapacity: 2
    post:
      tags:
      - platform
      summary: Purchase number
      description: Using the number ID or number, this method enables you to buy a new number. For buying a US number, only the number should be provided. For all other purchases, only the numberKey must be provided.
      externalDocs:
        description: Read more about buying a number
        url: https://www.infobip.com/docs/numbers/buy
      operationId: purchase-number
      requestBody:
        description: Either numberKey of the number to be purchased or a number needs to be provided
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PurchaseNumberRequest'
            examples:
              numberKey:
                summary: numberKey
                description: numberKey
                value:
                  numberKey: 58B3840032C7774BAC840EEEA2C23A44
              number:
                summary: number
                description: number
                value:
                  number: '12223850630'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numberKey: 58B3840032C7774BAC840EEEA2C23A44
                    number: '447860041117'
                    country: GB
                    type: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    shared: false
                    price:
                      pricePerMonth: 5
                      setupPrice: 0
                      currency: EUR
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-additionalInfo:
        markdown: '### Related

          - [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)

          '
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /numbers/1/numbers/{numberKey}:
    get:
      tags:
      - platform
      summary: Get single owned number
      description: Get information about an owned number using the unique ID of the number.
      operationId: get-single-owned-number
      parameters:
      - name: numberKey
        in: path
        description: The unique ID of the number for which information is requested.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numberKey: 6FED0BC540BFADD9B05ED7D89AAC22FA
                    number: '447860041117'
                    country: GB
                    type: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    shared: false
                    price:
                      pricePerMonth: 5
                      setupPrice: 0
                      currency: EUR
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-additionalInfo:
        markdown: '### Related

          - [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)

          '
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update owned number
      description: Use this method to update the application and the entity, if required, that is linked to a number.
      operationId: update-owned-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UpdateOwnedNumberRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  applicationId: appId
                  entityId: entId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numberKey: 58B3840032C7774BAC840EEEA2C23A44
                    number: '447860041117'
                    country: GB
                    type: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    shared: false
                    price:
                      pricePerMonth: 5
                      setupPrice: 0
                      currency: EUR
                    applicationId: appId
                    entityId: entId
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          description: Too many requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Cancel number
      description: This method will cancel your number. Any number purchased from Infobip Numbers inventory you cancel will become available in the numbers pool for anyone to buy.
      externalDocs:
        description: Read more about canceling a number
        url: https://www.infobip.com/docs/numbers/getting-started#cancelling-numbers-over-web-interface-numbers-over-web-interface
      operationId: cancel-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        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'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-additionalInfo:
        markdown: '### Related

          - [Use case: Making an appointment using 2-way SMS communication](https://www.infobip.com/docs/use-cases/appointment-reminder-with-sms)

          '
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /numbers/2/numbers/{numberKey}/sms:
    get:
      tags:
      - platform
      summary: Get all number configurations
      description: List all configurations set up for a number.
      operationId: list-configurations-for-number
      parameters:
      - name: limit
        in: query
        description: Number of records returned per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: page
        in: query
        description: Page number. Use with `limit` for paging purposes.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurations'
              examples:
                Response example:
                  summary: Response example
                  value:
                    configurations:
                    - key: 6336C2CCF10E74B705340E70D8E06BD6
                      keyword: KEYWORD1
                      action:
                        type: HTTP_FORWARD
                        url: http://something.com
                      otherActionsDetails:
                      - message: Auto response message text.
                        editable: true
                        type: AUTORESPONSE
                      otherActions:
                      - AUTORESPONSE
                    - key: 8F0792F86035A9F4290821F1EE6BC06A
                      keyword: KEYWORD2
                      action:
                        type: MAIL_FORWARD
                        mail: someone@something.com
                      otherActionsDetails:
                      - blockType: FROM_SENDER
                        editable: true
                        type: BLOCK
                      otherActions:
                      - BLOCK
                    totalCount: 2
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: get-inbound-configurations
    put:
      tags:
      - platform
      summary: Update number configuration
      description: Update configuration details. Parameters used vary depending on the action type, the same as with the Create a new configuration method.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: modify-sms-configurations
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Configuration with updated values.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration'
            examples:
              MAIL_FORWARD:
                summary: MAIL_FORWARD
                description: Update setup to Mail Forward configuration, or update current Mail Forward configuration
                value:
                  key: E9FCDCA496035F08EEA5933702EDF745
                  keyword: NEWKW
                  action:
                    type: MAIL_FORWARD
                    mail: someone@something.com
              HTTP_Forward:
                summary: HTTP_Forward
                description: Update setup to HTTP Forward configuration, or update current HTTP Forward configuration
                value:
                  key: E9FCDCA496035F08EEA5933702EDF745
                  keyword: KEYWORD1
                  action:
                    type: HTTP_FORWARD
                    url: http://something.com
                    httpMethod: POST
                    contentType: JSON
              SMPP_Forward:
                summary: SMPP_Forward
                description: Update setup to Mail SMPP configuration, or update current SMPP Forward configuration
                value:
                  key: E9FCDCA496035F08EEA5933702EDF745
                  keyword: KEYWORD2
                  action:
                    type: SMPP_FORWARD
              PULL:
                summary: PULL
                description: Update setup to PULL configuration, or update current PULL configuration
                value:
                  key: E9FCDCA496035F08EEA5933702EDF745
                  keyword: KEYWORD2
                  action:
                    type: PULL
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration'
              examples:
                HTTP_FORWARD:
                  summary: HTTP_FORWARD
                  description: Response for HTTP_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD1
                    action:
                      url: http://something.com
                      httpMethod: POST
                      contentType: JSON
                      type: HTTP_FORWARD
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
                MAIL_FORWARD:
                  summary: MAIL_FORWARD
                  description: Response for MAIL_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: NEWKW
                    action:
                      mail: someone@something.com
                      type: MAIL_FORWARD
                    useConversation:
                      enabled: true
                    otherActionsDetails: []
                    otherActions: []
                SMPP_FORWARD:
                  summary: SMPP_FORWARD
                  description: Response for SMPP_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD2
                    action:
                      type: SMPP_FORWARD
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
                PULL:
                  summary: PULL
                  description: Response for PULL type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD2
                    action:
                      type: PULL
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: manage-inbound-configuration
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
    post:
      tags:
      - platform
      summary: Create number configuration
      description: Create a new configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: create-new-configuration
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfiguration'
            examples:
              MAIL_FORWARD:
                summary: MAIL_FORWARD
                description: Setup of MAIL_FORWARD forwarding type
                value:
                  keyword: NEWKW
                  action:
                    type: MAIL_FORWARD
                    mail: someone@something.com
              HTTP_Forward:
                summary: HTTP_Forward
                description: Setup of HTTP_FORWARD forwarding type
                value:
                  keyword: KEYWORD1
                  action:
                    type: HTTP_FORWARD
                    url: http://something.com
                    httpMethod: POST
                    contentType: JSON
              SMPP_Forward:
                summary: SMPP_Forward
                description: Setup of SMPP_FORWARD forwarding type
                value:
                  keyword: KEYWORD2
                  action:
                    type: SMPP_FORWARD
              PULL:
                summary: PULL
                description: Setup of PULL forwarding type
                value:
                  keyword: KEYWORD2
                  action:
                    type: PULL
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration'
              examples:
                HTTP_FORWARD:
                  summary: HTTP_FORWARD
                  description: Response for HTTP_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD1
                    action:
                      url: http://something.com
                      httpMethod: POST
                      contentType: JSON
                      type: HTTP_FORWARD
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
                MAIL_FORWARD:
                  summary: MAIL_FORWARD
                  description: Response for MAIL_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: NEWKW
                    action:
                      mail: someone@something.com
                      type: MAIL_FORWARD
                    useConversation:
                      enabled: true
                    otherActionsDetails: []
                    otherActions: []
                SMPP_FORWARD:
                  summary: SMPP_FORWARD
                  description: Response for SMPP_FORWARD forwarding type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD2
                    action:
                      type: SMPP_FORWARD
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
                PULL:
                  summary: PULL
                  description: Response for PULL type
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD2
                    action:
                      type: PULL
                    useConversation:
                      enabled: false
                    otherActionsDetails: []
                    otherActions: []
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: manage-inbound-configuration
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
  /numbers/2/numbers/{numberKey}/sms/{configurationKey}:
    get:
      tags:
      - platform
      summary: Get single number configuration
      description: This method fetches a single configuration details set up for the number.
      operationId: get-single-configuration
      parameters:
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration'
              examples:
                Response example:
                  summary: Response example
                  value:
                    key: E9FCDCA496035F08EEA5933702EDF745
                    keyword: KEYWORD
                    action:
                      url: http://something.com
                      httpMethod: POST
                      contentType: JSON
                      type: HTTP_FORWARD
                    useConversation:
                      enabled: true
                    otherActionsDetails: []
                    otherActions: []
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: get-inbound-configurations
    delete:
      tags:
      - platform
      summary: Delete number configuration
      description: This method will delete the configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method.
      operationId: delete-configuration
      parameters:
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: numberKey
        in: path
        description: Unique ID of a number.
        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'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: delete-inbound-configuration
  /numbers/2/numbers/{numberKey}/mms:
    get:
      tags:
      - platform
      summary: Get all number MMS configurations
      description: List all MMS configurations set up for a number.
      operationId: get-mms-configurations
      parameters:
      - name: limit
        in: query
        description: Number of records returned per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: page
        in: query
        description: Page number. Use with `limit` for paging purposes.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 0
          minimum: 0
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfigurations'
              examples:
                Response example:
                  summary: Response example
                  value:
                    configurations:
                    - keyword: EXAMPLE
                      action:
                        url: https://url-example.com
                        description: Description example
                        contentFormat: MMS_JSON
                        type: HTTP_FORWARD
                      otherActions: []
                      applicationId: application-identifier-example
                      entityId: entity-identifier-example
                      key: 5A385D1A5ABBC5B3FCE4DBFE19D3C27D
                    - keyword: EXAMPLE2
                      action:
                        description: Description example
                        type: PULL
                      otherActions: []
                      applicationId: application-identifier-example
                      entityId: entity-identifier-example
                      key: 092D77CC41E7C90B8742F536905C9FBD
                    - keyword: EXAMPLE3
                      action:
                        type: NO_ACTION
                      otherActions: []
                      applicationId: application-identifier-example
                      entityId: entity-identifier-example
                      key: BFCCCF0649CB8779962D2AC665103485
                    totalCount: 3
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: get-inbound-configurations
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create number MMS configuration
      description: Create a new MMS configuration for the number. The parameters used for setting up a configuration depend on the action type. Check the examples for more details.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: create-mms-configuration
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
            examples:
              HTTP_Forward:
                summary: HTTP_Forward
                description: Setup of HTTP_FORWARD forwarding type
                value:
                  keyword: EXAMPLE
                  action:
                    url: https://url-example.com
                    description: Description example
                    contentFormat: MMS_JSON
                    type: HTTP_FORWARD
                  applicationId: application-identifier-example
                  entityId: entity-identifier-example
              PULL:
                summary: PULL
                description: Setup of PULL forwarding type
                value:
                  keyword: EXAMPLE2
                  action:
                    description: Description example
                    type: PULL
                  applicationId: application-identifier-example
                  entityId: entity-identifier-example
              NO_ACTION:
                summary: NO_ACTION
                description: No action example
                value:
                  keyword: EXAMPLE3
                  action:
                    type: NO_ACTION
                  applicationId: application-identifier-example
                  entityId: entity-identifier-example
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
              examples:
                HTTP_FORWARD:
                  summary: HTTP_FORWARD
                  description: Response for HTTP_FORWARD forwarding type
                  value:
                    keyword: EXAMPLE
                    action:
                      url: https://url-example.com
                      description: Description example
                      contentFormat: MMS_JSON
                      type: HTTP_FORWARD
                    otherActions: []
                    applicationId: application-identifier-example
                    entityId: entity-identifier-example
                    key: 5A385D1A5ABBC5B3FCE4DBFE19D3C27D
                PULL:
                  summary: PULL
                  description: Response for PULL type
                  value:
                    keyword: EXAMPLE2
                    action:
                      description: Description example
                      type: PULL
                    otherActions: []
                    applicationId: application-identifier-example
                    entityId: entity-identifier-example
                    key: 092D77CC41E7C90B8742F536905C9FBD
                NO_ACTION:
                  summary: NO_ACTION
                  description: Response for NO_ACTION type
                  value:
                    keyword: EXAMPLE3
                    action:
                      type: NO_ACTION
                    otherActions: []
                    applicationId: application-identifier-example
                    entityId: entity-identifier-example
                    key: BFCCCF0649CB8779962D2AC665103485
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: manage-inbound-configuration
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
  /numbers/2/numbers/{numberKey}/mms/{configurationKey}:
    get:
      tags:
      - platform
      summary: Get number MMS configuration
      description: This method fetches a single MMS configuration details set up for the number.
      operationId: get-mms-configuration
      parameters:
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
              examples:
                Response example:
                  summary: Response example
                  value:
                    keyword: EXAMPLE
                    action:
                      url: https://url-example.com
                      description: Description example
                      contentFormat: MMS_JSON
                      type: HTTP_FORWARD
                    otherActions: []
                    applicationId: application-identifier-example
                    entityId: entity-identifier-example
                    key: 5A385D1A5ABBC5B3FCE4DBFE19D3C27D
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: get-inbound-configurations
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update number MMS configuration
      description: Update MMS configuration details. Parameters used vary depending on the action type, the same as with the Create a new MMS configuration method.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: update-mms-configuration
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: Configuration with updated values.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
            examples:
              HTTP_Forward:
                summary: HTTP_Forward
                description: Update setup to HTTP Forward configuration, or update current HTTP Forward configuration
                value:
                  keyword: EXAMPLE-UPDATE
                  action:
                    url: https://url-example-updated.com
                    description: Description example - updated
                    contentFormat: MMS_JSON
                    type: HTTP_FORWARD
                  applicationId: application-identifier-example
                  entityId: entity-identifier-example
              PULL:
                summary: PULL
                description: Update setup to PULL configuration, or update current PULL configuration
                value:
                  keyword: EXAMPLE2
                  action:
                    description: Description example - updated
                    type: PULL
                  applicationId: application-identifier-example-update
                  entityId: entity-identifier-example-update
              NO_ACTION:
                summary: NO_ACTION
                description: Update NO ACTION configuration
                value:
                  keyword: EXAMPLE3 - update
                  action:
                    type: NO_ACTION
                  applicationId: application-identifier-example-update
                  entityId: entity-identifier-example
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
              examples:
                HTTP_FORWARD:
                  summary: HTTP_FORWARD
                  description: Response for HTTP_FORWARD forwarding type
                  value:
                    keyword: EXAMPLE-UPDATE
                    action:
                      url: https://url-example-updated.com
                      description: Description example - updated
                      contentFormat: MMS_JSON
                      type: HTTP_FORWARD
                    otherActions: []
                    applicationId: application-identifier-example
                    entityId: entity-identifier-example
                    key: 5A385D1A5ABBC5B3FCE4DBFE19D3C27D
                PULL:
                  summary: PULL
                  description: Response for PULL type
                  value:
                    keyword: EXAMPLE2
                    action:
                      description: Description example - updated
                      type: PULL
                    otherActions: []
                    applicationId: application-identifier-example-update
                    entityId: entity-identifier-example-update
                    key: 092D77CC41E7C90B8742F536905C9FBD
                NO_ACTION:
                  summary: NO_ACTION
                  description: Response for NO_ACTION type
                  value:
                    keyword: EXAMPLE3 - UPDATE
                    action:
                      type: NO_ACTION
                    otherActions: []
                    applicationId: application-identifier-example-update
                    entityId: entity-identifier-example
                    key: BFCCCF0649CB8779962D2AC665103485
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: manage-inbound-configuration
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
    delete:
      tags:
      - platform
      summary: Delete number MMS configuration
      description: This method will delete MMS configuration. If there are no configurations, you can still retrieve any incoming message by using a Get received messages method.
      operationId: delete-mms-configuration
      parameters:
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: numberKey
        in: path
        description: Unique ID of a number.
        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'
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      deprecated: true
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-deprecationInformation:
        deprecation: 2024-03-13T12:00:00+0000
        successorOperationId: delete-inbound-configuration
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
  /numbers/2/numbers/{numberKey}/voice:
    get:
      tags:
      - platform
      summary: Get voice setup on number
      description: This method fetches the voice setup on a number.
      operationId: get-voice-setup-on-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
              examples:
                VOICE_NUMBER_MASKING:
                  summary: Return Voice Number Masking configuration
                  description: VOICE_NUMBER_MASKING
                  value:
                    action:
                      voiceNumberMaskingConfigKey: C6A5995CBF4D2DF2ADE29963B3BB00E6
                      type: VOICE_NUMBER_MASKING
                FORWARD_TO_IVR:
                  summary: Forward To IVR configuration
                  description: FORWARD_TO_IVR
                  value:
                    action:
                      scenarioKey: 56FE9214E7A98F2D4CB44E647E3D3CED
                      type: FORWARD_TO_IVR
                FORWARD_TO_CALL_ROUTING:
                  summary: Forward To Call Routing configuration
                  description: FORWARD_TO_CALL_ROUTING
                  value:
                    action:
                      routeId: 71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b
                      type: FORWARD_TO_CALL_ROUTING
                FORWARD_TO_PSTN:
                  summary: Forward to PSTN configuration
                  description: FORWARD_TO_PSTN
                  value:
                    action:
                      pstnNumber: '41793026731'
                      type: FORWARD_TO_PSTN
                FORWARD_TO_SUBSCRIPTION:
                  summary: Forward To Subscription configuration
                  description: FORWARD_TO_SUBSCRIPTION
                  value:
                    action:
                      callsConfigurationId: 6b99b1ac-fe35-4be7-bb0e-93c00dbd2206
                      type: FORWARD_TO_SUBSCRIPTION
                FORWARD_TO_MARKUP_LANGUAGE:
                  summary: Forward To Markup Language configuration
                  description: FORWARD_TO_MARKUP_LANGUAGE
                  value:
                    action:
                      type: FORWARD_TO_MARKUP_LANGUAGE
                      markupLanguageConfigId: 123456789
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    put:
      tags:
      - platform
      summary: Update voice setup on number
      description: This method updates voice setup previously created on a number.
      operationId: update-voice-setup-on-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: voiceSetup
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
            examples:
              VOICE_NUMBER_MASKING:
                summary: Update setup to Voice Number Masking, or update current Voice Number Masking setup
                description: VOICE_NUMBER_MASKING
                value:
                  action:
                    voiceNumberMaskingConfigKey: C6A5995CBF4D2DF2ADE29963B3BB00E6
                    type: VOICE_NUMBER_MASKING
              FORWARD_TO_IVR:
                summary: Update setup to Forward To IVR configuration, or update current Forward To IVR configuration
                description: FORWARD_TO_IVR
                value:
                  action:
                    type: FORWARD_TO_IVR
                    scenarioKey: 56FE9214E7A98F2D4CB44E647E3D3CED
              FORWARD_TO_CALL_ROUTING:
                summary: Update setup to Forward To Call Routing configuration, or update current Forward To Call Routing configuration
                description: FORWARD_TO_CALL_ROUTING
                value:
                  action:
                    type: FORWARD_TO_CALL_ROUTING
                    routeId: 71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b
              FORWARD_TO_PSTN:
                summary: Update setup to Forward To PSTN configuration, or update current Forward To PSTN configuration
                description: FORWARD_TO_PSTN
                value:
                  action:
                    type: FORWARD_TO_PSTN
                    pstnNumber: '41793026731'
              FORWARD_TO_SUBSCRIPTION:
                summary: Update setup to Forward To Subscription configuration, or update current Forward To Subscription configuration
                description: FORWARD_TO_SUBSCRIPTION
                value:
                  action:
                    type: FORWARD_TO_SUBSCRIPTION
                    callsConfigurationId: 6b99b1ac-fe35-4be7-bb0e-93c00dbd2206
              FORWARD_TO_MARKUP_LANGUAGE:
                summary: Update setup to Forward To Markup Language configuration, or update current Forward To Markup Language configuration
                description: FORWARD_TO_MARKUP_LANGUAGE
                value:
                  action:
                    type: FORWARD_TO_MARKUP_LANGUAGE
                    markupLanguageConfigId: 123456789
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
              examples:
                VOICE_NUMBER_MASKING:
                  summary: Response for VOICE_NUMBER_MASKING type
                  description: VOICE_NUMBER_MASKING
                  value:
                    action:
                      voiceNumberMaskingConfigKey: C6A5995CBF4D2DF2ADE29963B3BB00E6
                      type: VOICE_NUMBER_MASKING
                FORWARD_TO_IVR:
                  summary: Response for FORWARD_TO_IVR forwarding type
                  description: FORWARD_TO_IVR
                  value:
                    action:
                      scenarioKey: 56FE9214E7A98F2D4CB44E647E3D3CED
                      type: FORWARD_TO_IVR
                FORWARD_TO_CALL_ROUTING:
                  summary: Response for FORWARD_TO_CALL_ROUTING forwarding type
                  description: FORWARD_TO_CALL_ROUTING
                  value:
                    action:
                      routeId: 71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b
                      type: FORWARD_TO_CALL_ROUTING
                FORWARD_TO_PSTN:
                  summary: Response for FORWARD_TO_PSTN forwarding type
                  description: FORWARD_TO_PSTN
                  value:
                    action:
                      pstnNumber: '41793026731'
                      type: FORWARD_TO_PSTN
                FORWARD_TO_SUBSCRIPTION:
                  summary: Response for FORWARD_TO_SUBSCRIPTION forwarding type
                  description: FORWARD_TO_SUBSCRIPTION
                  value:
                    action:
                      callsConfigurationId: 6b99b1ac-fe35-4be7-bb0e-93c00dbd2206
                      type: FORWARD_TO_SUBSCRIPTION
                FORWARD_TO_MARKUP_LANGUAGE:
                  summary: Response for FORWARD_TO_MARKUP_LANGUAGE forwarding type
                  description: FORWARD_TO_MARKUP_LANGUAGE
                  value:
                    action:
                      type: FORWARD_TO_MARKUP_LANGUAGE
                      markupLanguageConfigId: 123456789
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create voice setup on number
      description: This method will create a new voice setup on a number. There can be only one voice action set for the number.
      operationId: create-voice-setup-on-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        description: voiceSetupRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
            examples:
              VOICE_NUMBER_MASKING:
                summary: Setup new Voice Number Masking configuration
                description: VOICE_NUMBER_MASKING
                value:
                  action:
                    voiceNumberMaskingConfigKey: C6A5995CBF4D2DF2ADE29963B3BB00E6
                    type: VOICE_NUMBER_MASKING
              FORWARD_TO_IVR:
                summary: Setup new Forward To IVR configuration
                description: FORWARD_TO_IVR
                value:
                  action:
                    type: FORWARD_TO_IVR
                    scenarioKey: 56FE9214E7A98F2D4CB44E647E3D3CED
              FORWARD_TO_CALL_ROUTING:
                summary: Setup new Forward To Call Routing configuration
                description: FORWARD_TO_CALL_ROUTING
                value:
                  action:
                    type: FORWARD_TO_CALL_ROUTING
                    routeId: 71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b
              FORWARD_TO_PSTN:
                summary: Setup new Forward To PSTN configuration
                description: FORWARD_TO_PSTN
                value:
                  action:
                    type: FORWARD_TO_PSTN
                    pstnNumber: '41793026731'
              FORWARD_TO_SUBSCRIPTION:
                summary: Setup new Forward To Subscription configuration
                description: FORWARD_TO_SUBSCRIPTION
                value:
                  action:
                    type: FORWARD_TO_SUBSCRIPTION
                    callsConfigurationId: 6b99b1ac-fe35-4be7-bb0e-93c00dbd2206
              FORWARD_TO_MARKUP_LANGUAGE:
                summary: Setup new Forward To Markup Language configuration
                description: FORWARD_TO_MARKUP_LANGUAGE
                value:
                  action:
                    type: FORWARD_TO_MARKUP_LANGUAGE
                    markupLanguageConfigId: 123456789
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
              examples:
                VOICE_NUMBER_MASKING:
                  summary: Response for VOICE_NUMBER_MASKING type
                  description: VOICE_NUMBER_MASKING
                  value:
                    action:
                      voiceNumberMaskingConfigKey: C6A5995CBF4D2DF2ADE29963B3BB00E6
                      type: VOICE_NUMBER_MASKING
                FORWARD_TO_IVR:
                  summary: Response for FORWARD_TO_IVR forwarding type
                  description: FORWARD_TO_IVR
                  value:
                    action:
                      scenarioKey: 56FE9214E7A98F2D4CB44E647E3D3CED
                      type: FORWARD_TO_IVR
                FORWARD_TO_CALL_ROUTING:
                  summary: Response for FORWARD_TO_CALL_ROUTING forwarding type
                  description: FORWARD_TO_CALL_ROUTING
                  value:
                    action:
                      routeId: 71c1cd2e-fa30-450f-a6f7-56f2ae0adc6b
                      type: FORWARD_TO_CALL_ROUTING
                FORWARD_TO_PSTN:
                  summary: Response for FORWARD_TO_PSTN forwarding type
                  description: FORWARD_TO_PSTN
                  value:
                    action:
                      pstnNumber: '41793026731'
                      type: FORWARD_TO_PSTN
                FORWARD_TO_SUBSCRIPTION:
                  summary: Response for FORWARD_TO_SUBSCRIPTION forwarding type
                  description: FORWARD_TO_SUBSCRIPTION
                  value:
                    action:
                      callsConfigurationId: 6b99b1ac-fe35-4be7-bb0e-93c00dbd2206
                      type: FORWARD_TO_SUBSCRIPTION
                FORWARD_TO_MARKUP_LANGUAGE:
                  summary: Response for FORWARD_TO_MARKUP_LANGUAGE forwarding type
                  description: FORWARD_TO_MARKUP_LANGUAGE
                  value:
                    action:
                      type: FORWARD_TO_MARKUP_LANGUAGE
                      markupLanguageConfigId: 123456789
        '201':
          description: Created
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete voice setup on number
      description: This method removes voice setup from a number.
      operationId: delete-voice-setup-on-number
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        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:
      - numbers:manage
  /numbers/2/numbers/{numberKey}/voice/cnam:
    get:
      tags:
      - platform
      summary: Get CNAM
      description: Get CNAM configuration.
      operationId: get-cnam
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        '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: CNAM 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    put:
      tags:
      - platform
      summary: Update CNAM
      description: Update a CNAM configuration.
      operationId: update-cnam
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        '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: CNAM 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    post:
      tags:
      - platform
      summary: Create CNAM
      description: 'Create CNAM configuration.


        This is currently available only for United States and Canada numbers.

        '
      operationId: create-cnam
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        '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: CNAM 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    delete:
      tags:
      - platform
      summary: Delete CNAM
      description: Delete CNAM configuration.
      operationId: delete-cnam
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam'
        '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: CNAM 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /numbers/2/numbers/{numberKey}/voice/cnam/status:
    get:
      tags:
      - platform
      summary: Get CNAM status
      description: Get a CNAM configuration status.
      operationId: get-cnam-status
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bc185b494ef7059aff9d68589cd5338df2245f21add51cf1a96e9927af6e30d7.PublicCnamStatus'
        '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: CNAM 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /numbers/2/numbers/{numberKey}/voice/emergency-service/validate-address:
    post:
      tags:
      - platform
      summary: Validate Emergency Service Address
      description: Validate a Emergency Service Address
      operationId: validate-emergency-service
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.ValidateAddressResponse'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /numbers/2/numbers/{numberKey}/voice/emergency-service:
    get:
      tags:
      - platform
      summary: Get Emergency Service Address
      description: Get a Emergency Service Address
      operationId: get-emergency-service
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    put:
      tags:
      - platform
      summary: Update Emergency Service Address
      description: Update a Emergency Service Address
      operationId: update-emergency-service
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    post:
      tags:
      - platform
      summary: Create Emergency Service Address
      description: "Create Emergency Service Address\n\nEmergency Service Address allows you to set any physical address in the United States as your address to be transmitted on emergency number calls.\nThis means your calls to the emergency number will route to the closest PSAP (Public Safety Answering Point) to your registered address on our system. \n\nThat address will also appear on the emergency services operator’s screen when you call.\n"
      operationId: create-emergency-service
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
    delete:
      tags:
      - platform
      summary: Delete Emergency Service Address
      description: Delete a Emergency Service Address
      operationId: delete-emergency-service
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /numbers/2/numbers/{numberKey}/voice/emergency-service/status:
    get:
      tags:
      - platform
      summary: Get Emergency Service Address status
      description: Get a Emergency Service Address status.
      operationId: get-emergency-service-status
      parameters:
      - name: numberKey
        in: path
        description: Unique ID of a number.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: E9FCDCA496035F08EEA5933702EDF745
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddressStatus'
        '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: Emergency Service Address 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.
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /number-registration/1/brands:
    get:
      tags:
      - platform
      summary: Get Brands
      description: Get a page of brands, using query parameters to filter results.
      operationId: get-brands
      parameters:
      - name: id
        in: query
        description: Filters brands to those that match the supplied ID(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: type
        in: query
        description: Filters brands to those that match the supplied brand types(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nameLike
        in: query
        description: Filters brands to those whose names contain the supplied name.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: referenceId
        in: query
        description: Filters brands to those that match the supplied referenceId(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: applicationId
        in: query
        description: Filters brands to those whose application ID contains the supplied value.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        description: Filters brands to those whose entity ID contains the supplied value.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - 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
      - name: size
        in: query
        description: Number of records per page (0..2000). The default value is 20. The maximum value is 2000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: ''id'', ''name'', ''type'', ''createdDate'', ''lastModifiedDate''.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: createdDate,desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrand'
              examples:
                Example page of brands:
                  summary: Example page of brands
                  description: Example page of brands
                  value:
                    results:
                    - id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                      applicationId: app-id
                      entityId: entity-id
                      name: Examples Warehouse
                      stage: SUBMITTED
                      website: https://www.example.com
                      createdDate: '2021-01-19T16:17:14Z'
                      lastModifiedDate: '2021-01-19T16:17:14Z'
                      referenceId: customer-defined-identifier
                      legalName: Examples Warehouse LLC
                      address:
                        city: Seattle
                        state: WA
                        street: 56486 915th Street
                        zipCode: '98061'
                      countryCode: US
                      alternateBusinessId:
                        id: '858020355'
                        type: DUNS
                      supportEmail: help@example.com
                      supportPhone: '41785473249'
                      vertical: RETAIL_AND_CONSUMER_PRODUCTS
                      taxId: 62-4161762
                      taxIdIssuingCountry: US
                      type: TENDLC_PRIVATE_COMPANY
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create Brand
      description: Creates a brand within the Infobip platform. This operation does not register the brand with any registrars. Registration can be done using created brand's ID with the 'Register Brand' endpoint.
      operationId: create-brand
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
            examples:
              10DLC Non Profit Brand:
                summary: 10DLC Non Profit Brand
                description: 10DLC Non Profit Brand
                value:
                  name: Example Non Profit Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_NON_PROFIT
                  referenceId: customer-defined-identifier
                  legalName: Examples Warehouse LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: 590900O3Z29E78HVXT56
                    type: LEI
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: NON_PROFIT_ORGANIZATION
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              10DLC Private Company Brand:
                summary: 10DLC Private Company Brand
                description: 10DLC Private Company Brand
                value:
                  name: Example Private Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_PRIVATE_COMPANY
                  referenceId: customer-defined-identifier
                  legalName: Examples Warehouse LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: '858020355'
                    type: DUNS
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: AGRICULTURE
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              10DLC Public Company Brand:
                summary: 10DLC Public Company Brand
                description: 10DLC Public Company Brand
                value:
                  name: Example Public Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_PUBLIC_COMPANY
                  referenceId: customer-defined-identifier
                  legalName: Examples Construction LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: N9R4GC.STJGQ.ME.163
                    type: GIIN
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: CONSTRUCTION_AND_MATERIALS
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
                  stockExchange: EXWH
                  stockSymbol: nyse
              10DLC Government Brand:
                summary: 10DLC Government Brand
                description: 10DLC Government Brand
                value:
                  name: Example Government Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_GOVERNMENT
                  referenceId: customer-defined-identifier
                  legalName: Examples Education LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: '858020355'
                    type: DUNS
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: EDUCATION
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              TFN Brand:
                summary: TFN Brand
                description: TFN Brand
                value:
                  name: Example toll free number brand
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TOLL_FREE_NUMBER
                  referenceId: customer-defined-identifier
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  businessContactFirstName: First Name
                  businessContactLastName: Last Name
                  businessDBA: Example DBA name
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
                  legalEntityType: PRIVATE_COMPANY
                  businessRegistrationType: EIN
                  legalName: Example legal name
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              description: The URI location of the created resource.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
              examples:
                10DLC Non Profit Brand:
                  summary: 10DLC Non Profit Brand
                  description: 10DLC Non Profit Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Non Profit Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Warehouse LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: 590900O3Z29E78HVXT56
                      type: LEI
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: NON_PROFIT_ORGANIZATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_NON_PROFIT
                10DLC Private Company Brand:
                  summary: 10DLC Private Company Brand
                  description: 10DLC Private Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Private Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Agroculture LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: AGRICULTURE
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_PRIVATE_COMPANY
                10DLC Public Company Brand:
                  summary: 10DLC Public Company Brand
                  description: 10DLC Public Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Public Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Construction LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: N9R4GC.STJGQ.ME.163
                      type: GIIN
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactEmail: employee.name@example.com
                    vertical: CONSTRUCTION_AND_MATERIALS
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    stockExchange: EXWH
                    stockSymbol: nyse
                    type: TENDLC_PUBLIC_COMPANY
                10DLC Government Brand:
                  summary: 10DLC Government Brand
                  description: 10DLC Government Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Government Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Education
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: EDUCATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_GOVERNMENT
                TFN Brand:
                  summary: TFN Brand
                  description: TFN Brand
                  value:
                    id: d9073f3f-3006-4dcb-9d05-41405aa96346
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Toll Free Number Brand
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactFirstName: First Name
                    businessContactLastName: Last Name
                    businessDBA: Example DBA name
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    legalEntityType: PRIVATE_COMPANY
                    businessRegistrationType: EIN
                    legalName: Example legal name
                    type: TOLL_FREE_NUMBER
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}:
    get:
      tags:
      - platform
      summary: Get Brand
      description: Retrieves a previously created brand by its ID.
      operationId: get-brand
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
              examples:
                10DLC Non Profit Brand:
                  summary: 10DLC Non Profit Brand
                  description: 10DLC Non Profit Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Non Profit Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Warehouse LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: 590900O3Z29E78HVXT56
                      type: LEI
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: NON_PROFIT_ORGANIZATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_NON_PROFIT
                10DLC Private Company Brand:
                  summary: 10DLC Private Company Brand
                  description: 10DLC Private Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Private Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Agroculture LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: AGRICULTURE
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_PRIVATE_COMPANY
                10DLC Public Company Brand:
                  summary: 10DLC Public Company Brand
                  description: 10DLC Public Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Public Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Construction LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: N9R4GC.STJGQ.ME.163
                      type: GIIN
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactEmail: employee.name@example.com
                    vertical: CONSTRUCTION_AND_MATERIALS
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    stockExchange: EXWH
                    stockSymbol: nyse
                    type: TENDLC_PUBLIC_COMPANY
                10DLC Government Brand:
                  summary: 10DLC Government Brand
                  description: 10DLC Government Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Government Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Education
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: EDUCATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_GOVERNMENT
                TFN Brand:
                  summary: TFN Brand
                  description: TFN Brand
                  value:
                    id: d9073f3f-3006-4dcb-9d05-41405aa96346
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Toll Free Number Brand
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactFirstName: First Name
                    businessContactLastName: Last Name
                    businessDBA: Example DBA name
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    legalEntityType: PRIVATE_COMPANY
                    businessRegistrationType: EIN
                    legalName: Example legal name
                    type: TOLL_FREE_NUMBER
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update Brand
      description: 'Updates a brand that has not yet been registered within the Infobip platform (response 200) or that has a successful or failed registration

        (response 202). This method will not support a brand update with pending registration status and will return a 400 Bad Request.

        Also for successfully registered brands, updates to the legalName, type, taxId, and taxIdIssuingCountry are restricted

        and will also return a 400 Bad Request.'
      operationId: update-brand
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
            examples:
              10DLC Non Profit Brand:
                summary: 10DLC Non Profit Brand
                description: 10DLC Non Profit Brand
                value:
                  name: Example Non Profit Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_NON_PROFIT
                  referenceId: customer-defined-identifier
                  legalName: Examples Warehouse LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: 590900O3Z29E78HVXT56
                    type: LEI
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: NON_PROFIT_ORGANIZATION
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              10DLC Private Company Brand:
                summary: 10DLC Private Company Brand
                description: 10DLC Private Company Brand
                value:
                  name: Example Private Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_PRIVATE_COMPANY
                  referenceId: customer-defined-identifier
                  legalName: Examples Warehouse LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: '858020355'
                    type: DUNS
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: AGRICULTURE
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              10DLC Public Company Brand:
                summary: 10DLC Public Company Brand
                description: 10DLC Public Company Brand
                value:
                  name: Example Public Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_PUBLIC_COMPANY
                  referenceId: customer-defined-identifier
                  legalName: Examples Construction LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: N9R4GC.STJGQ.ME.163
                    type: GIIN
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: CONSTRUCTION_AND_MATERIALS
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
                  stockExchange: EXWH
                  stockSymbol: nyse
              10DLC Government Brand:
                summary: 10DLC Government Brand
                description: 10DLC Government Brand
                value:
                  name: Example Government Company
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TENDLC_GOVERNMENT
                  referenceId: customer-defined-identifier
                  legalName: Examples Education LLC
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  alternateBusinessId:
                    id: '858020355'
                    type: DUNS
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  vertical: EDUCATION
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
              TFN Brand:
                summary: TFN Brand
                description: TFN Brand
                value:
                  name: Example toll free number brand
                  applicationId: app-id
                  entityId: entity-id
                  website: https://www.example.com
                  type: TOLL_FREE_NUMBER
                  referenceId: customer-defined-identifier
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  countryCode: US
                  supportEmail: help@example.com
                  supportPhone: '41785473249'
                  businessContactFirstName: First Name
                  businessContactLastName: Last Name
                  businessDBA: Example DBA name
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
                  legalEntityType: PRIVATE_COMPANY
                  businessRegistrationType: EIN
                  legalName: Example legal name
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
              examples:
                10DLC Non Profit Brand:
                  summary: 10DLC Non Profit Brand
                  description: 10DLC Non Profit Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Non Profit Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Warehouse LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: 590900O3Z29E78HVXT56
                      type: LEI
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: NON_PROFIT_ORGANIZATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_NON_PROFIT
                10DLC Private Company Brand:
                  summary: 10DLC Private Company Brand
                  description: 10DLC Private Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Private Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Agroculture LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: AGRICULTURE
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_PRIVATE_COMPANY
                10DLC Public Company Brand:
                  summary: 10DLC Public Company Brand
                  description: 10DLC Public Company Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Public Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Construction LLC
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: N9R4GC.STJGQ.ME.163
                      type: GIIN
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactEmail: employee.name@example.com
                    vertical: CONSTRUCTION_AND_MATERIALS
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    stockExchange: EXWH
                    stockSymbol: nyse
                    type: TENDLC_PUBLIC_COMPANY
                10DLC Government Brand:
                  summary: 10DLC Government Brand
                  description: 10DLC Government Brand
                  value:
                    id: 79ff0424-7201-45ca-bcbe-9989535fa2ec
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Government Company
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    legalName: Examples Education
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    alternateBusinessId:
                      id: '858020355'
                      type: DUNS
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    vertical: EDUCATION
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    type: TENDLC_GOVERNMENT
                TFN Brand:
                  summary: TFN Brand
                  description: TFN Brand
                  value:
                    id: d9073f3f-3006-4dcb-9d05-41405aa96346
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Toll Free Number Brand
                    stage: SUBMITTED
                    website: https://www.example.com
                    createdDate: '2021-01-19T16:17:14Z'
                    lastModifiedDate: '2021-01-19T16:17:14Z'
                    referenceId: customer-defined-identifier
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    countryCode: US
                    supportEmail: help@example.com
                    supportPhone: '41785473249'
                    businessContactFirstName: First Name
                    businessContactLastName: Last Name
                    businessDBA: Example DBA name
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    legalEntityType: PRIVATE_COMPANY
                    businessRegistrationType: EIN
                    legalName: Example legal name
                    type: TOLL_FREE_NUMBER
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete Brand
      description: 'Removes a previously created brand by its ID.

        This operation is only supported if all associated campaigns are in a stage that allows deletion (applies to vetted and non-vetted brands).

        '
      operationId: delete-brand
      parameters:
      - name: brandId
        in: path
        description: The ID of the brand to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the brand to delete.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/register:
    post:
      tags:
      - platform
      summary: Register Brand
      description: 'Registers the brand with the given ID with all available registrars. Each registered brand incurs a cost, consult your contract for pricing details.

        When registering brands of type TENDLC_PUBLIC_COMPANY brands, brand authentication+ verification are automatically triggered.

        This is only available for 10DLC Brands'
      operationId: register-brand
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/registrar-statuses:
    get:
      tags:
      - platform
      summary: Get Brand Registrar Statuses
      description: Retrieves status of a registered brand for each registrar.
      operationId: get-brand-registrar-statuses
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStatus'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/brand-auth-verification:
    post:
      tags:
      - platform
      summary: Request Brand Authentication+ Verification
      description: 'Request brand authentication+ verification to finalize brand registration process.

        This operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is not in progress.'
      operationId: brand-auth-verification
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/resend2fa:
    post:
      tags:
      - platform
      summary: Resend 2FA Email For Brand Authentication
      description: 'Resend 2FA email to proceed with Brand authentication.

        This operation can be executed for TENDLC_PUBLIC_COMPANY brand type only when Brand authentication is in progress.

        In 2 hour time window can resend only one 2FA email.'
      operationId: resend-2fa-mail-brand-auth
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/appeal:
    post:
      tags:
      - platform
      summary: Submit Brand Identity Appeal
      description: 'Submit an appeal for a 10DLC brand with REJECTED registration status.

        Appeal can be submitted inside 45 calendar days after rejection happen.

        Only one pending appeal per brand is allowed at a time.

        Charges apply only if the appeal is processed by TCR. Appeals rejected internally are not charged and can be resubmitted.'
      operationId: submit-brand-appeal
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealRequest'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/appeals:
    get:
      tags:
      - platform
      summary: Get Brand Appeals
      description: Retrieves the list of all appeals submitted for the specified brand.
      operationId: get-brand-appeals
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealsResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/vets:
    get:
      tags:
      - platform
      summary: Get Brand Vets
      description: Retrieves all vets done for the brand with the given ID.
      operationId: get-brand-vets
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      - 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
      - name: size
        in: query
        description: Number of records per page (0..2000). The default value is 20. The maximum value is 2000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: ''vetId'', ''type'', ''vettedDate'', ''enhancedVettedDate''.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: vettedDate,desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrandVet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Vet Brand
      description: 'Vets the brand with the given ID. Vetting a brand may only be performed once every 30 days.

        Can be created as vet type standard or enhanced.

        Each vet of a brand incurs a cost, consult your contract for pricing information.'
      operationId: vet-brand
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/vets/{vetId}:
    get:
      tags:
      - platform
      summary: Get Brand Vet
      description: Retrieves brand vet done for the brand with the given ID.
      operationId: get-brand-vet
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      - name: vetId
        in: path
        description: The ID of the desired vet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired vet.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update Brand Vet
      description: 'Updates a brand vetting type.

        Provided vet must be current active standard vet and it may only be updated to an enhanced vet if it was performed within the last 30 days.

        All other attempts to update a vet are considered an error.'
      operationId: update-brand-vet
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      - name: vetId
        in: path
        description: The ID of the brand active vet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the brand active vet.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/vets/import:
    put:
      tags:
      - platform
      summary: Import Existing Brand Vet
      description: Imports Existing Brand Vet provider
      operationId: import-existing-brand-vet
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/brands/{brandId}/vets/{vetId}/report:
    get:
      tags:
      - platform
      summary: Get Brand Enhanced Vet Report
      description: Retrieves brand enhanced vet report by given vetId.
      operationId: get-brand-enhanced-vet-report
      parameters:
      - name: brandId
        in: path
        description: The ID of the desired brand.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired brand.
      - name: vetId
        in: path
        description: The ID of the desired vet.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired vet.
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              description: PDF file name.
              style: simple
              explode: false
              schema:
                type: string
            Content-Length:
              description: PDF file size.
              style: simple
              explode: false
              schema:
                type: integer
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns:
    get:
      tags:
      - platform
      summary: Get Campaigns
      description: Gets a page of campaigns, using query parameters to filter results.
      operationId: get-campaigns
      parameters:
      - name: id
        in: query
        description: Filters campaigns to those that match the supplied ID(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: brandId
        in: query
        description: Filters campaigns to those that match the supplied brand ID(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            format: uuid
      - name: type
        in: query
        description: Filters campaigns to those that match the supplied campaign type(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: nameLike
        in: query
        description: Filters campaigns to those whose names contain the supplied name.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: referenceId
        in: query
        description: Filters campaigns to those that match the supplied referenceId(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: applicationId
        in: query
        description: Filters campaigns to those whose application ID contains the supplied value.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: entityId
        in: query
        description: Filters campaigns to those whose entity ID contains the supplied value.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: stage
        in: query
        description: Filters campaigns to those that match the campaign stage(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - name: number
        in: query
        description: Filters campaigns to those that match the number(s).
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
      - 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
      - name: size
        in: query
        description: Number of records per page (0..2000). The default value is 20. The maximum value is 2000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Sortable Properties: ''id'', ''name'', ''type'', ''createdDate'', ''lastModifiedDate''.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: createdDate,desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseCampaign'
              examples:
                10-digit long code Campaign:
                  summary: 10-digit long code Campaign
                  description: 10-digit long code Campaign
                  value:
                    results:
                    - id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                      referenceId: customer-defined-identifier
                      applicationId: app-id
                      entityId: entity-id
                      name: Example Promo
                      createdDate: '2019-08-24T14:15:22Z'
                      lastModifiedDate: '2019-08-24T14:15:22Z'
                      stage: DRAFT
                      priority:
                        priorityId: 46de4f63-390c-4253-9869-da282096691b
                        submittedDate: '2019-08-24T14:15:22Z'
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      programSummary: A mix of promotional and informational messaging.
                      customerCareEmail: examples@example.com
                      confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                      exampleMessages:
                      - Come in today and get 10% OFF today!
                      helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                      stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                      messageTypes:
                      - sms
                      - mms
                      termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                      optIns:
                        keyword:
                          callToAction: Text MESSAGE to subscribe
                          keywords:
                          - MESSAGE
                      brandPreview:
                        brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                        brandName: Examples Warehouse
                      customerCarePhone: '41785473249'
                      lowVolume: false
                      useCase: null
                      useCases:
                      - PROMOTIONAL_MARKETING
                      - EDUCATION
                      externalCampaignId: null
                      numberKeys:
                      - 2C958BA98F9EBACA4F9357D81BFBF47B
                      numberPreviews:
                      - numberKey: 2C958BA98F9EBACA4F9357D81BFBF47B
                        number: '41793026727'
                        countryCode: US
                      ageGated: true
                      directLending: false
                      embeddedLink: true
                      embeddedPhone: false
                      type: TEN_DIGIT_LONG_CODE
                      policy: STANDARD
                      campaignFeedback:
                        rejectionReasons:
                        - Example rejection reason 1
                        - Example rejection reason 2
                        rejectionDate: '2019-08-24T14:15:22Z'
                      appealData:
                        appealReason: Example appeal reason
                        appealDate: '2019-08-24T14:15:22Z'
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
                External 10-digit long code Campaign:
                  summary: External 10-digit long code Campaign
                  description: External 10-digit long code Campaign
                  value:
                    results:
                    - id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                      referenceId: customer-defined-identifier
                      applicationId: default
                      name: Example Promo
                      createdDate: '2019-08-24T14:15:22Z'
                      lastModifiedDate: '2019-08-24T14:15:22Z'
                      stage: REGISTERED
                      priority:
                        priorityId: 46de4f63-390c-4253-9869-da282096691b
                        submittedDate: '2019-08-24T14:15:22Z'
                      externalCampaignId: CAM1234
                      numberKeys:
                      - D79C1785A82A2BC6FC0B867DCD055215
                      numberPreviews:
                      - numberKey: D79C1785A82A2BC6FC0B867DCD055215
                        number: '41793026727'
                        countryCode: US
                      type: EXTERNAL_TEN_DIGIT_LONG_CODE
                      policy: STANDARD
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
                TFN Campaign:
                  summary: TFN Campaign
                  description: TFN Campaign
                  value:
                    results:
                    - id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                      referenceId: customer-defined-identifier
                      applicationId: app-id
                      entityId: entity-id
                      name: Example Promo
                      createdDate: '2019-08-24T14:15:22Z'
                      lastModifiedDate: '2019-08-24T14:15:22Z'
                      stage: REGISTERED
                      priority:
                        priorityId: 46de4f63-390c-4253-9869-da282096691b
                        submittedDate: '2019-08-24T14:15:22Z'
                      campaignFeedback: null
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandPreview:
                        brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                        brandName: Example brand
                      appealData: null
                      privacyPolicyUrl: https://www.example.com/privacy-policy
                      termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                      messageVolume: HUNDRED
                      numberKeys:
                      - 8CE2738191F7F06F84E5417579D41D74
                      numberPreviews:
                      - numberKey: 8CE2738191F7F06F84E5417579D41D74
                        number: '18007321000'
                        countryCode: UF
                      useCase: APP_NOTIFICATIONS
                      programSummary: A mix of promotional and informational messaging.
                      exampleMessage: Come in today and get 10% OFF today!
                      optIns:
                        keyword:
                          callToAction: Text MESSAGE to subscribe
                          keywords:
                          - MESSAGE
                      optInImageURLs:
                      - https://www.example.com
                      additionalInformation: Example additional info
                      customerCareEmail: examples@example.com
                      type: TOLL_FREE_NUMBER
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create Campaign
      description: Creates a campaign within the Infobip platform. This operation does not register the campaign with any networks. Registration can be done using created campaign's ID with the 'Register Campaign' endpoint.
      operationId: create-campaign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
            examples:
              10-digit long code Campaign:
                summary: 10-digit long code Campaign
                description: 10-digit long code Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: TEN_DIGIT_LONG_CODE
                  applicationId: app-id
                  entityId: entity-id
                  name: Example Promo
                  numbers:
                  - '41785473249'
                  brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                  confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                  customerCarePhone: '41785473249'
                  customerCareEmail: examples@example.com
                  exampleMessages:
                  - Come in today and get 10% OFF today!
                  helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                  lowVolume: false
                  messageTypes:
                  - SMS
                  - MMS
                  programSummary: A mix of promotional and informational messaging.
                  stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                  termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                  useCases:
                  - PROMOTIONAL_MARKETING
                  - EDUCATION
                  optIns:
                    keyword:
                      callToAction: Text MESSAGE to subscribe to recurring promotional marketing alerts. Msg&DataRates may apply. Text HELP for help, STOP to opt out. Terms and PP https://www.example.om/terms-of-service/
                      keywords:
                      - MESSAGE
                  ageGated: true
                  directLending: false
                  embeddedLink: true
                  embeddedPhone: false
              External 10-digit long code Campaign:
                summary: External 10-digit long code Campaign
                description: External 10-digit long code Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: EXTERNAL_TEN_DIGIT_LONG_CODE
                  name: Example Promo
                  numbers:
                  - '41785473249'
                  externalCampaignId: CAM1234
              TFN Campaign:
                summary: TFN Campaign
                description: TFN Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: TOLL_FREE_NUMBER
                  applicationId: app-id
                  entityId: entity-id
                  name: Example Promo
                  numbers:
                  - '18007321000'
                  brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                  programSummary: A mix of promotional and informational messaging.
                  customerCareEmail: examples@example.com
                  exampleMessage: Come in today and get 10% OFF today!
                  privacyPolicyUrl: https://www.example.com/privacy-policy
                  termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                  messageVolume: HUNDRED
                  useCase: APP_NOTIFICATIONS
                  optIns:
                    keyword:
                      callToAction: Text MESSAGE to subscribe
                      keywords:
                      - MESSAGE
                  optInImageURLs:
                  - https://www.example.com
                  additionalInformation: Example additional info
                  customerCarePhone: '41785473249'
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              description: The URI location of the created resource.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
              examples:
                10-digit long code Campaign:
                  summary: 10-digit long code Campaign
                  description: 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                    exampleMessages:
                    - Come in today and get 10% OFF today!
                    helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                    stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                    messageTypes:
                    - sms
                    - mms
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    customerCarePhone: '41785473249'
                    lowVolume: false
                    useCase: null
                    useCases:
                    - PROMOTIONAL_MARKETING
                    - EDUCATION
                    externalCampaignId: null
                    numberKeys:
                    - 2C958BA98F9EBACA4F9357D81BFBF47B
                    numberPreviews:
                    - numberKey: 2C958BA98F9EBACA4F9357D81BFBF47B
                      number: '41793026727'
                      countryCode: US
                    ageGated: true
                    directLending: false
                    embeddedLink: true
                    embeddedPhone: false
                    type: TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
                External 10-digit long code Campaign:
                  summary: External 10-digit long code Campaign
                  description: External 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: default
                    entityId: ''
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: REGISTERED
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    externalCampaignId: CAM1234
                    numberKeys:
                    - D79C1785A82A2BC6FC0B867DCD055215
                    numberPreviews:
                    - numberKey: D79C1785A82A2BC6FC0B867DCD055215
                      number: '41793026727'
                      countryCode: US
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    type: EXTERNAL_TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                TFN Campaign:
                  summary: TFN Campaign
                  description: TFN Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    exampleMessage: Come in today and get 10% OFF today!
                    privacyPolicyUrl: https://www.example.com/privacy-policy
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    messageVolume: HUNDRED
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    optInImageURLs:
                    - https://www.example.com
                    additionalInformation: Example additional info
                    customerCarePhone: '41785473249'
                    useCase: APP_NOTIFICATIONS
                    numberKeys:
                    - 8CE2738191F7F06F84E5417579D41D74
                    numberPreviews:
                    - numberKey: 8CE2738191F7F06F84E5417579D41D74
                      number: '18007321000'
                      countryCode: UF
                    type: TOLL_FREE_NUMBER
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/toll-free:
    post:
      tags:
      - platform
      summary: Create Toll Free Campaign
      description: Creates a toll free campaign within the Infobip platform.
      operationId: create-toll-free-campaign
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel'
            examples:
              TFN Campaign:
                summary: TFN Campaign
                description: TFN Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: TOLL_FREE_UNIFIED_NUMBER
                  applicationId: app-id
                  entityId: entity-id
                  name: Example Promo
                  numbers:
                  - '18007321000'
                  exampleMessage: Come in today and get 10% OFF today!
                  programSummary: A mix of promotional and informational messaging.
                  termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                  privacyPolicyUrl: https://www.example.com/privacy-policy
                  useCase: APP_NOTIFICATIONS
                  optIns:
                    keyword:
                      callToAction: Text MESSAGE to subscribe
                      keywords:
                      - MESSAGE
                  messageVolume: HUNDRED
                  optInImageURLs:
                  - https://www.example.com/terms-and-conditions
                  additionalInformation: Example additional information
                  customerCareEmail: examples@example.com
                  countryCode: US
                  address:
                    city: Seattle
                    state: WA
                    street: 56486 915th Street
                    zipCode: '98061'
                  supportPhone: '1234567890'
                  supportEmail: example@example.com
                  businessContactFirstName: First Name
                  businessContactLastName: Last Name
                  businessDBA: Example DBA name
                  businessName: Example business name
                  legalName: Example legal name
                  businessWebsite: https://www.example.com
                  taxId: 62-4161762
                  taxIdIssuingCountry: US
                  legalEntityType: PRIVATE_COMPANY
                  businessRegistrationType: EIN
        required: true
      responses:
        '201':
          description: Created
          headers:
            Location:
              description: The URI location of the created resource.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel'
              examples:
                TFN Campaign:
                  summary: TFN Campaign
                  description: TFN Campaign
                  value:
                    id: 2e13b58f-e8d1-45a1-bc67-efc834e2b146
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example toll free unified number campaign
                    createdDate: '2025-06-30T15:38:40Z'
                    lastModifiedDate: '2025-06-30T15:38:41Z'
                    stage: SUBMITTED_FOR_REVIEW
                    priority:
                      priorityId: null
                      submittedDate: '2025-06-30T15:38:41Z'
                    campaignFeedback: null
                    privacyPolicyUrl: https://www.example.com/privacy-policy
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    messageVolume: HUNDRED
                    numberKeys:
                    - 8CE2738191F7F06F84E5417579D41D74
                    numberPreviews:
                    - numberKey: 8CE2738191F7F06F84E5417579D41D74
                      number: '18007321000'
                      countryCode: UF
                    useCase: APP_NOTIFICATIONS
                    programSummary: A mix of promotional and informational messaging.
                    exampleMessage: Come in today and get 10% OFF today!
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    optInImageURLs:
                    - https://www.example.com
                    additionalInformation: Example additional information
                    countryCode: US
                    address:
                      city: Seattle
                      state: WA
                      street: 56486 915th Street
                      zipCode: '98061'
                    supportPhone: '1234567890'
                    supportEmail: email@example.com
                    businessContactFirstName: First Name
                    businessContactLastName: Last Name
                    businessDBA: Example Business DBA
                    businessName: Example Business Name
                    legalName: Example legal name
                    businessWebsite: https://www.example.com
                    customerCareEmail: customercare@example.com
                    taxId: 62-4161762
                    taxIdIssuingCountry: US
                    legalEntityType: PRIVATE_COMPANY
                    businessRegistrationType: EIN
                    type: TOLL_FREE_UNIFIED_NUMBER
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}:
    get:
      tags:
      - platform
      summary: Get Campaign
      description: Retrieves a previously created campaign by its ID.
      operationId: get-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
              examples:
                10-digit long code Campaign:
                  summary: 10-digit long code Campaign
                  description: 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                    exampleMessages:
                    - Come in today and get 10% OFF today!
                    helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                    stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                    messageTypes:
                    - sms
                    - mms
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    customerCarePhone: '41785473249'
                    lowVolume: false
                    useCase: null
                    useCases:
                    - PROMOTIONAL_MARKETING
                    - EDUCATION
                    externalCampaignId: null
                    numberKeys:
                    - 2C958BA98F9EBACA4F9357D81BFBF47B
                    numberPreviews:
                    - numberKey: 2C958BA98F9EBACA4F9357D81BFBF47B
                      number: '41793026727'
                      countryCode: US
                    ageGated: true
                    directLending: false
                    embeddedLink: true
                    embeddedPhone: false
                    type: TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
                External 10-digit long code Campaign:
                  summary: External 10-digit long code Campaign
                  description: External 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: default
                    entityId: ''
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: REGISTERED
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    externalCampaignId: CAM1234
                    numberKeys:
                    - D79C1785A82A2BC6FC0B867DCD055215
                    numberPreviews:
                    - numberKey: D79C1785A82A2BC6FC0B867DCD055215
                      number: '41793026727'
                      countryCode: US
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    type: EXTERNAL_TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                TFN Campaign:
                  summary: TFN Campaign
                  description: TFN Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    exampleMessage: Come in today and get 10% OFF today!
                    privacyPolicyUrl: https://www.example.com/privacy-policy
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    messageVolume: HUNDRED
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    optInImageURLs:
                    - https://www.example.com
                    additionalInformation: Example additional info
                    customerCarePhone: '41785473249'
                    useCase: APP_NOTIFICATIONS
                    numberKeys:
                    - 8CE2738191F7F06F84E5417579D41D74
                    numberPreviews:
                    - numberKey: 8CE2738191F7F06F84E5417579D41D74
                      number: '18007321000'
                      countryCode: UF
                    type: TOLL_FREE_NUMBER
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    put:
      tags:
      - platform
      summary: Update Campaign
      description: Updates a campaign that has not yet been registered within the Infobip platform or has been rejected by Infobip. This operation is only supported for campaigns that are in DRAFT or REJECTED stage.
      operationId: update-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
            examples:
              10-digit long code Campaign:
                summary: 10-digit long code Campaign
                description: 10-digit long code Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: TEN_DIGIT_LONG_CODE
                  applicationId: app-id
                  entityId: entity-id
                  name: Example Promo
                  numbers:
                  - '41785473249'
                  brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                  confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                  customerCarePhone: '41785473249'
                  customerCareEmail: examples@example.com
                  exampleMessages:
                  - Come in today and get 10% OFF today!
                  helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                  lowVolume: false
                  messageTypes:
                  - SMS
                  - MMS
                  programSummary: A mix of promotional and informational messaging.
                  stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                  termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                  useCases:
                  - PROMOTIONAL_MARKETING
                  - EDUCATION
                  optIns:
                    keyword:
                      callToAction: Text MESSAGE to subscribe to recurring promotional marketing alerts. Msg&DataRates may apply. Text HELP for help, STOP to opt out. Terms and PP https://www.example.om/terms-of-service/
                      keywords:
                      - MESSAGE
                  ageGated: true
                  directLending: false
                  embeddedLink: true
                  embeddedPhone: false
              External 10-digit long code Campaign:
                summary: External 10-digit long code Campaign
                description: External 10-digit long code Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: EXTERNAL_TEN_DIGIT_LONG_CODE
                  name: Example Promo
                  numbers:
                  - '41785473249'
                  externalCampaignId: CAM1234
              TFN Campaign:
                summary: TFN Campaign
                description: TFN Campaign
                value:
                  referenceId: customer-defined-identifier
                  type: TOLL_FREE_NUMBER
                  applicationId: app-id
                  entityId: entity-id
                  name: Example Promo
                  numbers:
                  - '18007321000'
                  brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                  programSummary: A mix of promotional and informational messaging.
                  customerCareEmail: examples@example.com
                  exampleMessage: Come in today and get 10% OFF today!
                  privacyPolicyUrl: https://www.example.com/privacy-policy
                  termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                  messageVolume: HUNDRED
                  useCase: APP_NOTIFICATIONS
                  optIns:
                    keyword:
                      callToAction: Text MESSAGE to subscribe
                      keywords:
                      - MESSAGE
                  optInImageURLs:
                  - https://www.example.com
                  additionalInformation: Example additional info
                  customerCarePhone: '41785473249'
        required: true
      responses:
        '200':
          description: OK
          headers:
            Location:
              description: The URI location of the created resource.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
              examples:
                10-digit long code Campaign:
                  summary: 10-digit long code Campaign
                  description: 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    confirmationMessage: Example promotional-marketing. Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                    exampleMessages:
                    - Come in today and get 10% OFF today!
                    helpMessage: 'Example promotional-marketing: Help at textsupport@example.com or 18889997777. Msg&data rates may apply. Reply STOP to cancel.'
                    stopMessage: 'Example promotional-marketing: You have been unsubscribed, no more messages will be sent.'
                    messageTypes:
                    - sms
                    - mms
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    customerCarePhone: '41785473249'
                    lowVolume: false
                    useCase: null
                    useCases:
                    - PROMOTIONAL_MARKETING
                    - EDUCATION
                    externalCampaignId: null
                    numberKeys:
                    - 2C958BA98F9EBACA4F9357D81BFBF47B
                    numberPreviews:
                    - numberKey: 2C958BA98F9EBACA4F9357D81BFBF47B
                      number: '41793026727'
                      countryCode: US
                    ageGated: true
                    directLending: false
                    embeddedLink: true
                    embeddedPhone: false
                    type: TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
                External 10-digit long code Campaign:
                  summary: External 10-digit long code Campaign
                  description: External 10-digit long code Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: default
                    entityId: ''
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: REGISTERED
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    externalCampaignId: CAM1234
                    numberKeys:
                    - D79C1785A82A2BC6FC0B867DCD055215
                    numberPreviews:
                    - numberKey: D79C1785A82A2BC6FC0B867DCD055215
                      number: '41793026727'
                      countryCode: US
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    type: EXTERNAL_TEN_DIGIT_LONG_CODE
                    policy: STANDARD
                TFN Campaign:
                  summary: TFN Campaign
                  description: TFN Campaign
                  value:
                    id: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    referenceId: customer-defined-identifier
                    applicationId: app-id
                    entityId: entity-id
                    name: Example Promo
                    createdDate: '2019-08-24T14:15:22Z'
                    lastModifiedDate: '2019-08-24T14:15:22Z'
                    stage: DRAFT
                    priority:
                      priorityId: 46de4f63-390c-4253-9869-da282096691b
                      submittedDate: '2019-08-24T14:15:22Z'
                    brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                    brandPreview:
                      brandId: a0c63335-f841-4d43-9ef8-e0765a233f29
                      brandName: Examples Warehouse
                    programSummary: A mix of promotional and informational messaging.
                    customerCareEmail: examples@example.com
                    exampleMessage: Come in today and get 10% OFF today!
                    privacyPolicyUrl: https://www.example.com/privacy-policy
                    termsAndConditionsUrl: https://www.example.com/terms-and-conditions
                    messageVolume: HUNDRED
                    optIns:
                      keyword:
                        callToAction: Text MESSAGE to subscribe
                        keywords:
                        - MESSAGE
                    optInImageURLs:
                    - https://www.example.com
                    additionalInformation: Example additional info
                    customerCarePhone: '41785473249'
                    useCase: APP_NOTIFICATIONS
                    numberKeys:
                    - 8CE2738191F7F06F84E5417579D41D74
                    numberPreviews:
                    - numberKey: 8CE2738191F7F06F84E5417579D41D74
                      number: '18007321000'
                      countryCode: UF
                    type: TOLL_FREE_NUMBER
                    campaignFeedback:
                      rejectionReasons:
                      - Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                      - This is a custom rejection reason provided by a reviewer.
                      rejectionDetails:
                      - errorCode: '1001'
                        description: Campaign appears to be for an age-gated content type but age gate attribute is not selected.
                        recommendedAction: Verify if the Age Gate attribute is selected for the campaign registration. If the campaign is not related to age-gated content, update the campaign description.
                      - errorCode: '9999'
                        description: This is a custom rejection reason provided by a reviewer.
                        recommendedAction: null
                      rejectionDate: '2019-08-23T14:15:22Z'
                    appealData:
                      appealReason: Example appeal reason
                      appealDate: '2019-08-24T14:15:22Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete Campaign
      description: 'Removes a previously created campaign by its ID.

        This operation is only supported for campaigns that are in DRAFT, DEREGISTERED or REJECTED stage.

        '
      operationId: delete-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the campaign to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the campaign to delete.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/register:
    post:
      tags:
      - platform
      summary: Submit Campaign
      description: Submits the campaign with the given ID for Infobip review. If a campaign gets approved by Infobip, it will get registered with carriers, and submitted for underlying connectivity provider's review. Each registered campaign incurs a cost, consult your contract for pricing information.
      externalDocs:
        description: Find out more
        url: https://www.infobip.com/docs/10dlc/10dlc-registration
      operationId: register-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RegisterCampaignRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  priorityId: 3fa85f64-5717-4562-b3fc-2c963f66afa6
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/network-statuses:
    get:
      tags:
      - platform
      summary: Get Campaign Network Statuses
      description: Retrieves status of a registered campaign for each network.
      operationId: get-campaign-network-statuses
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkStatus'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - network: ATT
                    state: ACTIVE
                    messageClass: A
                    throughput: 4500
                    brandTier: null
                  - network: T_MOBILE
                    state: ACTIVE
                    messageClass: '20'
                    throughput: 2000
                    brandTier: LOW
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/deregister:
    post:
      tags:
      - platform
      summary: Deregister Campaign
      description: Deregisters the campaign with the given ID with all available networks.
      operationId: deregister-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      responses:
        '202':
          description: Accepted
        '204':
          description: Returned if campaign is already in DEREGISTERED or REGISTERED_PENDING_DEREGISTRATION stage.
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/update-registration:
    post:
      tags:
      - platform
      summary: Update Registered Campaign
      description: Updates a campaign that has already been registered. If the campaign registration has not been completed, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's "List owned number" GET endpoint.
      operationId: update-registered-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  numberKeys:
                  - 8F665E5F6582E586BA9DF4D227035298
                  - D79C1785A82A2BC6FC0B867DCD055215
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/add-numbers:
    post:
      tags:
      - platform
      summary: Add Numbers to Registered Campaign
      description: Adds numbers to campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request. Numbers which require OSR to be updated in advance could be identified by using Numbers API's "List owned number" GET endpoint.
      operationId: add-numbers
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  numberKeys:
                  - 8F665E5F6582E586BA9DF4D227035298
                  - D79C1785A82A2BC6FC0B867DCD055215
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too Many Requests
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/remove-numbers:
    post:
      tags:
      - platform
      summary: Remove Numbers from Registered Campaign
      description: Removes numbers from campaign that has already been registered. If the campaign registration has not been completed or numbers size exceeds the limit, attempting to update via this api will result in a 400 Bad Request.
      operationId: remove-numbers
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  numberKeys:
                  - 8F665E5F6582E586BA9DF4D227035298
                  - D79C1785A82A2BC6FC0B867DCD055215
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too Many Requests
          content:
            application/json:
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: TOO_MANY_REQUESTS
                        text: Too many requests
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/numbers:
    get:
      tags:
      - platform
      summary: Get Campaign numbers
      description: Retrieves all the numbers associated with a campaign, regardless of the stage, by its ID.
      operationId: get-campaign-numbers
      parameters:
      - name: campaignId
        in: path
        description: The ID of the campaign for which the numbers should be fetched.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the campaign for which the numbers should be fetched.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreviews'
              examples:
                Response example:
                  summary: Response example
                  value:
                    numberPreviews:
                    - numberKey: 2C958BA98F9EBACA4F9357D81BFBF47B
                      number: '41793026727'
                      countryCode: US
                    - numberKey: D79C1785A82A2BC6FC0B867DCD055215
                      number: '42893024539'
                      countryCode: US
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/appeal:
    post:
      tags:
      - platform
      summary: Appeal Campaign
      description: Appeals a rejected 10DLC campaign within the Infobip platform. Campaigns are eligible for appeal if they were rejected within the past 3 months and can be appealed up to five times.
      operationId: appeal-campaign
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  reason: Example appeal reason
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/priorities:
    get:
      tags:
      - platform
      summary: Get Campaign Priorities
      description: Retrieves campaign priority levels for your account(if applicable). Please contact your account manager to learn more about priorities.
      operationId: get-campaign-priorities
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Priority'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - priorityId: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                    dailySubmitLimit: 10
                    reviewTime:
                      timeUnit: HOURS
                      amount: 2
                  - priorityId: 4d3601ed-c632-4979-ae22-43854ef4ffad
                    dailySubmitLimit: 100
                    reviewTime:
                      timeUnit: DAYS
                      amount: 2
        '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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/number-pool/attach:
    post:
      tags:
      - platform
      summary: Attach Number Pool to Campaign
      description: Associates an existing number pool with a campaign. Number pooling is required when a campaign utilizes more than 49 numbers. This is common in high-throughput environments such as call centers. Attaching a number pool ensures proper provisioning and compliance with carrier requirements.
      operationId: attach-number-pool
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AttachNumberPoolRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  numberPoolId: number-pool-identifier
                  reason: Example attach reason
        required: true
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaigns/{campaignId}/number-pool/detach:
    post:
      tags:
      - platform
      summary: Detach Number Pool from Campaign
      description: 'Detaches an existing number pool from the specified campaign. This operation is subject to validation: the campaign must have fewer than 50 assigned numbers at the time of detachment.'
      operationId: detach-number-pool
      parameters:
      - name: campaignId
        in: path
        description: The ID of the desired campaign.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired campaign.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException'
              examples:
                Response example:
                  summary: Response example
                  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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/number-pools:
    get:
      tags:
      - platform
      summary: Get Owned Number Pools
      description: Returns a paginated list of number pools owned by the authenticated account.
      operationId: get-owned-number-pools
      parameters:
      - name: availability
        in: query
        description: Filters number pools to those that match the supplied availability.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolAvailability'
      - name: registrarRecordId
        in: query
        description: Filters number pools to those that match the supplied referenceId.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - 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
      - name: size
        in: query
        description: Number of records per page (0..2000). The default value is 10. The maximum value is 1000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiPageResponse'
              examples:
                Example page of owned number pools:
                  summary: Example page of owned number pools
                  description: Example page of owned number pools
                  value:
                    results:
                    - numberPoolId: number-pool-identifier-1
                      campaignId: 4d3601ed-c632-4979-ae22-43854ef4ffaf
                      campaignName: Example name
                    - numberPoolId: number-pool-identifier-2
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/documents:
    post:
      tags:
      - platform
      summary: Upload Document
      description: 'Uploads a document file to the system and returns the document metadata. The uploaded document can be used for 10DLC campaign registration purposes. Documents not attached to a campaign within 7 days will be automatically deleted. Supported file types: .bmp, .dib, .docx, .gif, .htm, .html, .jpeg, .jpg, .m2a, .m4a, .m4b, .m4p, .m4r, .m4v, .mp1, .mp2, .mp3, .mp4, .mpa, .oga, .ogg, .ogm, .ogv, .ogx, .odt, .pdf, .png, .raw, .rtf, .spx, .tif, .tiff, .txt, .wav, .webm, .xml, Maximum file size: 10MB.'
      operationId: upload-document-metadata
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UploadDocumentApiDoc'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DocumentMetadata'
              examples:
                Document metadata:
                  summary: Document metadata
                  description: Document metadata
                  value:
                    documentId: 9904751a-9436-4bda-b98a-37b1f7179483
                    documentName: Example document.pdf
                    contentType: application/pdf
                    contentLength: 14956
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.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:
      - numbers:manage
  /number-registration/1/documents/{documentId}:
    get:
      tags:
      - platform
      summary: Download Document
      description: Downloads a document file by its unique identifier. Access to the document is restricted based on account ownership.
      operationId: download-document-content
      parameters:
      - name: documentId
        in: path
        description: Unique identifier for the document.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: Unique identifier for the document.
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              description: File name.
              style: simple
              explode: false
              schema:
                type: string
            Content-Length:
              description: File size.
              style: simple
              explode: false
              schema:
                type: integer
            Content-Type:
              description: File type.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            '*/*':
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
  /number-registration/1/automatic-review/campaigns/{campaignUuid}:
    post:
      tags:
      - platform
      summary: Submit Existing Campaign for AI Review
      description: Submits an existing campaign for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more.
      operationId: submit-existing-campaign-for-ai-review
      parameters:
      - name: campaignUuid
        in: path
        description: The UUID assigned to the campaign when it was created or imported into the infobip platform. This identifier is returned during campaign creation.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID assigned to the campaign when it was created or imported into the infobip platform. This identifier is returned during campaign creation.
          example: 4d3601ed-c632-4979-ae22-43854ef4ffaf
        example: 4d3601ed-c632-4979-ae22-43854ef4ffaf
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestUuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        '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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/automatic-review:
    post:
      tags:
      - platform
      summary: Submit Campaign Info for AI Review
      description: Submits new campaign information for automatic AI compliance review. Returns a request UUID that can be used to fetch the review results. Contact your account manager to learn more.
      operationId: submit-campaign-info-for-ai-review
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest'
            examples:
              10DLC AI Review Request:
                summary: 10DLC AI Review Request
                description: 10DLC AI Review Request
                value:
                  reviewType: TEN_DIGIT_LONG_CODE
                  brandName: Example Corp
                  brandWebsite: https://www.example.com
                  brandSupportEmail: support@example.com
                  programDescription: Send marketing messages and promotional offers to opted-in users who want to hear about new products and sales.
                  messageExamples:
                  - 'Example Corp: Flash sale! 50% off all items today only. Shop now at https://example.com/sale Reply STOP to opt out'
                  customerCareEmail: care@example.com
                  termsAndConditionsUrl: https://www.example.com/terms
                  privacyPolicyUrl: https://www.example.com/privacy
                  optInMessage: Welcome to Example Corp alerts! Msg&data rates may apply. Reply HELP for help, STOP to cancel.
                  helpMessage: 'Example Corp Help: contact support@example.com or call 1-800-555-0100. Msg&data rates may apply.'
                  optOutMessage: You have been unsubscribed from Example Corp alerts. Text START to resubscribe.
                  ctaWebsite: https://www.example.com/opt-in
                  ctas:
                  - Text JOIN to 12345 to subscribe
                  - Visit https://example.com/opt-in to sign up
                  useCases:
                  - PROMOTIONAL_MARKETING
                  ageGated: false
                  directLending: false
                  messageFlow: Users opt-in via website, receive confirmation messages
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestUuid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
        '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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/automatic-review/{requestUuid}:
    get:
      tags:
      - platform
      summary: Get AI Review Results
      description: Retrieves the results of a campaign AI compliance review by its request UUID. Contact your account manager to learn more.
      operationId: get-ai-review-results
      parameters:
      - name: requestUuid
        in: path
        description: The UUID of the AI review request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the AI review request.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewResults'
              examples:
                Compliant:
                  summary: Compliant
                  description: Compliant
                  value:
                    reviewStatus: COMPLIANT
                    campaignErrors: []
                Non-Compliant:
                  summary: Non-Compliant
                  description: Non-Compliant
                  value:
                    reviewStatus: NON_COMPLIANT
                    campaignErrors:
                    - code: '1001'
                      justification: Brand name not found on website.
                      description: The brand name could not be verified on the provided website URL.
                      recommendation: Ensure the brand name is clearly displayed on the website.
                Processing:
                  summary: Processing
                  description: Processing
                  value:
                    reviewStatus: PROCESSING
                    campaignErrors: []
        '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:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaign-builder:
    post:
      tags:
      - platform
      summary: Start Campaign Builder
      description: 'Submits a request to build a campaign based on the provided brand and campaign information.

        Returns a request UUID that can be used to track the job status.'
      operationId: start-campaign-builder
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest'
            examples:
              Campaign Builder Request - 10DLC:
                summary: Campaign Builder Request - 10DLC
                description: Campaign Builder Request - 10DLC
                value:
                  brandId: 3da2f37c-fe0f-441e-ba7e-c2b4d4990069
                  campaignType: TEN_DIGIT_LONG_CODE
                  campaignIntent: Campaign should send promotion messages on seasonal discounts for loyalty club members
                  contactEmail: support@example.com
                  optInMethods:
                  - VERBAL
                  campaignAttributes:
                  - DIRECT_LENDING
              Campaign Builder Request - Short code:
                summary: Campaign Builder Request - Short code
                description: Campaign Builder Request - Short code
                value: "{\n    \"brandId\": \"dce0dd3e-829f-4ebe-a747-c93757140a50\",\n    \"campaignType\": \"SHORT_CODE\",\n    \"campaignIntent\": \"Campaign should send promotion messages on seasonal discounts for loyalty club members\",\n    \"contactEmail\": \"support@example.com\",\n    \"contactPhone\": \"1234567890\"\n    \"optInMethods\": [\"VERBAL\", \"ONLINE\"]\n}"
              Campaign Builder Request - Toll free:
                summary: Campaign Builder Request - Toll free
                description: Campaign Builder Request - Toll free
                value:
                  brandId: c37008bc-2ebc-488b-ac64-aa7cc09f551b
                  campaignType: TOLL_FREE_NUMBER
                  campaignIntent: Campaign should send promotion messages on seasonal discounts for loyalty club members
                  contactEmail: support@example.com
                  optInMethods:
                  - KEYWORD
                  - IVR
        required: true
      responses:
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestUuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890
        '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:
      - numbers:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /number-registration/1/campaign-builder/{requestUuid}:
    get:
      tags:
      - platform
      summary: Get Campaign Builder Results
      description: 'Retrieves the results of a campaign builder by its request UUID.

        The result structure varies based on the campaign type used when starting the builder.'
      operationId: get-campaign-builder-results
      parameters:
      - name: requestUuid
        in: path
        description: The UUID of the campaign builder request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The UUID of the campaign builder request.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResult'
              examples:
                Processing:
                  summary: Processing
                  description: Processing
                  value:
                    status: PROCESSING
                Completed - 10DLC:
                  summary: Completed - 10DLC
                  description: Completed - 10DLC
                  value:
                    status: COMPLETED
                    result:
                      campaignType: TEN_DIGIT_LONG_CODE
                      useCase: PROMOTIONAL_MARKETING
                      messageFlow:
                        optInMessage: Welcome to ExampleCorp Loyalty Club! Msg & data rates may apply. Get 2-4 msgs/month. Reply HELP for help, STOP to cancel. Enjoy exclusive seasonal discounts!
                        exampleMessage1: 'ExampleCorp: Winter Sale is here! Enjoy up to 50% off for loyalty members. Shop now at https://www.example.com. Reply HELP for help, STOP to cancel.'
                        exampleMessage2: 'ExampleCorp: Exclusive Spring Offer! Save 30% on your next purchase. Visit https://www.example.com to shop. Reply HELP for help, STOP to cancel.'
                        helpMessage: 'ExampleCorp: For assistance, email support@example.com. We''re here to help!'
                        optOutMessage: You have now unsubscribed from ExampleCorp promotional messages and will receive no further messages.
                      optInMethods:
                      - optInMethod: VERBAL
                        description: By providing your mobile number verbally during a phone call or in person, you agree to receive promotional messages from ExampleCorp about seasonal discounts for loyalty club members. Message and data rates may apply. Message frequency may vary. For terms and conditions, visit <TERMS_AND_CONDITIONS_URL>. For privacy policy, visit <PRIVACY_POLICY_URL>. Reply STOP to cancel.
                        disclaimer: This is an informational example only. You must update it to match your actual opt-in flow.
                        rules:
                        - Clear verbal agreement must be obtained before sending messages.
                        - Users must be informed about what messages will be sent.
                        - Users must be informed about message frequency and potential charges.
                        - Users must be informed how to access the Terms and Privacy Policy.
                        - Consent must be documented (timestamp, agent name, and user acknowledgment).
                        - A confirmation SMS must be sent shortly after consent is obtained.
                        restrictions:
                        - Verbal consent is not allowed for promotional or marketing campaigns.
                      termsConditionsSample: TERMS & CONDITIONS sample content for PROMOTIONAL_MARKETING 10DLC program
                      privacyPolicySample: PRIVACY POLICY sample content for PROMOTIONAL_MARKETING 10DLC program
                Completed - Short Code:
                  summary: Completed - Short Code
                  description: Completed - Short Code
                  value:
                    status: COMPLETED
                    result:
                      campaignType: SHORT_CODE
                      useCase: PROMOTIONAL_MARKETING
                      messageFlow:
                        optInMessage: Welcome to ExampleCorp! Msg & data rates may apply. Receive 2-4 msgs/month on seasonal discounts for loyalty club members. Reply HELP for help, STOP to cancel.
                        exampleMessage1: 'ExampleCorp Loyalty Club: Enjoy 20% off on all winter items! Shop now at https://www.example.com. Reply HELP for help, STOP to cancel.'
                        exampleMessage2: 'ExampleCorp Exclusive: Spring Sale is here! Get up to 30% off on selected items. Visit https://www.example.com to shop. Reply HELP for help, STOP to cancel.'
                        helpMessage: 'ExampleCorp Support: For assistance, email support@example.com. Reply STOP to cancel.'
                        optOutMessage: You have now unsubscribed from ExampleCorp promotional messages and will receive no further messages.
                      cta:
                      - promotionMethod: PRINT
                        description: 'Text <KEYWORD> to <SHORT_CODE> to get seasonal discount promotions for loyalty club members from ExampleCorp. You''ll receive promotional offers and marketing messages. Msg & Data rates may apply. Frequency varies. Reply STOP to unsubscribe. Reply HELP or email us at support@example.com for help. Terms & Conditions: <TERMS_AND_CONDITIONS_URL> Privacy Policy: <PRIVACY_POLICY_URL>'
                      optInMethods:
                      - optInMethod: VERBAL
                        description: 'By providing your mobile number verbally during a phone call or in person, you agree to receive promotional messages from ExampleCorp about seasonal discounts for loyalty club members. Message and data rates may apply. Message frequency may vary. Terms and Conditions: <TERMS_AND_CONDITIONS_URL>. Privacy Policy: <PRIVACY_POLICY_URL>. Reply STOP to cancel.'
                        disclaimer: This is an informational example only. You must update it to match your actual opt-in flow.
                        rules:
                        - Clear verbal agreement must be obtained before sending messages.
                        - Users must be informed about what messages will be sent.
                        - Users must be informed about message frequency and potential charges.
                        - Users must be informed how to access the Terms and Privacy Policy.
                        - Consent must be documented (timestamp, agent name, and user acknowledgment).
                        - A confirmation SMS must be sent shortly after consent is obtained.
                        restrictions:
                        - Verbal consent is not allowed for promotional or marketing campaigns.
                      termsConditionsSample: TERMS & CONDITIONS sample content for PROMOTIONAL_MARKETING short code program
                      privacyPolicySample: PRIVACY POLICY sample content for PROMOTIONAL_MARKETING short code program
                Completed - Toll Free:
                  summary: Completed - Toll Free
                  description: Completed - Toll Free
                  value:
                    status: COMPLETED
                    result:
                      campaignType: TOLL_FREE_NUMBER
                      useCase: GENERAL_MARKETING
                      messageFlow:
                        exampleMessage: 'ExampleCorp Loyalty Club: Seasonal discounts are now available for members. Visit <URL_PROVIDED_BY_CLIENT> for details. Reply HELP for assistance or STOP to opt out.'
                      optInMethods:
                      - optInMethod: IVR
                        description: Users opt in by calling a designated phone number and following the voice prompts to confirm their subscription to promotional messages. Reply STOP to cancel.
                        disclaimer: This is an informational example only. You must update it to match your actual opt-in flow.
                        rules:
                        - The IVR flow must clearly state what the user is consenting to and what messages will be sent.
                        - Message frequency and potential charges must be disclosed during the IVR interaction.
                        - Consent must be captured via an explicit action (e.g., 'Press 1 to confirm').
                        - A confirmation SMS must be sent immediately after IVR consent.
                      - optInMethod: KEYWORD
                        description: Users opt in by sending a specific keyword via SMS to a designated number, agreeing to receive promotional messages. Reply STOP to cancel.
                        disclaimer: This is an informational example only. You must update it to match your actual opt-in flow.
                        rules:
                        - Users must be clearly shown the keyword and messaging number before opting in.(e.g., shown to users as “Text JOIN to 12345” on a website, poster, or advertisement)
                        - An immediate confirmation message must be sent after opt-in.
                        - The confirmation message must include message frequency (or 'may vary').
                        - The confirmation message must include STOP and HELP instructions.
                        - The confirmation message must provide access to the Terms and Privacy Policy.
                        - The confirmation message should be under 160 characters when possible.
                      channelNote: TFN campaigns are reviewed based on how accurately the opt-in description reflects the real user experience. Not all disclosures apply to every TFN opt‑in method (e.g., verbal or IVR consent). Include disclosures only where applicable and do not invent or assume details that do not exist in your actual flow.
                      termsConditionsSample: TERMS & CONDITIONS sample content for GENERAL_MARKETING toll free program
                      privacyPolicySample: PRIVACY POLICY sample content for GENERAL_MARKETING toll free program
                Failed:
                  summary: Failed
                  description: Failed
                  value:
                    status: FAILED
                    error: Campaign builder processing failed. Please try again.
        '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:
      - numbers:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /subscriptions/1/subscription/{channel}:
    get:
      tags:
      - platform
      summary: Get subscriptions
      description: Returns a list of all subscriptions for the specified channel with pagination. By default, the result is sorted by creation date in descending order.<br>The search can be used with various criteria passed via query parameters (all criteria combinations have <strong>AND</strong> semantic).<br><strong>Note.</strong>To avoid validation errors and inconsistent results query parameters need to be encoded  (see <strong>RFC 3986, section 2.1</strong>).<br><strong>Example</strong>. Find subscriptions having applications 'app1' and 'app2', and the resource '100200300400'.<pre>/subscriptions/1/subscription/SMS?applicationId=app1&applicationId=app2&resource=100200300400</pre>
      operationId: get-subscriptions
      parameters:
      - name: channel
        in: path
        description: Channel name. A separate subscription is needed for each channel.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel'
      - 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
      - name: applicationId
        in: query
        description: CPaaS-X application identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
          minLength: 1
      - name: entityId
        in: query
        description: CPaaS-X entity identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
          minLength: 1
      - name: callsConfigurationId
        in: query
        description: Calls configuration identifier.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 128
          minLength: 1
      - name: resource
        in: query
        description: Resource.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
          minLength: 1
      - name: user
        in: query
        description: User.
        required: false
        style: form
        explode: true
        schema:
          type: string
          maxLength: 255
          minLength: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionPage'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    post:
      tags:
      - platform
      summary: Create subscription
      description: This method will create a new subscription. You can provide an ID of an existing profile, or submit a full definition of a profile and security settings if you want to create new ones.
      operationId: create-subscription
      parameters:
      - name: channel
        in: path
        description: Channel name. A separate subscription is needed for each channel.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  subscriptionId: ABC-123-DEF
                  name: Default group
                  events:
                  - DELIVERY
                  criteria:
                  - applicationId: production
                    entityId: entity1
                  - applicationId: production
                    entityId: entity2
                  - applicationId: test
                    entityId: entity1
                  resources:
                  - '1234'
                  users:
                  - user1
                  - user2
                  profile:
                    profileId: NOTIF-32395
                    webhook:
                      notifyUrl: https://www.example.com/pushme
                    security:
                      authId: NEWAUTH-9291
                      type: BASIC
                      credentials:
                        username: user1
                        password: password1
        required: true
      responses:
        '201':
          description: Created.
          headers:
            Location:
              description: Resource location.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/subscription/{channel}/{subscriptionId}:
    get:
      tags:
      - platform
      summary: Get single subscription
      description: Returns a specific subscription by ID.
      operationId: get-subscription
      parameters:
      - name: subscriptionId
        in: path
        description: ID of the subscription you want to get.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: channel
        in: path
        description: Channel name. A separate subscription is needed for each channel.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    subscriptionId: ABC-123-DEF
                    name: Default group
                    profile:
                      profileId: NOTIF-32395
                      security:
                        authId: NEWAUTH-9291
                    events:
                    - DELIVERY
                    criteria:
                    - applicationId: production
                      entityId: entity1
                    - applicationId: production
                      entityId: entity2
                    - applicationId: test
                      entityId: entity1
                    resources:
                    - '1234'
                    users:
                    - user1
                    - user2
                Set new profile for group response example:
                  summary: Set new profile for group response example
                  value:
                    subscriptionId: ABC-123-DEF
                    name: Default group
                    profile:
                      profileId: NOTIF-12345
                      security:
                        authId: NEWAUTH-9291
                    events:
                    - DELIVERY
                    criteria:
                    - applicationId: production
                      entityId: entity1
                    - applicationId: production
                      entityId: entity2
                    - applicationId: test
                      entityId: entity1
                    resources:
                    - '1234'
                    users:
                    - user1
                    - user2
                Edit group and switch profile response example:
                  summary: Edit group and switch profile response example
                  value:
                    subscriptionId: ABC-123-DEF
                    name: Updated group
                    profile:
                      profileId: NOTIF-98765
                      security:
                        authId: NEWAUTH-9999
                    events:
                    - DELIVERY
                    criteria:
                    - applicationId: production
                      entityId: entity1
                    - applicationId: production
                      entityId: entity2
                    - applicationId: test
                      entityId: entity1
                    resources:
                    - '1234'
                    users:
                    - user1
                    - user2
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    put:
      tags:
      - platform
      summary: Update subscription
      description: This method allows you to update the subscription. You can change its properties and provide an ID of a profile if you wish to change it.
      operationId: update-subscription
      parameters:
      - name: subscriptionId
        in: path
        description: ID of the subscription you want to modify.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: channel
        in: path
        description: Channel name. A separate subscription is needed for each channel.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSubscriptionRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  name: Updated group
                  profile:
                    profileId: NOTIF-98765
                  events:
                  - DELIVERY
                  criteria:
                  - applicationId: production
                    entityId: entity1
                  - applicationId: production
                    entityId: entity2
                  - applicationId: test
                    entityId: entity1
                  resources:
                  - '1234'
                  users:
                  - user1
                  - user2
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    subscriptionId: ABC-123-DEF
                    profile:
                      profileId: NOTIF-32395
                      security:
                        authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    delete:
      tags:
      - platform
      summary: Delete subscription
      description: This method will delete the subscription specified by ID.
      operationId: delete-subscription
      parameters:
      - name: subscriptionId
        in: path
        description: ID of the subscription you want to delete.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      - name: channel
        in: path
        description: Channel name. A separate subscription is needed for each channel.
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    subscriptionId: ABC-123-DEF
                    profile:
                      profileId: NOTIF-32395
                      security:
                        authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/profiles:
    get:
      tags:
      - platform
      summary: Get notification profiles
      description: Returns a list of all notification profiles for your account with pagination.
      operationId: get-profiles
      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/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfilePage'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    post:
      tags:
      - platform
      summary: Create notification profile
      description: This method will create a new notification profile. You can provide an ID of existing security settings if you wish to reuse them or submit full definition, if you want to create a new one.
      operationId: create-profile
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  profileId: NOTIF-32395
                  webhook:
                    notifyUrl: https://www.example.com/pushme
                  security:
                    authId: NEWAUTH-9291
                    type: BASIC
                    credentials:
                      username: user1
                      password: password1
                  clientCertificateId: MYCERT-1337
                  maxBucketSize: 1
                  windowSize: 20
                  connectTimeout: 10000
                  readTimeout: 10000
                  enabledSSLProtocols:
                  - TLSv1.3
                  - TLSv1.2
                  headers:
                    X-Important-Header: Important Value
                  responseRegex: '[1-9][0-9]'
                  responseBodyRegex: '[1-9][0-9]'
                  rateLimit: 5000
        required: true
      responses:
        '201':
          description: Created.
          headers:
            Location:
              description: Resource location.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/profiles/{profileId}:
    get:
      tags:
      - platform
      summary: Get single notification profile
      description: Returns a specific notification profile by ID.
      operationId: get-profile
      parameters:
      - name: profileId
        in: path
        description: Notification profile ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    profileId: NOTIF-32395
                    webhook:
                      contentType: application/json
                      notifyUrl: https://www.example.com/pushme
                    security:
                      authId: NEWAUTH-9291
                    maxBucketSize: 1
                    windowSize: 20
                    connectTimeout: 10000
                    readTimeout: 10000
                    enabledSSLProtocols:
                    - TLSv1.3
                    - TLSv1.2
                    headers:
                      X-Important-Header: Important Value
                    responseRegex: '[1-9][0-9]'
                    responseBodyRegex: '[1-9][0-9]'
                    rateLimit: 5000
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    put:
      tags:
      - platform
      summary: Update notification profile
      description: This method allows you to update a notification profile. You can change its properties and provide an ID of security settings if you wish to change them.
      operationId: update-profile
      parameters:
      - name: profileId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdProfileRequest'
            examples:
              Set new security for an existing profile request example:
                summary: Set new security for an existing profile request example
                value:
                  webhook:
                    notifyUrl: https://www.example.com/pushme
                  security:
                    authId: AUTH-123
                  maxBucketSize: 1
                  windowSize: 20
                  connectTimeout: 10000
                  readTimeout: 10000
                  enabledSSLProtocols:
                  - TLSv1.3
                  - TLSv1.2
                  headers:
                    X-Important-Header: Important Value
                  responseRegex: '[1-9][0-9]'
                  responseBodyRegex: '[1-9][0-9]'
                  rateLimit: 5000
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    profileId: NOTIF-32395
                    security:
                      authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    delete:
      tags:
      - platform
      summary: Delete notification profile
      description: This method will delete a notification profile specified by ID.
      operationId: delete-profile
      parameters:
      - name: profileId
        in: path
        description: Notification profile ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    profileId: NOTIF-32395
                    security:
                      authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/security:
    get:
      tags:
      - platform
      summary: Get security settings
      description: Returns a list of security settings for your account with pagination.
      operationId: get-security-settings
      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/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityPage'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    post:
      tags:
      - platform
      summary: Create security settings
      description: This method will create new security settings.
      operationId: create-security-settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  authId: NEWAUTH-9291
                  type: BASIC
                  credentials:
                    username: user1
                    password: password1
        required: true
      responses:
        '201':
          description: Created.
          headers:
            Location:
              description: Resource location.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/security/{authId}:
    get:
      tags:
      - platform
      summary: Get single security settings
      description: Returns specific security settings item by ID.
      operationId: get-security-setting
      parameters:
      - name: authId
        in: path
        description: Security settings ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    authId: NEWAUTH-9291
                    type: BASIC
                    credentials:
                      username: user1
                      password: password1
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    put:
      tags:
      - platform
      summary: Update security settings
      description: This method allows you to update the security settings.
      operationId: update-security-settings
      parameters:
      - name: authId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSecurityRequest'
            examples:
              Update request example:
                summary: Update request example
                value:
                  type: BASIC
                  credentials:
                    username: user1
                    password: password1
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
    delete:
      tags:
      - platform
      summary: Delete security settings
      description: This method will delete the security settings item by ID.
      operationId: delete-security-settings
      parameters:
      - name: authId
        in: path
        description: Security settings ID.
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    authId: NEWAUTH-9291
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException'
              examples:
                Error responses:
                  summary: Error responses
                  description: Error responses
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Not found
        '429':
          description: Too many requests.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
  /subscriptions/1/certificates:
    get:
      tags:
      - platform
      summary: Get filtered certificate details page
      description: Returns a page containing certificates details by filtering condition.
      operationId: get-certificates-details-page
      parameters:
      - name: search
        in: query
        description: Search filter. Limits returned results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - 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
      - name: sortBy
        in: query
        description: Sorting parameter.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType'
      - name: direction
        in: query
        description: Sorting direction.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsPage'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - certificateId: my-certificate-1
                      issuedBy: CN=Issuer LTD.,DC=abc,DC=issuer,DC=com
                      issuedTo: CN=subject.domain.com,O=Subject LTD.,L=Vodnjan,ST=Istria,C=HR
                      validFrom: 1655683200000
                      validUntil: 1687219200000
                      certificateStatus: READY
                      serialNumber: '1605653657727226303992554724456686612151129941'
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    post:
      tags:
      - platform
      summary: Upload certificate
      description: Upload the certificate Infobip will present for your webhook to verify Infobip when sending notification events.
      operationId: upload-certificate
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateUploadRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  certificateId: my-certificate-1
                  certificateContent: IyBQcml2YXRlIGtleSBvZiB0aGUgU1NMIGNlcnRpZmljYXRlCi0tLS0tQkVHSU4gUFJJVkFURSBLRVktLS0tLQpNSUlFdmdJQkFEQU5CZ2txaGtpRzl3MEJBUUVGQUFTQ0JLZ3dnZ1NrQWdFQUFvSUJBUURCajA4c3A1Kys0YW5HCmNtUXhKakFrQmdOVkJBb1RIVkJ5YjJkeVpYTnpJRk52Wm5SM1lYSmxJRU52Y25CdmNtRjBhVzl1TVNBd0hnWUQKVlFRRERCY3FMbUYzY3kxMFpYTjBMbkJ5YjJkeVpYTnpMbU52YlRDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRAouLi4KYm1sNllYUnBiMjUyWVd4emFHRXlaekl1WTNKc01JR2dCZ2dyQmdFRkJRY0JBUVNCa3pDQmtEQk5CZ2dyQmdFRgpCUWN3QW9aQmFIUjBjRG92TDNObFkzVnlaUzVuYkc5aVlXeHphV2R1TG1OdmJTOWpZV05sY25RdlozTnZjbWRoCnozUDY2OFlmaFViS2RSRjZTNDJDZzZ6bgotLS0tLUVORCBQUklWQVRFIEtFWS0tLS0tCgojIFB1YmxpYyBrZXkgb2YgdGhlIFNTTCBjZXJ0aWZpY2F0ZSAodGhlIHNlcnZlciBjZXJ0aWZpY2F0ZSkKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUZhRENDQkZDZ0F3SUJBZ0lTRVNIa3ZaRndLOVF6MEtzWEQzeDhwNDRhTUEwR0NTcUdTSWIzRFFFQkN3VUEKVlFRRERCY3FMbUYzY3kxMFpYTjBMbkJ5YjJkeVpYTnpMbU52YlRDQ0FTSXdEUVlKS29aSWh2Y05BUUVCQlFBRApnZ0VQQURDQ0FRb0NnZ0VCQU1HUFR5eW5uNzdocWNZbmpXc013T1pEemRoVkZZOTNzMk9KbnRNYnVLVEhuMzlCCi4uLgpibWw2WVhScGIyNTJZV3h6YUdFeVp6SXVZM0pzTUlHZ0JnZ3JCZ0VGQlFjQkFRU0JrekNCa0RCTkJnZ3JCZ0VGCkJRY3dBb1pCYUhSMGNEb3ZMM05sWTNWeVpTNW5iRzlpWVd4emFXZHVMbU52YlM5allXTmxjblF2WjNOdmNtZGgKYm1sNllYUnBiMjUyWVd4emFHRXlaekp5TVM1amNuUXdQd1lJS3dZQkJRVUhNQUdHTTJoMGRIQTZMeTl2WTNOdwpsZmZ5Z0Q1SXltQ1N1dURpbTRxQi85Ymg3b2kzN2hlSjRPYnBCSXpyb1BVT3RoYkc0Z3YvNWJsVzNEYz0KLS0tLS1FTkQgQ0VSVElGSUNBVEUtLS0tLQoKIyBUcnVzdCBjaGFpbiBpbnRlcm1lZGlhdGUgY2VydGlmaWNhdGUKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUVhVENDQTFHZ0F3SUJBZ0lMQkFBQUFBQUJSRTd3UWtjd0RRWUpLb1pJaHZjTkFRRUxCUUF3VnpFTE1Ba0cKQzMzSmlKMVBpL0Q0bkd5TVZUWGJ2L0t6NnZ2alZ1ZEtSdGtUSXNvMjFadkJxT09XUTVQeURMem0rZWJvbWNoagpTSGgvVnpacEdoa2RXdEhVZmNLYzFIL2hnQkt1ZXVxSTZsZll5Z29LT2hKSm9tSVplZzBrOXpmcnRIT1Nld1VqCi4uLgpkSEJ6T2k4dmQzZDNMbWRzYjJKaGJITnBaMjR1WTI5dEwzSmxjRzl6YVhSdmNua3ZNRE1HQTFVZEh3UXNNQ293CktLQW1vQ1NHSW1oMGRIQTZMeTlqY213dVoyeHZZbUZzYzJsbmJpNXVaWFF2Y205dmRDNWpjbXd3UFFZSUt3WUIKSzFwcDc0UDFTOFNxdENyNGZLR3hoWlNNOUF5SERQU3NRUGhaU1pnPQotLS0tLUVORCBDRVJUSUZJQ0FURS0tLS0tCgojIFRydXN0IGNoYWluIHJvb3QgY2VydGlmaWNhdGUKLS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSURkVENDQWwyZ0F3SUJBZ0lMQkFBQUFBQUJGVXRhdzVRd0RRWUpLb1pJaHZjTkFRRUZCUUF3VnpFTE1Ba0cKWVd4VGFXZHVJRzUyTFhOaE1SQXdEZ1lEVlFRTEV3ZFNiMjkwSUVOQk1Sc3dHUVlEVlFRREV4SkhiRzlpWVd4VAphV2R1SUZKdmIzUWdRMEV3Z2dFaU1BMEdDU3FHU0liM0RRRUJBUVVBQTRJQkR3QXdnZ0VLQW9JQkFRRGFEdWFaCi4uLgpqYzZqNDArS2Z2dnhpNE1sYStwSUgvRXFzTG1WRVFTOThHUFI0bWRtenh6ZHp4dElLKzZOaVk2YXJ5bUFaYXZwCjM4TmZsTlVWeVJSQm5NUmRkV1FWRGY5Vk1PeUdqLzhON3l5NVkwYjJxdnpmdkduOUxoSklaSnJnbGZDbTd5bVAKSE1VZnBJQnZGU0RKM2d5SUNoM1dabFhpL0VqSktTWnA0QT09Ci0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0=
                  passphrase: TXk1dHJvbmdAUGE1NXBocmE1MyE=
        required: true
      responses:
        '201':
          description: Created.
          headers:
            Location:
              description: Resource location.
              style: simple
              explode: false
              schema:
                type: string
                format: uri
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /subscriptions/1/certificates/{certificateId}:
    get:
      tags:
      - platform
      summary: Get certificate details by identifier
      description: Returns a certificate details.
      operationId: get-certificate-details
      parameters:
      - name: certificateId
        in: path
        description: Certificate identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
          minLength: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
    delete:
      tags:
      - platform
      summary: Delete certificate
      description: Deletes an existing certificate by a given identifier. Note, certificates cannot be deleted if linked to a Notification Profile.
      operationId: delete-certificate
      parameters:
      - name: certificateId
        in: path
        description: Certificate identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
          minLength: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyCertificateResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    certificateId: my-certificate-1
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /subscriptions/1/certificates/status:
    get:
      tags:
      - platform
      summary: Get filtered certificates statuses page
      description: Returns a page containing certificates statuses by filtering condition.
      operationId: get-certificates-statuses-page
      parameters:
      - name: search
        in: query
        description: Search filter. Limits returned results.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - 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
      - name: sortBy
        in: query
        description: Sorting parameter.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType'
      - name: direction
        in: query
        description: Sorting direction.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusPage'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - certificateId: my-certificate-1
                      status: READY
                    - certificateId: my-certificate-2
                      status: PROCESSING
                    - certificateId: my-certificate-3
                      status: EXPIRED
                    paging:
                      page: 0
                      size: 3
                      totalPages: 1
                      totalResults: 3
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /subscriptions/1/certificates/status/{certificateId}:
    get:
      tags:
      - platform
      summary: Get certificate status by identifier
      description: Returns a certificate status.
      operationId: get-certificate-status
      parameters:
      - name: certificateId
        in: path
        description: Certificate identifier.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          maxLength: 255
          minLength: 1
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse'
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /subscriptions/1/certificates/test/webhook:
    post:
      tags:
      - platform
      summary: Test connection to a webhook
      description: Performs connectivity check to provided webhook with the given certificate. Note, it does not send a notification event.
      operationId: test-connection-to-webhook
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestRequest'
            examples:
              Request example:
                summary: Request example
                value:
                  certificateId: my-certificate-1
                  webhookUrl: https://example.com/webhook-url
        required: true
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    certificateId: my-certificate-1
                    webhookUrl: https://example.com/my-webhook
                    result: SUCCESS
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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/d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.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:
      - subscriptions:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: m
  /metrics/1/query-aggregate-data:
    post:
      tags:
      - platform
      summary: Query aggregated traffic data
      description: Start process for traffic data aggregation. The result will be posted to `callbackURL` provided in the request. The response format is described in [Receive aggregated data result](#platform/metrics-api/receive-aggregate-data-result) operation.
      operationId: query-aggregate-data
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataRequest'
            examples:
              A simple request:
                summary: A simple request
                value:
                  callbackUrl: https://example.com/receive
                  request:
                    filterBy:
                      accountKeys:
                      - 565C2852060F94BC771F692C04C055E1
                      includeSubaccounts: true
                      sentSince: 2023-04-01T00:00:00.000+0000
                      sentUntil: 2023-04-01T01:00:00.000+0000
                      channelCodes:
                      - SMS
                      directions:
                      - OUTBOUND
                      communicationIds:
                      - 12354646546
                      - 45534466546
                      - 754564654689
                      campaignReferenceIds:
                      - CAMPAIGNNAME-20240612-001
                      - CAMPAIGNNAME-20240612-002
                      entityId: ''
                      statusGroups:
                      - REJECTED
                      - UNDELIVERABLE
                      statuses:
                      - UNDELIVERABLE_REJECTED_OPERATOR
                      - REJECTED_NETWORK
                      - REJECTED_SENDER
                      errorGroups:
                      - OPERATOR_ERRORS
                      - USER_ERRORS
                      errorCodes:
                      - NO_ERROR
                      - EC_UNKNOWN_SUBSCRIBER
                      - EC_UNKNOWN_BASE_STATION
                    aggregateBy:
                    - ACCOUNT_KEY
                    - HOUR
                    - DIRECTION
                    - STATUS
                    metrics:
                    - TOTAL_TRAFFIC_COUNT
              Request using multiple date/time aggregates:
                summary: Request using multiple date/time aggregates
                description: When using multiple date/time aggregates, only the finest one will be presented in the response. In this case, when one queries for DAY and HOUR, only HOUR will be present.
                value:
                  callbackUrl: https://example.com/receive
                  request:
                    filterBy:
                      accountKeys:
                      - 565C2852060F94BC771F692C04C055E1
                      includeSubaccounts: false
                      sentSince: 2023-04-01T00:00:00.000+0000
                      sentUntil: 2023-04-01T01:00:00.000+0000
                      channelCodes:
                      - SMS
                      entityId: ''
                    aggregateBy:
                    - DAY
                    - HOUR
                    - STATUS
                    metrics:
                    - TOTAL_TRAFFIC_COUNT
        required: true
      responses:
        '201':
          description: Data querying process is started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResponse'
              examples:
                A successful response:
                  summary: A successful response
                  value:
                    requestId: B61D150B0F6596F68D88D253886432B5
        '400':
          description: Request is malformed or invalid.
          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:
      - metrics:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: s
  /metrics/1/requests/{requestId}:
    get:
      tags:
      - platform
      summary: Get status of query aggregate data request
      description: Return the status of ongoing request, started by invoking [Query aggregated traffic data](#platform/metrics-api/query-aggregate-data).
      operationId: get-aggregate-request-status
      parameters:
      - name: requestId
        in: path
        required: true
        style: simple
        explode: false
        schema:
          type: string
      responses:
        '200':
          description: Request status retrieved.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.RequestInfo'
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Request with provided id 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:
                    - property: requestId
                      violation: Request with id "B61D150B0F6596F68D88D253886432B5" not found
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - metrics:manage
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: s
  /billing/1/usage/query:
    post:
      tags:
      - platform
      summary: Query billing usage data
      description: Start the process of aggregating billing-grade financial cost data for your Infobip traffic. The results are delivered once via POST to the `callbackURL` provided in the request. Make sure the URL is reachable before submitting. See [Receive billing usage result](#platform/billing-usage/receive-billing-usage-result) for the webhook payload structure.
      operationId: query-billing-usage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageRequest'
            examples:
              A simple billing usage request:
                summary: A simple billing usage request
                value:
                  callbackUrl: https://example.com/receive
                  request:
                    filterBy:
                      dateInterval:
                        sentSince: '2026-03-01'
                        sentUntil: '2026-04-01'
                    aggregateBy:
                    - CATEGORY_CODE
                    - COUNTRY_NAME
                    options:
                      includeUnfinalizedData: true
              A detailed billing usage request:
                summary: A detailed billing usage request
                value:
                  callbackUrl: https://example.com/webhooks/billing-usage
                  request:
                    filterBy:
                      dateInterval:
                        sentSince: '2026-03-01'
                        sentUntil: '2026-04-01'
                      categories:
                      - SMS
                      - WHATSAPP
                      - RCS
                      platforms:
                      - applicationId: app_a
                        entityId: entity_a
                      - applicationId: app_a
                        entityId: entity_b
                      - applicationId: app_b
                        entityId: entity_a
                      directions:
                      - OUTBOUND
                      campaignReferenceIds:
                      - campaign_ref_1
                      - campaign_ref_2
                      - campaign_ref_3
                    aggregateBy:
                    - APPLICATION_ID
                    - ENTITY_ID
                    - CATEGORY_CODE
                    - COUNTRY_NAME
                    - TRAFFIC_TYPE
                    - SENDER_TYPE
                    - ACCOUNT_KEY
                    options:
                      includeUnfinalizedData: true
        required: true
      responses:
        '201':
          description: Data querying process is started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResponse'
              examples:
                A successful response:
                  summary: A successful response
                  value:
                    requestId: B61D150B0F6596F68D88D253886432B5
        '400':
          description: Request is malformed or invalid.
          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:
      - billing:usage:view
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 60
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/2/sending-strategies:
    get:
      tags:
      - platform
      summary: Get sending strategies
      description: Get sending strategies.
      operationId: get-sending-strategies-v2
      parameters:
      - name: sendingStrategyId
        in: query
        description: Id of created Sending Strategy.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 78D8394AC3EG0460B4CF0E723FC31B49
      - name: applicationId
        in: query
        description: Application Id of created Sending Strategy. For more details, see the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: test-application-1
      - name: entityId
        in: query
        description: Entity Id of created Sending Strategy. For more details, see the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: test-entity-1
      - name: page
        in: query
        description: Requested page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          example: 0
          minimum: 0
      - name: size
        in: query
        description: Requested page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 100
          example: 10
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: OK.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.PageResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - sendingStrategyId: 78D8394AC3EG0460B4CF0E723FC31B49
                      platform:
                        entityId: test-entity-1
                        applicationId: test-application-1
                      channel: MMS
                      destinationCountryCode: US
                      useStickySender: false
                      useGeolocatedSender: true
                      priorities:
                      - senderType: VIRTUAL_LONG_NUMBER
                        priority: 1
                      - senderType: TOLL_FREE_NUMBER
                        priority: 2
                    - sendingStrategyId: 3B9D1EACAB7FBDRN4EE03592BFCD6BE1
                      platform:
                        entityId: test-entity-2
                        applicationId: test-application-2
                      useStickySender: false
                      useGeolocatedSender: false
                    - sendingStrategyId: 712D1EACAB7FDORN4EE035954FCD6BOO
                      platform:
                        entityId: test-entity-2
                        applicationId: test-application-3
                      useStickySender: true
                      useGeolocatedSender: false
                    paging:
                      page: 0
                      size: 10
                      totalPages: 1
                      totalResults: 3
        '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:
      - sending-strategy:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create sending strategy
      description: Create sending strategy.
      operationId: create-sending-strategy-v2
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssRequestV2'
            examples:
              Application level:
                summary: Application level
                description: Application level
                value:
                  platform:
                    applicationId: default
              Application/Entity level:
                summary: Application/Entity level
                description: Application/Entity level
                value:
                  platform:
                    entityId: test-entity-1
                    applicationId: test-application-1
                  channel: MMS
                  destinationCountryCode: CA
              Application level with additional features:
                summary: Application level with additional features
                description: Application level with additional features
                value:
                  platform:
                    applicationId: default
                  channel: SMS
                  useStickySender: true
              Application/Entity level with additional features:
                summary: Application/Entity level with additional features
                description: Application/Entity level with additional features
                value:
                  platform:
                    entityId: test-entity-1
                    applicationId: test-application-1
                  channel: SMS
                  destinationCountryCode: US
                  useStickySender: true
                  useGeolocatedSender: true
                  priorities:
                  - senderType: VIRTUAL_LONG_NUMBER
                    priority: 1
                  - senderType: TOLL_FREE_NUMBER
                    priority: 2
        required: true
      responses:
        '201':
          description: Created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SendingStrategyId'
              examples:
                Response example:
                  summary: Response example
                  value:
                    sendingStrategyId: 78D8394AC3EG0460B4CF0E723FC31B49
        '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:
      - sending-strategy:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /provisioning/2/sending-strategies/{sendingStrategyId}:
    delete:
      tags:
      - platform
      summary: Delete sending strategy by sending strategy id
      description: Delete sending strategy by sending strategy id.
      operationId: delete-sending-strategy-by-sending-strategy-id-v2
      parameters:
      - name: sendingStrategyId
        in: path
        description: Id of the Sending Strategy.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 78D8394AC3EG0460B4CF0E723FC31B49
      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'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - sending-strategy:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /platform/1/blocklists:
    get:
      tags:
      - platform
      summary: Get all blocklists
      description: This method allows you to get all blocklist records or filter them based on specific parameters.
      operationId: get-all-blocklists
      parameters:
      - name: sender
        in: query
        description: The sender ID for which blocklist happened.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '10950'
          maxLength: 255
          minLength: 1
      - name: destination
        in: query
        description: Blocklisted destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '41793026727'
          maxLength: 255
          minLength: 1
      - name: channel
        in: query
        description: 'Channel used for sending for which blocklist happened.


          If you want to check blocklist records for all channels, this field can be left out.'
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ViewableChannel'
      - name: sourceType
        in: query
        description: 'Represents the way blocklist record was created:


          CUSTOM - blocklist record that was created manually


          MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.


          URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.


          CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).'
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.SourceType'
      - name: accountKey
        in: query
        description: Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. [API to retrieve account key](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: 8F0792F86035A9F4290821F1EE6BC06A
      - name: getAllAccountKeysBlocklists
        in: query
        description: If set to `true`, blocklist records for subaccounts will be returned as well.
        required: false
        style: form
        explode: true
        schema:
          type: boolean
          example: false
      - name: createdDateFrom
        in: query
        description: Use with `createDateTo` to search for blocklists for a particular date range.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2022-08-18T12:33:42.123Z'
      - name: createdDateTo
        in: query
        description: Use with `createDateFrom` to search for blocklists for a particular date range.
        required: false
        style: form
        explode: true
        schema:
          type: string
          format: date-time
          example: '2022-08-18T13:33:42.123Z'
      - name: campaign
        in: query
        description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: summersale
          maxLength: 255
          minLength: 1
      - name: page
        in: query
        description: Requested page number.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 0
          example: 0
          minimum: 0
      - name: size
        in: query
        description: Requested page size.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          default: 100
          example: 10
          maximum: 1000
          minimum: 1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistGetResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - sender: '10950'
                      destination: '12022921990'
                      sourceType: MO
                      channel: MMS
                      accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                      createdDate: '2022-08-18T12:36:42.123Z'
                    - sender: '64350'
                      destination: '12022921994'
                      sourceType: CUSTOM
                      channel: SMS
                      accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                      createdDate: '2022-08-18T12:36:42.123Z'
                    - sender: c5ab692f-b5d8-4bad-bee5-c121dc346a39
                      destination: urn:mbid:AQAAY3hr45FzBEsLpieCa0GANPlF399IiV/0gLSXRvwHauT0ph5Akk/Tx66ekESCF32bAOUHbSDCgQmZpGlyVr+wWepO0vPd7SUSQMUhjm+TTD7b/gGuVS6urpS2PL8I4GT+NW67K6VIO/1TeADk+Yu18i9HQfw=
                      sourceType: MO
                      channel: APPLE_MB
                      accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                      createdDate: '2022-08-18T12:36:42.123Z'
                    paging:
                      page: 0
                      size: 10
                      totalPages: 1
                      totalResults: 2
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad08f31d0530c669218bdbac07f91125fbbb50284a2712ce5d27fb95dd26628.ApiException'
              examples:
                Bad request example for filter request:
                  summary: Bad request example for filter request
                  description: Bad request example for filter request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          channel:
                          - unsupported channel
                          sender:
                          - size must be between 1 and 255
                          sourceType:
                          - unsupported source type
                          destination:
                          - size must be between 1 and 255
                          size:
                          - must be less than or equal to 1000
                          page:
                          - must be greater than or equal to 0
                          request:
                          - created dates must be in supported format, both present and valid (`from` must be before `to`)
                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:
      - blocklist:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create blocklists
      description: This method allows you to add someone to blocklist. It accepts create request with blocklists and asynchronously saves them, leaving out duplicate entries.
      operationId: create-blocklists
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreateRequest'
            examples:
              Blocklist create request:
                summary: Blocklist create request
                description: Blocklist create request
                value:
                  blocklist:
                  - destinations:
                    - to: '2025550954'
                    - to: '2025550316'
                  - sender: someone@example.com
                    destinations:
                    - to: jane.doe@example.com
                    - to: john.doe@example.com
                    channel: EMAIL
                    accountKey: 8F0792F86035A9F4290821F1EE6BC06A
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad08f31d0530c669218bdbac07f91125fbbb50284a2712ce5d27fb95dd26628.ApiException'
              examples:
                Bad request example for create request:
                  summary: Bad request example for create request
                  description: Bad request example for create request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          blocklist[1].accountKey:
                          - unsupported account key
                          blocklist[0].channel:
                          - unsupported channel
                          blocklist[0].destinations[0].to:
                          - size must be between 1 and 255
                          blocklist[1].channel:
                          - unsupported channel
                          blocklist[1].destinations[1].to:
                          - size must be between 1 and 255
                          blocklist[2].destinations:
                          - must not be empty
                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:
      - blocklist:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete blocklists
      description: "This method allows you to remove someone from blocklist. It accepts delete request and asynchronously deletes all blocklists that match given properties. \n\nNote: To delete a blocklist, you must list all properties that were defined in the create request. For example, to delete the blocklist with the following properties: \n\n`{\"sender\": \"10950\", \"destination\": \"12022921990\", \"sourceType\": \"CUSTOM\", \"channel\": \"MMS\", \"createdDate\": \"2022-08-18T12:36:42.123Z\"}` \n\nThe delete request must contain all present properties, like this: \n\n`{\"blocklist\": [{\"destinations\": [{\"to\": \"12022921990\"}], \"sender\": \"10950\", \"channel\": \"MMS\", \"sourceType\": \"CUSTOM\"}`. \n\nOnly when all properties are listed will the blocklist be removed."
      operationId: delete-blocklists
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDeleteRequest'
            examples:
              Blocklist delete request:
                summary: Blocklist delete request
                description: Blocklist delete request
                value:
                  blocklist:
                  - destinations:
                    - to: '2025550954'
                    - to: '2025550316'
                    sourceType: CAMPAIGN
                  - sender: someone@example.com
                    destinations:
                    - to: jane.doe@example.com
                    - to: john.doe@example.com
                    channel: EMAIL
                    accountKey: 8F0792F86035A9F4290821F1EE6BC06A
                    sourceType: CUSTOM
        required: true
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bad08f31d0530c669218bdbac07f91125fbbb50284a2712ce5d27fb95dd26628.ApiException'
              examples:
                Bad request example for delete request:
                  summary: Bad request example for delete request
                  description: Bad request example for delete request
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
                        validationErrors:
                          blocklist[1].accountKey:
                          - unsupported account key
                          blocklist[0].channel:
                          - unsupported channel
                          blocklist[0].sourceType:
                          - unsupported source type
                          blocklist[0].destinations[0].to:
                          - size must be between 1 and 255
                          blocklist[1].channel:
                          - unsupported channel
                          blocklist[1].destinations[1].to:
                          - size must be between 1 and 255
                          blocklist[2].destinations:
                          - must not be empty
                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:
      - blocklist:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs:
    get:
      tags:
      - platform
      summary: Get catalogs
      description: Use this method to get a list of catalogs with pagination. Query parameters are optional and can be used to narrow down the results.
      operationId: get-catalogs
      parameters:
      - name: ids
        in: query
        description: Catalog IDs.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: integer
            format: int64
        example: 1,2,3,4,5
      - name: name
        in: query
        description: Catalog name.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: Catalog name
      - name: type
        in: query
        description: Catalog type.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: blank
      - 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 catalogs per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.PageResponseDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - id: 10061
                      name: Catalog-534
                      description: desc
                      type: BLANK
                    - id: 10062
                      name: Catalog-535
                      description: desc
                      type: BLANK
                    paging:
                      page: 1
                      size: 20
                      totalPages: 1
                      totalResults: 2
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <results>\n            \n    <id>10061</id>\n            \n    <name>Catalog-534</name>\n            \n    <description>desc</description>\n            \n    <type>BLANK</type>\n        \n  </results>\n      \n  <results>\n            \n    <id>10062</id>\n            \n    <name>Catalog-535</name>\n            \n    <description>desc</description>\n            \n    <type>BLANK</type>\n        \n  </results>\n      \n  <paging>\n            \n    <page>1</page>\n            \n    <size>20</size>\n            \n    <totalPages>1</totalPages>\n            \n    <totalResults>2</totalResults>\n        \n  </paging>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:read
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create catalog
      description: Use this method to create a catalog.
      operationId: create-catalog
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 10000
                    name: Blank catalog
                    description: Example of the simple Catalog
                    type: BLANK
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>10000</id>\n      \n  <name>Blank catalog</name>\n      \n  <description>Example of the simple Catalog</description>\n      \n  <type>BLANK</type>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \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:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{id}:
    get:
      tags:
      - platform
      summary: Get catalog
      description: Use this method to get a specific catalog.
      operationId: get-catalog
      parameters:
      - name: id
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 10000
                    name: Blank catalog
                    description: Example of the simple Catalog
                    type: BLANK
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>10000</id>\n      \n  <name>Blank catalog</name>\n      \n  <description>Example of the simple Catalog</description>\n      \n  <type>BLANK</type>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:read
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete catalog
      description: Use this method to delete a catalog.
      operationId: delete-catalog
      parameters:
      - name: id
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - platform
      summary: Update catalog
      description: 'Use this method to overwrite a catalog with the data passed in the request body.

        New values replace the existing values from the catalog. If no value is passed in the request,

        the parameter keeps its value.'
      operationId: update-catalog
      parameters:
      - name: id
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 10000
                    name: Blank catalog
                    description: Example of the simple Catalog
                    type: BLANK
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 10000
                    name: Blank catalog
                    description: Example of the simple Catalog
                    type: BLANK
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{catalogId}/fields:
    get:
      tags:
      - platform
      summary: Get fields
      description: Use this method to get a list of fields for a specific catalog.
      operationId: get-catalog-fields
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
                    name: 'Catalog field #1'
                    dataType: TEXT
                    isPredefined: false
                  - id: 17ceebe0-1900-479f-9432-7865a6c686b6
                    name: 'Catalog field #2'
                    dataType: BOOLEAN
                    isPredefined: false
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <fields>\n            \n    <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n            \n    <name>Catalog field #1</name>\n            \n    <dataType>TEXT</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n      \n  <fields>\n            \n    <id>17ceebe0-1900-479f-9432-7865a6c686b6</id>\n            \n    <name>Catalog field #2</name>\n            \n    <dataType>BOOLEAN</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Create fields
      description: 'Use this method to add catalog fields to a specific catalog.<br><br>

        <strong>NOTE</strong><br><ul><li>Maximum of <code>100</code> catalog fields are allowed.</li></ul>'
      operationId: create-catalog-fields
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogFieldDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
                    name: 'Catalog field #1'
                    dataType: TEXT
                    isPredefined: false
                  - id: 17ceebe0-1900-479f-9432-7865a6c686b6
                    name: 'Catalog field #2'
                    dataType: BOOLEAN
                    isPredefined: false
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <fields>\n            \n    <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n            \n    <name>Catalog field #1</name>\n            \n    <dataType>TEXT</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n      \n  <fields>\n            \n    <id>17ceebe0-1900-479f-9432-7865a6c686b6</id>\n            \n    <name>Catalog field #2</name>\n            \n    <dataType>BOOLEAN</dataType>\n            \n    <isPredefined>false</isPredefined>\n        \n  </fields>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{catalogId}/fields/{fieldId}:
    get:
      tags:
      - platform
      summary: Get field
      description: Use this method to get a specific catalog field.
      operationId: get-catalog-field
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: fieldId
        in: path
        description: Field id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
                    name: 'Catalog field #1'
                    dataType: TEXT
                    isPredefined: false
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n      \n  <name>Catalog field #1</name>\n      \n  <dataType>TEXT</dataType>\n      \n  <isPredefined>false</isPredefined>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:read
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete field
      description: Use this method to delete a field.
      operationId: delete-catalog-field
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: fieldId
        in: path
        description: Field id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - platform
      summary: Update field
      description: Use this method to update a catalog field.
      operationId: update-catalog-field
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: fieldId
        in: path
        description: Field id.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogFieldDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
                    name: 'Catalog field #1'
                    dataType: TEXT
                    isPredefined: false
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <id>8b00a8c6-5302-4fd0-a0cc-bb090b28ac34</id>\n      \n  <name>Catalog field #1</name>\n      \n  <dataType>TEXT</dataType>\n      \n  <isPredefined>false</isPredefined>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{catalogId}/items:
    get:
      tags:
      - platform
      summary: Get items
      description: Use this method  to get a list of items from a catalog with pagination. Query parameters are optional and can be used to narrow list results.
      operationId: get-items
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: queryFilter
        in: query
        description: 'Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>AND</code></td><td>Joins query clauses with a logical AND. Returns all items that match the conditions of both clauses.<br><b>Example:</b> <code>price > 10.99 AND color == Red</code></td>

          </tr>

          <tr>

          <td><code>OR</code></td><td>Joins query clauses with a logical OR. Returns all items that match the conditions of either clause.<br><b>Example:</b> <code>type == Jeans OR type == Shirt</code></td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td>Greater than: <code>&gt;</code></td><td>integer, decimal</td><td>Matches values that are greater than a specified value.<br><b>Example:</b> <code>price &gt; 99.99</code></td>

          </tr>

          <tr>

          <td>Greater or equal: <code>&ge;</code></td><td>integer, decimal</td><td>Matches all values that are greater than or equal to a specified value.<br><b>Example:</b> <code>price &ge; 99.99</code> </td>

          </tr>

          <tr>

          <td>Less than: <code>&lt;</code></td><td>integer, decimal</td><td>Matches all values that are less than a specified value.<br><b>Example:</b> <code>price &lt; 99.99</code></td>

          </tr>

          <tr>

          <td>Less or equal: <code>&le;</code></td><td>integer, decimal</td><td>Matches all that are values less than or equal to a specified value.<br><b>Example:</b> <code>price &le; 99</code></td>

          </tr>

          <tr>

          <td>Equal: <code>==</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are equal to a specified value.<br><b>Example:</b> <code>color == <q>green</q></code></td>

          </tr>

          <tr>

          <td>Not equal: <code>!=</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are not equal to a specified value.<br><b>Example:</b> <code>color != <q>green</q></code></td>

          </tr>

          </table>


          ##### List of supported date/time range operators:


          <table>

          <thead>

          <th>Date/time Range Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range between dates.<br><b>Example:</b> <code>createdAt BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          <tr>

          <td><code>NOT BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range not between dates.<br><b>Example:</b> <code>createdAt NOT BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          </table>


          ##### List of supported string operators:


          <table>

          <thead>

          <th>String Operator&nbsp;&nbsp;&nbsp;</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>STARTS WITH</code></td><td>string</td><td>Matches all values starting with specific substring.<br><b>Example:</b> <code>name STARTS WITH <q>Bo</q></code></td>

          </tr>

          <tr>

          <td><code>ENDS WITH</code></td><td>string</td><td>Matches all values ending with specific substring.<br><b>Example:</b> <code>name ENDS WITH <q>an</q></code></td>

          </tr>

          </table>.'
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: ( type == "Jeans" AND type == "Shirt" ) OR ( price > 10.99 AND color == "Red" )
      - 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 items per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 10
          maximum: 100
          minimum: 1
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.PageResponseDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - id: 1
                      values:
                      - fieldName: Example field 1
                        fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                        value: 123
                      - fieldName: Example field 2
                        fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                        value: Example text 1
                    - id: 2
                      values:
                      - fieldName: Example field 1
                        fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                        value: 412
                      - fieldName: Example field 2
                        fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                        value: Example text 2
                    - id: 3
                      values:
                      - fieldName: Example field 1
                        fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                        value: 267
                      - fieldName: Example field 2
                        fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                        value: Example text 3
                    paging:
                      page: 1
                      size: 20
                      totalPages: 1
                      totalResults: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n    \n  <results>\n        \n    <id>1</id>\n        \n    <values>\n            \n      <fieldName>Example field 1</fieldName>\n            \n      <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n            \n      <value>123</value>\n          \n    </values>\n        \n    <values>\n            \n      <fieldName>Example field 2</fieldName>\n            \n      <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n            \n      <value>Example text 1</value>\n          \n    </values>\n      \n  </results>\n    \n  <results>\n        \n    <id>2</id>\n        \n    <values>\n            \n      <fieldName>Example field 1</fieldName>\n            \n      <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n            \n      <value>412</value>\n          \n    </values>\n        \n    <values>\n            \n      <fieldName>Example field 2</fieldName>\n            \n      <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n            \n      <value>Example text 2</value>\n          \n    </values>\n      \n  </results>\n    \n  <results>\n        \n    <id>3</id>\n        \n    <values>\n            \n      <fieldName>Example field 1</fieldName>\n            \n      <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n            \n      <value>267</value>\n          \n    </values>\n        \n    <values>\n            \n      <fieldName>Example field 2</fieldName>\n            \n      <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n            \n      <value>Example text 3</value>\n          \n    </values>\n      \n  </results>\n    \n  <paging>\n        \n    <page>1</page>\n        \n    <size>20</size>\n        \n    <totalPages>1</totalPages>\n        \n    <totalResults>3</totalResults>\n      \n  </paging>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:read
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Add items
      description: 'Use this method to add items to a specific catalog.<br><br>

        <strong>NOTE</strong><br>Response details:<ul><li>This endpoint only returns successful results</li><li>Other results are ignored</li><li>Errors are not returned</li>

        </ul><br><strong>NOTE</strong><br><ul><li>Maximum of <code>1000</code> item field values are allowed.</li></ul>'
      operationId: add-items
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogItemDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogItemDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - id: 10000
                    values:
                    - fieldName: Text field
                      fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                      value: Some text value
                    - fieldName: Number field
                      fieldId: 1ab3e732-8986-4d70-bdec-f89c3cbf042d
                      value: '2'
                    - fieldName: Decimal field
                      fieldId: 87897d8f-07ae-4b51-80a8-84db793144fb
                      value: 2,0005
                    - fieldName: Boolean field
                      fieldId: 87897d8f-07ae-4b51-80a8-ebb40d05533d
                      value: 'false'
                    - fieldName: Date field
                      fieldId: caad56e4-07ae-4ae8-9717-ebb40d05533d
                      value: '2022-01-12'
                    - fieldName: Time field
                      fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                      value: '10:10:10'
                    - fieldName: Date time field
                      fieldId: 87897d8f-07ae-8986-80a8-ebb40d05533d
                      value: '2022-01-12 10:10:10'
                  - id: 10001
                    values:
                    - fieldName: Text field
                      fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                      value: Some text value 3
                    - fieldName: Number field
                      fieldId: 1ab3e732-8986-4d70-bdec-f89c3cbf042d
                      value: '23'
                    - fieldName: Decimal field
                      fieldId: 87897d8f-07ae-4b51-80a8-84db793144fb
                      value: 22,0005
                    - fieldName: Boolean field
                      fieldId: 87897d8f-07ae-4b51-80a8-ebb40d05533d
                      value: 'false'
                    - fieldName: Date field
                      fieldId: caad56e4-07ae-4ae8-9717-ebb40d05533d
                      value: '2022-01-13'
                    - fieldName: Time field
                      fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                      value: '12:10:10'
                    - fieldName: Date time field
                      fieldId: 87897d8f-07ae-8986-80a8-ebb40d05533d
                      value: '2022-01-13 12:10:10'
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <element>\n            \n    <id>10000</id>\n            \n    <values>\n                  \n      <element>\n                        \n        <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n                        \n        <fieldName>Text field</fieldName>\n                        \n        <value>Some text value</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>1ab3e732-8986-4d70-bdec-f89c3cbf042d</fieldId>\n                        \n        <fieldName>Whole number field</fieldName>\n                        \n        <value>2</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-4b51-80a8-84db793144fb</fieldId>\n                        \n        <fieldName>Decimal number field</fieldName>\n                        \n        <value>2,0005</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-4b51-80a8-ebb40d05533d</fieldId>\n                        \n        <fieldName>Boolean field</fieldName>\n                        \n        <value>false</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>caad56e4-07ae-4ae8-9717-ebb40d05533d</fieldId>\n                        \n        <fieldName>Date field</fieldName>\n                        \n        <value>2022-01-12</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n                        \n        <fieldName>Time field</fieldName>\n                        \n        <value>10:10:10</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-8986-80a8-ebb40d05533d</fieldId>\n                        \n        <fieldName>Date time field</fieldName>\n                        \n        <value>2022-01-12 10:10:10</value>\n                    \n      </element>\n              \n    </values>\n        \n  </element>\n      \n  <element>\n            \n    <id>10001</id>\n            \n    <values>\n                  \n      <element>\n                        \n        <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n                        \n        <fieldName>Text field</fieldName>\n                        \n        <value>Some text value 2</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>1ab3e732-8986-4d70-bdec-f89c3cbf042d</fieldId>\n                        \n        <fieldName>Whole number field</fieldName>\n                        \n        <value>23</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-4b51-80a8-84db793144fb</fieldId>\n                        \n        <fieldName>Decimal number field</fieldName>\n                        \n        <value>22,0005</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-4b51-80a8-ebb40d05533d</fieldId>\n                        \n        <fieldName>Boolean field</fieldName>\n                        \n        <value>false</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>caad56e4-07ae-4ae8-9717-ebb40d05533d</fieldId>\n                        \n        <fieldName>Date field</fieldName>\n                        \n        <value>2022-01-13</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n                        \n        <fieldName>Time field</fieldName>\n                        \n        <value>12:10:10</value>\n                    \n      </element>\n                  \n      <element>\n                        \n        <fieldId>87897d8f-07ae-8986-80a8-ebb40d05533d</fieldId>\n                        \n        <fieldName>Date time field</fieldName>\n                        \n        <value>2022-01-13 12:10:10</value>\n                    \n      </element>\n              \n    </values>\n        \n  </element>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete items
      description: Use this method to delete a list of filtered items.
      operationId: delete-items
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: queryFilter
        in: query
        description: 'Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>AND</code></td><td>Joins query clauses with a logical AND. Returns all items that match the conditions of both clauses.<br><b>Example:</b> <code>price > 10.99 AND color == Red</code></td>

          </tr>

          <tr>

          <td><code>OR</code></td><td>Joins query clauses with a logical OR. Returns all items that match the conditions of either clause.<br><b>Example:</b> <code>type == Jeans OR type == Shirt</code></td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td>Greater than: <code>&gt;</code></td><td>integer, decimal</td><td>Matches values that are greater than a specified value.<br><b>Example:</b> <code>price &gt; 99.99</code></td>

          </tr>

          <tr>

          <td>Greater or equal: <code>&ge;</code></td><td>integer, decimal</td><td>Matches all values that are greater than or equal to a specified value.<br><b>Example:</b> <code>price &ge; 99.99</code> </td>

          </tr>

          <tr>

          <td>Less than: <code>&lt;</code></td><td>integer, decimal</td><td>Matches all values that are less than a specified value.<br><b>Example:</b> <code>price &lt; 99.99</code></td>

          </tr>

          <tr>

          <td>Less or equal: <code>&le;</code></td><td>integer, decimal</td><td>Matches all that are values less than or equal to a specified value.<br><b>Example:</b> <code>price &le; 99</code></td>

          </tr>

          <tr>

          <td>Equal: <code>==</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are equal to a specified value.<br><b>Example:</b> <code>color == <q>green</q></code></td>

          </tr>

          <tr>

          <td>Not equal: <code>!=</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are not equal to a specified value.<br><b>Example:</b> <code>color != <q>green</q></code></td>

          </tr>

          </table>


          ##### List of supported date/time range operators:


          <table>

          <thead>

          <th>Date/time Range Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range between dates.<br><b>Example:</b> <code>createdAt BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          <tr>

          <td><code>NOT BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range not between dates.<br><b>Example:</b> <code>createdAt NOT BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          </table>


          ##### List of supported string operators:


          <table>

          <thead>

          <th>String Operator&nbsp;&nbsp;&nbsp;</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>STARTS WITH</code></td><td>string</td><td>Matches all values starting with specific substring.<br><b>Example:</b> <code>name STARTS WITH <q>Bo</q></code></td>

          </tr>

          <tr>

          <td><code>ENDS WITH</code></td><td>string</td><td>Matches all values ending with specific substring.<br><b>Example:</b> <code>name ENDS WITH <q>an</q></code></td>

          </tr>

          </table>'
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: ( type == "Jeans" AND type == "Shirt" ) OR ( price > 10.99 AND color == "Red" )
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - platform
      summary: Update items
      description: Use this method to update list of filtered items.
      operationId: patch-items
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: queryFilter
        in: query
        description: 'Enables filtering items using [URL-encoded](https://www.w3schools.com/tags/ref_urlencode.asp) queries passed to a parameter. Wrap a catalog column name in square brackets `[]`, if the name contains UNICODE characters, e.g. `[文 本]` or a space, e.g. `[shirt type]`

          ##### List of supported logical operators:


          <table>

          <thead>

          <th>Logical Operator</th><th>Description</th>

          </thead>

          <tr>

          <td><code>AND</code></td><td>Joins query clauses with a logical AND. Returns all items that match the conditions of both clauses.<br><b>Example:</b> <code>price > 10.99 AND color == Red</code></td>

          </tr>

          <tr>

          <td><code>OR</code></td><td>Joins query clauses with a logical OR. Returns all items that match the conditions of either clause.<br><b>Example:</b> <code>type == Jeans OR type == Shirt</code></td>

          </tr>

          </table>


          ##### List of supported comparison operators:


          <table>

          <thead>

          <th>Comparison Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td>Greater than: <code>&gt;</code></td><td>integer, decimal</td><td>Matches values that are greater than a specified value.<br><b>Example:</b> <code>price &gt; 99.99</code></td>

          </tr>

          <tr>

          <td>Greater or equal: <code>&ge;</code></td><td>integer, decimal</td><td>Matches all values that are greater than or equal to a specified value.<br><b>Example:</b> <code>price &ge; 99.99</code> </td>

          </tr>

          <tr>

          <td>Less than: <code>&lt;</code></td><td>integer, decimal</td><td>Matches all values that are less than a specified value.<br><b>Example:</b> <code>price &lt; 99.99</code></td>

          </tr>

          <tr>

          <td>Less or equal: <code>&le;</code></td><td>integer, decimal</td><td>Matches all that are values less than or equal to a specified value.<br><b>Example:</b> <code>price &le; 99</code></td>

          </tr>

          <tr>

          <td>Equal: <code>==</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are equal to a specified value.<br><b>Example:</b> <code>color == <q>green</q></code></td>

          </tr>

          <tr>

          <td>Not equal: <code>!=</code></td><td>integer, decimal, string, date, time, dateTime</td><td>Matches values that are not equal to a specified value.<br><b>Example:</b> <code>color != <q>green</q></code></td>

          </tr>

          </table>


          ##### List of supported date/time range operators:


          <table>

          <thead>

          <th>Date/time Range Operator</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range between dates.<br><b>Example:</b> <code>createdAt BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          <tr>

          <td><code>NOT BETWEEN</code></td><td>date, time, dateTime</td><td>Specifies date/time range not between dates.<br><b>Example:</b> <code>createdAt NOT BETWEEN <q>2023-03-01</q> AND <q>2023-03-30</q></code></td>

          </tr>

          </table>


          ##### List of supported string operators:


          <table>

          <thead>

          <th>String Operator&nbsp;&nbsp;&nbsp;</th><th>Supported Type</th><th>Description</th>

          </thead>

          <tr>

          <td><code>STARTS WITH</code></td><td>string</td><td>Matches all values starting with specific substring.<br><b>Example:</b> <code>name STARTS WITH <q>Bo</q></code></td>

          </tr>

          <tr>

          <td><code>ENDS WITH</code></td><td>string</td><td>Matches all values ending with specific substring.<br><b>Example:</b> <code>name ENDS WITH <q>an</q></code></td>

          </tr>

          </table>'
        required: true
        style: form
        explode: true
        schema:
          type: string
        example: ( type == "Jeans" AND type == "Shirt" ) OR ( price > 10.99 AND color == "Red" )
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogValueDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{catalogId}/items/{itemId}:
    get:
      tags:
      - platform
      summary: Get item
      description: Use this method to get a specific item from a catalog.
      operationId: get-item-by-id
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: itemId
        in: path
        description: Item id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogItemDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                    id: 10000
                    values:
                    - fieldName: Text field
                      fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                      value: Some text value
                    - fieldName: Numeric field
                      fieldId: 1ab3e732-8986-4d70-bdec-f89c3cbf042d
                      value: '2'
                    - fieldName: Decimal field
                      fieldId: 87897d8f-07ae-4b51-80a8-84db793144fb
                      value: 2,0005
                    - fieldName: Boolean field
                      fieldId: 87897d8f-07ae-4b51-80a8-ebb40d05533d
                      value: 'false'
                    - fieldName: Date field
                      fieldId: caad56e4-07ae-4ae8-9717-ebb40d05533d
                      value: '2022-01-12'
                    - fieldName: Time field
                      fieldId: 87897d8f-8986-4d70-bdec-f89c3cbf042d
                      value: '10:10:10'
                    - fieldName: Date time field
                      fieldId: 87897d8f-07ae-8986-80a8-ebb40d05533d
                      value: '2022-01-12 10:10:10'
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<root>\n    <id>10000</id>\n    <values>\n        <element>\n            <fieldName>Text Field</fieldName>\n            <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n            <value>Some text value</value>\n        </element>\n        <element>\n            <fieldName>Numeric Field</fieldName>\n            <fieldId>1ab3e732-8986-4d70-bdec-f89c3cbf042d</fieldId>\n            <value>2</value>\n            </element>\n        <element>\n            <fieldName>Decimal Field</fieldName>\n            <fieldId>87897d8f-07ae-4b51-80a8-84db793144fb</fieldId>\n            <value>2,0005</value>\n        </element>\n        <element>\n            <fieldName>Boolean Field</fieldName>\n            <fieldId>87897d8f-07ae-4b51-80a8-ebb40d05533d</fieldId>\n            <value>false</value>\n        </element>\n        <element>\n            <fieldName>Date Field</fieldName>\n            <fieldId>caad56e4-07ae-4ae8-9717-ebb40d05533d</fieldId>\n            <value>2022-01-12</value>\n        </element>\n        <element>\n            <fieldName>Time Field</fieldName>\n            <fieldId>87897d8f-8986-4d70-bdec-f89c3cbf042d</fieldId>\n            <value> 10:10:10 </value>\n        </element>\n        <element>\n            <fieldName>Date time Field</fieldName>\n            <fieldId>87897d8f-07ae-8986-80a8-ebb40d05533d</fieldId>\n            <value>2022-01-12 10:10:10</value>\n        </element>\n    </fields>\n</root>"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: No records found.
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>No records found.</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:read
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete item
      description: Use this method to delete a specific item.
      operationId: delete-item
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: itemId
        in: path
        description: Item id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: No records found.
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>No records found.</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - platform
      summary: Update item
      description: Use this method to update the field values of items.
      operationId: patch-item
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      - name: itemId
        in: path
        description: Item id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogValueDto'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogValueDto'
              examples:
                Response example:
                  summary: Response example
                  value:
                  - fieldName: Updated Name
                    fieldId: caad56e4-2a1c-4ae8-9717-ebb40d05533d
                    value: Updated value
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><Array>\n      \n  <CatalogValueUpdateDTO>\n            \n    <catalogId>1000</catalogId>\n            \n    <itemId>1000</itemId>\n            \n    <fieldId>caad56e4-2a1c-4ae8-9717-ebb40d05533d</fieldId>\n            \n    <value>updated value</value>\n        \n  </CatalogValueUpdateDTO>\n  \n</Array>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: No records found.
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>No records found.</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /catalogs/1/catalogs/{catalogId}/items/count:
    get:
      tags:
      - platform
      summary: Get item count
      description: Use this method to get the total number of items in a specific catalog.
      operationId: get-item-count
      parameters:
      - name: catalogId
        in: path
        description: Catalog id.
        required: true
        style: simple
        explode: false
        schema:
          type: integer
          format: int64
        example: 10000
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    count: 3
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><root>\n      \n  <count>3</count>\n  \n</root>\n"
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: BAD_REQUEST
                        text: Bad request
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>BAD_REQUEST</messageId>\n                  \n      <text>Bad request</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException'
              examples:
                Response example:
                  summary: Response example
                  value:
                    requestError:
                      serviceException:
                        messageId: NOT_FOUND
                        text: Catalog is not found
            application/xml:
              examples:
                Response example:
                  summary: Response example
                  value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><ApiException>\n      \n  <requestError>\n            \n    <serviceException>\n                  \n      <messageId>NOT_FOUND</messageId>\n                  \n      <text>Catalog is not found</text>\n              \n    </serviceException>\n        \n  </requestError>\n  \n</ApiException>\n"
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - catalogs:manage
      - catalogs:read
      - catalogs:use
      x-throttling-info:
      - type: time
        numberOfRequests: 5
        numberOfTimeUnits: 0
        timeUnit: s
  /messages-api/1/messages:
    post:
      tags:
      - platform
      summary: Send a Messages API message
      description: Send messages at scale through multiple channels, utilizing various message types.
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: send-messages-api-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest'
            examples:
              Text message APPLE_MB:
                summary: Text message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Text message with buttons APPLE_MB:
                summary: Text message with buttons
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Image message APPLE_MB:
                summary: Image message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Video message APPLE_MB:
                summary: Video message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Document message APPLE_MB:
                summary: Document message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Rich link message APPLE_MB:
                summary: Rich link message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        type: RICH_LINK
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Authentication request message APPLE_MB:
                summary: Authentication request message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Authentication!
                        type: AUTHENTICATION_REQUEST
                      confirmationBody:
                        text: Thank you!
                        imageUrl: https://example.com/authenticated.jpg
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              List message APPLE_MB:
                summary: List message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                      confirmationBody:
                        text: Thanks!
                        imageUrl: https://example.com/thanks.jpg
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Carousel message APPLE_MB:
                summary: Carousel message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  For APPLE_MB non template messages can only be sent after user initiates session.'
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        cards:
                        - body:
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Sticker message APPLE_MB:
                summary: Sticker message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  For APPLE_MB non template messages can only be sent after user initiates session.'
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Mixed message APPLE_MB:
                summary: Mixed message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        items:
                        - url: https://example.com/example1.jpg
                        - url: https://example.com/example2.jpg
                        - url: https://example.com/example3.jpg
                        type: MIXED
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Time picker message APPLE_MB:
                summary: Time picker message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: When do you want to meet?
                        imageUrl: https://example.com/image.jpg
                        event:
                          title: Important meeting
                          timeslots:
                          - duration: 3600
                            startTime: '2035-05-26T08:30:00Z'
                          - duration: 3600
                            startTime: '2035-05-26T09:30:00Z'
                          location:
                            latitude: 44.95305
                            longitude: 13.85637
                            radius: 50.0
                            name: Infobip d.o.o.
                        type: TIME_PICKER
                      confirmationBody:
                        text: Thanks!
                        imageUrl: https://example.com/thanks.jpg
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Order request message APPLE_MB:
                summary: Order request message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Message text
                        subtext: Message subtitle
                        imageUrl: https://example.com/image.jpg
                        order:
                          items:
                          - name: Item name
                            retailerId: retailerId
                            amount: 100
                        payment:
                          configuration:
                            merchantDomain: customMerchantDomain
                            merchantDisplayName: customMerchantDisplayName
                            type: APPLE_PAY
                          total:
                            value: 75
                            description: Total description
                        shippings:
                        - amount: 10
                          description: Shipping description
                          identifier: identified
                          label: label
                        type: ORDER_REQUEST
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Template message with parameters APPLE_MB:
                summary: Template message with parameters
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: binaryChoice.engage.noImage
                      language: en-us
                      referenceId: referenceId
                    content:
                      body:
                        type: TEXT
                        brandName: Infobip
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - template
              Text message with options and webhooks APPLE_MB:
                summary: Text message with options and webhooks
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking APPLE_MB:
                summary: Text message with scheduling and URL shortening and tracking
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message/template with options
              Text message with failover to other channels APPLE_MB:
                summary: Text message with failover to other channels
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - byChannel:
                      - channel: APPLE_MB
                        to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      - channel: INSTAGRAM_DM
                        to: '768938852147373'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: INSTAGRAM_DM
                      sender: '17841447232797249'
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message/template with options
              Template message with parameters with failover to other channels APPLE_MB:
                summary: Template message with parameters with failover to other channels
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - byChannel:
                      - channel: APPLE_MB
                        to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      - channel: INSTAGRAM_DM
                        to: '768938852147373'
                      - channel: LINE_ON
                        to: '123456789'
                    template:
                      templateName: binaryChoice.engage.noImage
                      language: en-us
                      referenceId: referenceId
                    content:
                      body:
                        type: TEXT
                        brandName: Infobip
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                        receiveTriggeredFailoverReports: true
                      callbackData: callbackData
                    failover:
                    - channel: INSTAGRAM_DM
                      sender: '17841447232797249'
                      content:
                        body:
                          text: Hello, how are you?
                          type: TEXT
                    - channel: LINE_ON
                      sender: LINE IB Test
                      content:
                        body:
                          url: https://example.com/image.jpg
                          text: Hello, how are you?
                          type: IMAGE
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message/template with options
              Form message APPLE_MB:
                summary: Form message
                description: For APPLE_MB non template messages can only be sent after user initiates session.
                value:
                  messages:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    content:
                      body:
                        text: Please fill this form to receive absolutely nothing!
                        imageUrl: https://example.com/image.jpg
                        pages:
                        - title: Welcome to the form!
                          text: Please fill all fields.
                          buttonText: Proceed to first question
                          imageUrl: https://example.com/image.jpg
                          type: INTRO
                        - title: First page
                          text: What is your name?
                          pageIdentifier: '1'
                          nextPageIdentifier: '2'
                          submitForm: false
                          options:
                            hintText: A small hint
                            placeholder: Insert your name
                            isRequired: false
                            inputType: SINGLELINE
                            labelText: Name
                            maximumCharacterCount: 30
                            keyboardType: DEFAULT
                            textContentType: GIVEN_NAME
                          type: INPUT
                        - title: Second page
                          text: Pick your favourite animal
                          pageIdentifier: '2'
                          nextPageIdentifier: '3'
                          items:
                          - identifier: 2-1
                            title: Dog
                            value: dog
                          - identifier: 2-2
                            title: Cat
                            value: cat
                          submitForm: false
                          subtext: Choose an animal
                          selectedItemIndex: 0
                          type: PICKER
                        - title: Third page
                          text: Select two colours of your liking
                          pageIdentifier: '3'
                          nextPageIdentifier: '4'
                          items:
                          - identifier: 3-1
                            title: Red
                            value: red
                          - identifier: 3-2
                            title: Green
                            value: green
                          - identifier: 3-1
                            title: Blue
                            value: blue
                          submitForm: false
                          multipleSelection: true
                          type: SELECT
                        - title: Fourth page
                          text: When is your birthday?
                          pageIdentifier: '4'
                          submitForm: true
                          options:
                            dateFormat: yyyy-MM-DD
                            startDate: '2025-01-01T14:00:00Z'
                            maximumDate: '2025-01-01T14:00:00Z'
                            minimumDate: '1900-01-01T14:00:00Z'
                            dateLabel: Your birthday
                          type: DATE_PICKER
                        startPageIdentifier: '1'
                        isPrivate: false
                        showSummary: false
                        type: FORM
                      confirmationBody:
                        text: Thank you!
                        imageUrl: https://example.com/form.jpg
                x-label:
                  channel:
                  - APPLE_MB
                  message type:
                  - message
              Text message INSTAGRAM_DM:
                summary: Text message
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Text message with buttons INSTAGRAM_DM:
                summary: Text message with buttons
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Image message INSTAGRAM_DM:
                summary: Image message
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Video message INSTAGRAM_DM:
                summary: Video message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in INSTAGRAM_DM channel is user initiated.'
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Document message INSTAGRAM_DM:
                summary: Document message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in INSTAGRAM_DM channel is user initiated.'
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Rich link message INSTAGRAM_DM:
                summary: Rich link message
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        buttonText: Click here
                        type: RICH_LINK
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              List message INSTAGRAM_DM:
                summary: List message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in INSTAGRAM_DM channel is user initiated.'
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Carousel message INSTAGRAM_DM:
                summary: Carousel message
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        cards:
                        - body:
                            title: Otter Plushie
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        - body:
                            title: Penguin Plushie
                            text: Waddle with adorable penguin friend
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Penguin
                            url: https://example.com/penguin
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Location message INSTAGRAM_DM:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in INSTAGRAM_DM channel is user initiated.'
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Sticker message INSTAGRAM_DM:
                summary: Sticker message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in INSTAGRAM_DM channel is user initiated.'
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message
              Text message with options and webhooks INSTAGRAM_DM:
                summary: Text message with options and webhooks
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking INSTAGRAM_DM:
                summary: Text message with scheduling and URL shortening and tracking
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - to: '768938852147373'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message/template with options
              Text message with failover to other channels INSTAGRAM_DM:
                summary: Text message with failover to other channels
                description: Communication in INSTAGRAM_DM channel is user initiated.
                value:
                  messages:
                  - channel: INSTAGRAM_DM
                    sender: '17841447232797249'
                    destinations:
                    - byChannel:
                      - channel: INSTAGRAM_DM
                        to: '768938852147373'
                      - channel: LINE_ON
                        to: '123456789'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: LINE_ON
                      sender: LINE IB Test
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - INSTAGRAM_DM
                  message type:
                  - message/template with options
              Text message LINE_ON:
                summary: Text message
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Text message with buttons LINE_ON:
                summary: Text message with buttons
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Check vibes
                        url: https://example.com/vibes
                        type: OPEN_URL
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Image message LINE_ON:
                summary: Image message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Video message LINE_ON:
                summary: Video message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Document message LINE_ON:
                summary: Document message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Location message LINE_ON:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message
              Text message with options and webhooks LINE_ON:
                summary: Text message with options and webhooks
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking LINE_ON:
                summary: Text message with scheduling and URL shortening and tracking
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message/template with options
              Text message with failover to other channels LINE_ON:
                summary: Text message with failover to other channels
                value:
                  messages:
                  - channel: LINE_ON
                    sender: LINE IB Test
                    destinations:
                    - byChannel:
                      - channel: LINE_ON
                        to: '123456789'
                      - channel: MESSENGER
                        to: '24060905360217212'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: MESSENGER
                      sender: '731401526720514'
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - LINE_ON
                  message type:
                  - message/template with options
              Text message MESSENGER:
                summary: Text message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Text message with buttons MESSENGER:
                summary: Text message with buttons
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Image message MESSENGER:
                summary: Image message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Video message MESSENGER:
                summary: Video message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Document message MESSENGER:
                summary: Document message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Rich link message MESSENGER:
                summary: Rich link message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        buttonText: Click here
                        type: RICH_LINK
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              List message MESSENGER:
                summary: List message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in MESSENGER channel is user initiated.'
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Carousel message MESSENGER:
                summary: Carousel message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        cards:
                        - body:
                            title: Otter Plushie
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        - body:
                            title: Penguin Plushie
                            text: Waddle with adorable penguin friend
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Penguin
                            url: https://example.com/penguin
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Location message MESSENGER:
                summary: Location message
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Sticker message MESSENGER:
                summary: Sticker message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in MESSENGER channel is user initiated.'
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message
              Text message with options and webhooks MESSENGER:
                summary: Text message with options and webhooks
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking MESSENGER:
                summary: Text message with scheduling and URL shortening and tracking
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - to: '24060905360217212'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message/template with options
              Text message with failover to other channels MESSENGER:
                summary: Text message with failover to other channels
                description: Communication in MESSENGER channel is user initiated.
                value:
                  messages:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destinations:
                    - byChannel:
                      - channel: MESSENGER
                        to: '24060905360217212'
                      - channel: MMS
                        to: '123456789'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: MMS
                      sender: '10950'
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - MESSENGER
                  message type:
                  - message/template with options
              Text message MMS:
                summary: Text message
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Image message MMS:
                summary: Image message
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Video message MMS:
                summary: Video message
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Document message MMS:
                summary: Document message
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Rich link message MMS:
                summary: Rich link message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        type: RICH_LINK
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Carousel message MMS:
                summary: Carousel message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        cards:
                        - body:
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Location message MMS:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Sticker message MMS:
                summary: Sticker message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Mixed message MMS:
                summary: Mixed message
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        items:
                        - url: https://example.com/example1.jpg
                        - text: Some text
                        - url: https://example.com/example3.jpg
                        type: MIXED
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message
              Text message with options and webhooks MMS:
                summary: Text message with options and webhooks
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking MMS:
                summary: Text message with scheduling and URL shortening and tracking
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message/template with options
              Text message with failover to other channels MMS:
                summary: Text message with failover to other channels
                value:
                  messages:
                  - channel: MMS
                    sender: '10950'
                    destinations:
                    - byChannel:
                      - channel: MMS
                        to: '123456789'
                      - channel: RCS
                        to: '123456789'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: RCS
                      sender: ibpDemoPly
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - MMS
                  message type:
                  - message/template with options
              Text message RCS:
                summary: Text message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Text message with buttons RCS:
                summary: Text message with buttons
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Image message RCS:
                summary: Image message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Video message RCS:
                summary: Video message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Document message RCS:
                summary: Document message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Rich link message RCS:
                summary: Rich link message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        buttonText: Click here
                        type: RICH_LINK
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              List message RCS:
                summary: List message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Carousel message RCS:
                summary: Carousel message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        cards:
                        - body:
                            title: Otter Plushie
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        - body:
                            title: Penguin Plushie
                            text: Waddle with adorable penguin friend
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Penguin
                            url: https://example.com/penguin
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Location message RCS:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message
              Template message RCS:
                summary: Template message
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                x-label:
                  channel:
                  - RCS
                  message type:
                  - template
              Template message with parameters RCS:
                summary: Template message with parameters
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                    content:
                      body:
                        type: TEXT
                        custom_param_1: Infobip
                        custom_param_2: 5:30 AM
                x-label:
                  channel:
                  - RCS
                  message type:
                  - template
              Text message with options and webhooks RCS:
                summary: Text message with options and webhooks
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                      seen:
                        url: https://example.com/seen-webhook
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking RCS:
                summary: Text message with scheduling and URL shortening and tracking
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message/template with options
              Text message with failover to other channels RCS:
                summary: Text message with failover to other channels
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - byChannel:
                      - channel: RCS
                        to: '123456789'
                      - channel: SMS
                        to: '123456789'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: SMS
                      sender: '447491163862'
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message/template with options
              Template message with parameters with failover to other channels RCS:
                summary: Template message with parameters with failover to other channels
                value:
                  messages:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - byChannel:
                      - channel: RCS
                        to: '123456789'
                      - channel: SMS
                        to: '123456789'
                      - channel: VIBER_BM
                        to: '123456789'
                    template:
                      templateName: templateName
                    content:
                      body:
                        type: TEXT
                        custom_param_1: Infobip
                        custom_param_2: 5:30 AM
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                        receiveTriggeredFailoverReports: true
                      callbackData: callbackData
                    failover:
                    - channel: SMS
                      sender: '447491163862'
                      content:
                        body:
                          text: Hello, how are you?
                          type: TEXT
                    - channel: VIBER_BM
                      sender: InfobipDemo
                      content:
                        body:
                          url: https://example.com/image.jpg
                          text: Hello, how are you?
                          type: IMAGE
                x-label:
                  channel:
                  - RCS
                  message type:
                  - message/template with options
              Text message SMS:
                summary: Text message
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message
              Image message SMS:
                summary: Image message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message
              Video message SMS:
                summary: Video message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message
              Document message SMS:
                summary: Document message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message
              Location message SMS:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message
              Text message with options and webhooks SMS:
                summary: Text message with options and webhooks
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking SMS:
                summary: Text message with scheduling and URL shortening and tracking
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message/template with options
              Text message with failover to other channels SMS:
                summary: Text message with failover to other channels
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - byChannel:
                      - channel: SMS
                        to: '123456789'
                      - channel: VIBER_BM
                        to: '123456789'
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: VIBER_BM
                      sender: InfobipDemo
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - SMS
                  message type:
                  - message/template with options
              Text message VIBER_BM:
                summary: Text message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Text message with buttons VIBER_BM:
                summary: Text message with buttons
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Check vibes
                        url: https://example.com/vibes
                        type: OPEN_URL
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Image message VIBER_BM:
                summary: Image message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Video message VIBER_BM:
                summary: Video message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        thumbnailUrl: https://example.com/thumbnail.jpg
                        type: VIDEO
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Document message VIBER_BM:
                summary: Document message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        filename: document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Rich link message VIBER_BM:
                summary: Rich link message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        buttonText: Click here
                        type: RICH_LINK
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Carousel message VIBER_BM:
                summary: Carousel message
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      header:
                        text: Check our plushies
                        type: TEXT
                      body:
                        cards:
                        - body:
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        - body:
                            text: Waddle with adorable penguin friend
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Penguin
                            url: https://example.com/penguin
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Location message VIBER_BM:
                summary: Location message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Sticker message VIBER_BM:
                summary: Sticker message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  '
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message
              Template message with parameters VIBER_BM:
                summary: Template message with parameters
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: 0aac888f-2ee2-4112-9659-1755a951966a
                      language: en
                    content:
                      body:
                        pin: '1234'
                        type: TEXT
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - template
              Text message with options and webhooks VIBER_BM:
                summary: Text message with options and webhooks
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                      seen:
                        url: https://example.com/seen-webhook
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Text message with traffic type option VIBER_BM:
                summary: Text message with traffic type option
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      adaptationMode: false
                      trafficType: TRANSACTIONAL
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Text message with enabled session rate and primary device only options VIBER_BM:
                summary: Text message with enabled session rate and primary device only options
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      adaptationMode: false
                      sessionRate: true
                      primaryDevice: true
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking VIBER_BM:
                summary: Text message with scheduling and URL shortening and tracking
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Text message with failover to other channels VIBER_BM:
                summary: Text message with failover to other channels
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - byChannel:
                      - channel: VIBER_BM
                        to: '123456789'
                      - channel: VIBER_BOT
                        to: SirE8dEwjQEda4/VugaE+A==
                      - channel: WHATSAPP
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: VIBER_BOT
                      sender: pa:5964217479313231708
                    - channel: WHATSAPP
                      sender: '447491163862'
                      template:
                        templateName: givenTemplateName
                        language: en
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Template message with parameters with failover to other channels VIBER_BM:
                summary: Template message with parameters with failover to other channels
                value:
                  messages:
                  - channel: VIBER_BM
                    sender: InfobipDemo
                    destinations:
                    - byChannel:
                      - channel: VIBER_BM
                        to: '123456789'
                      - channel: VIBER_BOT
                        to: SirE8dEwjQEda4/VugaE+A==
                      - channel: WHATSAPP
                        to: '123456789'
                    template:
                      templateName: 0aac888f-2ee2-4112-9659-1755a951966a
                      language: en
                    content:
                      body:
                        pin: '1234'
                        type: TEXT
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                        receiveTriggeredFailoverReports: true
                      callbackData: callbackData
                    failover:
                    - channel: VIBER_BOT
                      sender: pa:5964217479313231708
                      content:
                        body:
                          text: Hello, how are you?
                          type: TEXT
                    - channel: WHATSAPP
                      sender: '447491163862'
                      content:
                        body:
                          url: https://example.com/image.jpg
                          text: Hello, how are you?
                          type: IMAGE
                x-label:
                  channel:
                  - VIBER_BM
                  message type:
                  - message/template with options
              Text message VIBER_BOT:
                summary: Text message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Text message with senderDisplayInfo VIBER_BOT:
                summary: Text message with senderDisplayInfo
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      senderDisplayInfo:
                        name: Company name
                        avatarUrl: https://example.com/avatarUrl.jpg
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Text message with buttons VIBER_BOT:
                summary: Text message with buttons
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Image message VIBER_BOT:
                summary: Image message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Video message VIBER_BOT:
                summary: Video message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Document message VIBER_BOT:
                summary: Document message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        url: https://example.com/document.pdf
                        filename: document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Rich link message VIBER_BOT:
                summary: Rich link message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        buttonText: Click here
                        type: RICH_LINK
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              List message VIBER_BOT:
                summary: List message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  Communication in VIBER_BOT channel is user initiated.'
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Carousel message VIBER_BOT:
                summary: Carousel message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        cards:
                        - body:
                            title: Otter Plushie
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        - body:
                            title: Penguin Plushie
                            text: Waddle with adorable penguin friend
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Penguin
                            url: https://example.com/penguin
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Location message VIBER_BOT:
                summary: Location message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        type: LOCATION
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Contact message VIBER_BOT:
                summary: Contact message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        name: Some Something
                        phoneNumber: '123456789'
                        type: CONTACT
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Sticker message VIBER_BOT:
                summary: Sticker message
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        reference: '40133'
                        type: STICKER
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message
              Text message with options and webhooks VIBER_BOT:
                summary: Text message with options and webhooks
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                      seen:
                        url: https://example.com/seen-webhook
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking VIBER_BOT:
                summary: Text message with scheduling and URL shortening and tracking
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - to: SirE8dEwjQEda4/VugaE+A==
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message/template with options
              Text message with failover to other channels VIBER_BOT:
                summary: Text message with failover to other channels
                description: Communication in VIBER_BOT channel is user initiated.
                value:
                  messages:
                  - channel: VIBER_BOT
                    sender: pa:5964217479313231708
                    destinations:
                    - byChannel:
                      - channel: VIBER_BOT
                        to: SirE8dEwjQEda4/VugaE+A==
                      - channel: WHATSAPP
                        to: '123456789'
                      - channel: RCS
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: WHATSAPP
                      sender: '447491163862'
                    - channel: RCS
                      sender: ibpDemoPly
                      template:
                        templateName: givenTemplateName
                x-label:
                  channel:
                  - VIBER_BOT
                  message type:
                  - message/template with options
              Text message WHATSAPP:
                summary: Text message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Text message with buttons WHATSAPP:
                summary: Text message with buttons
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                      buttons:
                      - text: Thank you
                        postbackData: thanks
                        type: REPLY
                      - text: I send you more :3
                        postbackData: more
                        type: REPLY
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Image message WHATSAPP:
                summary: Image message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/image.jpg
                        type: IMAGE
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Video message WHATSAPP:
                summary: Video message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/video.mp4
                        type: VIDEO
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Document message WHATSAPP:
                summary: Document message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        url: https://example.com/document.pdf
                        type: DOCUMENT
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Rich link message WHATSAPP:
                summary: Rich link message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.'
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        redirectUrl: https://example.com
                        text: Have a bear-y good day!
                        url: https://example.com/image.jpg
                        isVideo: false
                        type: RICH_LINK
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              List message WHATSAPP:
                summary: List message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Welcome to the Safari Adventure Crew!
                        subtext: Adjust your trip
                        sections:
                        - sectionTitle: Essentials
                          items:
                          - text: Binoculars
                          - text: Safari Hat
                        - sectionTitle: Animals to Meet
                          items:
                          - text: Elephant
                          - text: Zebra
                        type: LIST
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Carousel message WHATSAPP:
                summary: Carousel message
                description: 'Message type is not fully or natively supported by the channel and will be adapted.

                  For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.'
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        cards:
                        - body:
                            text: Cuddle with softest otter in the river
                            url: https://example.com/image.png
                            isVideo: false
                          buttons:
                          - text: Otter
                            url: https://example.com/otter
                            postbackData: postbackData
                            type: OPEN_URL
                        type: CAROUSEL
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Location message WHATSAPP:
                summary: Location message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        latitude: 44.95305
                        longitude: 13.85637
                        name: Infobip d.o.o.
                        address: Istarska 157, 52215 Vodnjan, Croatia
                        type: LOCATION
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Contact message WHATSAPP:
                summary: Contact message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        name: Some Something
                        phoneNumber: '123456789'
                        type: CONTACT
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Sticker message WHATSAPP:
                summary: Sticker message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        reference: https://example.com/sticker.webp
                        type: STICKER
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Product message WHATSAPP:
                summary: Product message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      header:
                        text: Check our products
                        type: TEXT
                      body:
                        text: New watches.
                        catalogId: '3735864913400897'
                        sections:
                        - title: New watch
                          productRetailerIds:
                          - pf8e9cpb9u
                        - title: Another watch
                          productRetailerIds:
                          - a92wdavv4a
                        - title: Another new watch
                          productRetailerIds:
                          - 5m9rpwuk95
                        type: PRODUCT
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Flow message WHATSAPP:
                summary: Flow message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Share with us your opinion
                        id: '1049250280482345'
                        token: tokenForTracking
                        buttonText: Click Me!
                        mode: PUBLISHED
                        action:
                          payload:
                            screen: BOOKING_DETAILS
                          type: NAVIGATE
                        type: FLOW
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Order request message WHATSAPP:
                summary: Order request message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Message text
                        imageUrl: https://example.com/image.jpg
                        order:
                          catalogId: catalogId
                          currency: INR
                          type: DIGITAL_GOODS
                          items:
                          - name: Item name
                            retailerId: retailerId
                            quantity: 1
                            amount: 100
                            saleAmount: 50
                          expiration:
                            timestamp: '2024-02-06T14:18:29.797Z'
                            description: Description of the expiration
                        payment:
                          configuration:
                            id: paymentId
                            name: paymentConfigurationName
                            productDescription: description of product in order
                            customerFirstName: customerFirstName
                            customerLastName: customerLastName
                            customerEmail: customerEmail@example.com
                            callbackData:
                            - callbackData
                            type: UPI_PAYU
                          total:
                            value: 75
                          subtotal: 50
                          tax:
                            value: 25
                            description: Tax description
                          discount:
                            value: 10
                            description: Discount description
                        shippings:
                        - amount: 10
                          description: Shipping description
                        type: ORDER_REQUEST
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Order status message WHATSAPP:
                summary: Order status message
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        title: Message text
                        id: orderId
                        orderType: UPI_PAYU
                        orderStatus: PENDING
                        type: ORDER_STATUS
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message
              Template message WHATSAPP:
                summary: Template message
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                      language: en
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - template
              Template message with parameters WHATSAPP:
                summary: Template message with parameters
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                      language: en
                    content:
                      body:
                        type: TEXT
                        '1': Infobip
                        '2': 5:30 AM
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - template
              Template message with parameters and dynamic URL buttons WHATSAPP:
                summary: Template message with parameters and dynamic URL buttons
                description: If template has defined static URL buttons they should be omitted in request.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                      language: en
                    content:
                      body:
                        type: TEXT
                        '1': Infobip
                        '2': 5:30 AM
                      buttons:
                      - suffix: example1
                        type: OPEN_URL
                      - suffix: example2
                        type: OPEN_URL
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - template
              Template authentication message with copy code button WHATSAPP:
                summary: Template authentication message with copy code button
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                      language: en
                    content:
                      body:
                        type: TEXT
                        '1': Infobip
                        '2': '12345'
                      buttons:
                      - suffix: '12345'
                        type: OPEN_URL
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - template
              Template carousel message WHATSAPP:
                summary: Template carousel message
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    template:
                      templateName: templateName
                      language: en
                    content:
                      body:
                        cards:
                        - header:
                            url: https://example.com/giraffe.jpg
                            type: IMAGE
                          body:
                            '1': Girafffe
                          buttons:
                          - postbackData: giraffe
                            type: QUICK_REPLY
                        - header:
                            url: https://example.com/zebra.jpg
                            type: IMAGE
                          body:
                            '1': Zebra
                          buttons:
                          - postbackData: zebra
                            type: QUICK_REPLY
                        type: CAROUSEL
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - template
              Text message with options and webhooks WHATSAPP:
                summary: Text message with options and webhooks
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    options:
                      platform:
                        entityId: entityId
                        applicationId: applicationId
                      validityPeriod:
                        amount: 10
                        timeUnit: MINUTES
                      adaptationMode: false
                      campaignReferenceId: campaignReferenceId
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                      callbackData: callbackData
                      seen:
                        url: https://example.com/seen-webhook
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message/template with options
              Text message with scheduling and URL shortening and tracking WHATSAPP:
                summary: Text message with scheduling and URL shortening and tracking
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                  options:
                    schedule:
                      bulkId: bulkId
                      sendAt: '2025-10-01T00:00:00.000Z'
                    tracking:
                      shortenUrl: true
                      trackClicks: true
                      trackingUrl: https://example.com/track-url
                      removeProtocol: true
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message/template with options
              Text message with failover to other channels WHATSAPP:
                summary: Text message with failover to other channels
                description: For WHATSAPP non template messages can only be sent during open 24-hour messaging window, otherwise use template messages.
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - byChannel:
                      - channel: WHATSAPP
                        to: '123456789'
                      - channel: APPLE_MB
                        to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      - channel: RCS
                        to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
                    failover:
                    - channel: APPLE_MB
                      sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    - channel: RCS
                      sender: ibpDemoPly
                      template:
                        templateName: givenTemplateName
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message/template with options
              Template message with parameters with failover to other channels WHATSAPP:
                summary: Template message with parameters with failover to other channels
                value:
                  messages:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - byChannel:
                      - channel: WHATSAPP
                        to: '123456789'
                      - channel: APPLE_MB
                        to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      - channel: INSTAGRAM_DM
                        to: '768938852147373'
                    template:
                      templateName: templateName
                      language: en
                    content:
                      body:
                        type: TEXT
                        '1': Infobip
                        '2': 5:30 AM
                    webhooks:
                      delivery:
                        url: https://example.com/delivery-webhook
                        receiveTriggeredFailoverReports: true
                      callbackData: callbackData
                    failover:
                    - channel: APPLE_MB
                      sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                      content:
                        body:
                          text: Hello, how are you?
                          type: TEXT
                    - channel: INSTAGRAM_DM
                      sender: '17841447232797249'
                      content:
                        body:
                          url: https://example.com/image.jpg
                          text: Hello, how are you?
                          type: IMAGE
                x-label:
                  channel:
                  - WHATSAPP
                  message type:
                  - message/template with options
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: '1688025180464000013'
                    messages:
                    - messageId: '1688025180464000014'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: MESSAGE_ACCEPTED
                        description: Message sent to next instance
                      destination: '48600700800'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messages-api:message:send
      - messages-api:manage
  /messages-api/1/messages/validate:
    post:
      tags:
      - platform
      summary: Validate a Messages API message
      description: 'Perform a detailed validation of Messages API messages. This endpoint executes more specific checks than the `/messages` endpoint such as: possible channel-specific validations, verification of each failover step and unknown fields. Returns `200 OK` when the request would be accepted by the platform or `400 BAD_REQUEST` when it may fail at any point. Use this endpoint to validate messages before sending them to catch potential issues early.'
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: validate-messages-api-message
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest'
            examples:
              Validate correct request example:
                summary: Validate correct request example
                value:
                  messages:
                  - channel: SMS
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    content:
                      body:
                        text: Sending you lots of otterly delightful vibes today!
                        type: TEXT
      responses:
        '200':
          description: Message accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationOkResponse'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    description: Request can be sent through '/messages' endpoint and should be accepted by our platform.
                    action: No action is required, but it is recommended to check and address any violations.
                    skippableViolations:
                    - property: messages[0].metadata
                      violation: Unknown property
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationBadResponse'
              examples:
                Error response:
                  summary: Error response
                  value:
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: messages[0].content.body
                      violation: invalid value
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messages-api:message:send
      - messages-api:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /messages-api/1/events:
    post:
      tags:
      - platform
      summary: Send a Messages API event
      description: 'Send one or more events to multiple recipients.


        An event is an interaction with end-user''s device which does not impact messaging content of conversation.


        Examples of events are: TYPING_STARTED, TYPING_STOPPED.'
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: send-messages-api-events
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventRequest'
            examples:
              Typing started event APPLE_MB:
                summary: Typing started event
                value:
                  events:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    event: TYPING_STARTED
                x-label:
                  channel:
                  - APPLE_MB
              Typing stopped event APPLE_MB:
                summary: Typing stopped event
                value:
                  events:
                  - channel: APPLE_MB
                    sender: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    destinations:
                    - to: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    event: TYPING_STOPPED
                x-label:
                  channel:
                  - APPLE_MB
              Typing started event RCS:
                summary: Typing started event
                value:
                  events:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    event: TYPING_STARTED
                x-label:
                  channel:
                  - RCS
              Seen event RCS:
                summary: Seen event
                value:
                  events:
                  - channel: RCS
                    sender: ibpDemoPly
                    destinations:
                    - to: '123456789'
                    messageId: 1234-5678-abcd-efgh
                    event: SEEN
                x-label:
                  channel:
                  - RCS
              Typing started event WHATSAPP:
                summary: Typing started event
                value:
                  events:
                  - channel: WHATSAPP
                    sender: '447491163862'
                    destinations:
                    - to: '123456789'
                    event: TYPING_STARTED
                x-label:
                  channel:
                  - WHATSAPP
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails'
              examples:
                Successful response:
                  summary: Successful response
                  value:
                    bulkId: '1688025180464000013'
                    messages:
                    - messageId: '1688025180464000014'
                      status:
                        groupId: 1
                        groupName: PENDING
                        id: 26
                        name: MESSAGE_ACCEPTED
                        description: Message sent to next instance
                      destination: '48600700800'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messages-api:message:send
      - messages-api:manage
  /messages-api/1/reports:
    get:
      tags:
      - platform
      summary: Get delivery reports
      description: If you are unable to receive real-time delivery reports towards your endpoint for various reasons, we offer you an API method to fetch batches of delivery reports to confirm whether specific messages have been delivered. Each request towards this endpoint will return batches of the latest delivery reports. This endpoint retrieves delivery reports for messages sent through Messages API as well as messages sent using channel-specific standalone APIs (for example, Viber, API, WhatsApp API, or SMS API). Please note they will be returned only once.
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: get-messages-api-delivery-reports
      parameters:
      - name: channel
        in: query
        description: Messaging channel for which the report will be fetched.
        required: false
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Channel'
      - name: bulkId
        in: query
        description: The ID that uniquely identifies the request. Bulk ID will be received only when you send a message to more than one destination address.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: messageId
        in: query
        description: The ID that uniquely identifies the message sent.
        required: false
        style: form
        explode: true
        schema:
          type: string
      - name: limit
        in: query
        description: Maximum number of delivery reports to be returned. If not set, the latest 50 records are returned. Maximum limit value is 1000 and you can only access reports for the last 48h
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 50
          maximum: 1000
        example: 1
      - name: entityId
        in: query
        description: Entity id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: applicationId
        in: query
        description: Application id used to send the message. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that was sent in the message.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: summersale
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse'
              examples:
                Delivery report:
                  summary: Delivery report
                  value:
                    results:
                    - event: DELIVERY
                      channel: WHATSAPP
                      sender: senderNumber
                      destination: '41793026727'
                      sentAt: 2024-02-06T14:18:29.797+0000
                      doneAt: 2024-02-06T17:18:29.797+0000
                      bulkId: '1688025180464000013'
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      status:
                        groupId: 3
                        groupName: DELIVERED
                        id: 5
                        name: DELIVERED_TO_HANDSET
                        description: Message delivered to handset
                      error:
                        groupId: 0
                        groupName: OK
                        id: 0
                        name: NO_ERROR
                        description: No Error
                        permanent: false
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      deviceDetails: deviceDetails
                      networkId: 1
                      campaignReferenceId: campaignRef
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - message:send
      - messages-api:message:send
      - messages-api:manage
  /messages-api/1/inbound:
    get:
      tags:
      - platform
      summary: Get inbound messages
      description: If you are unable to receive incoming messages to the endpoint of your choice in real-time, you can use this API call to fetch messages. Each request will return a batch of received messages, only once. The API request will only return new messages that arrived since the last API request.
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: get-messages-api-inbound-messages
      parameters:
      - name: channel
        in: query
        description: Messaging channel for which inbound messages will be fetched.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoGetEndpointChannel'
      - name: limit
        in: query
        description: Maximum number of messages to be returned in a response. If not set, last 50 records are returned. Maximum limit is `1000` and you can only access messages for the last 48h.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
        example: 2
      - name: applicationId
        in: query
        description: Application ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: marketing-automation-application
      - name: entityId
        in: query
        description: Entity ID that the message is linked to. For more details, see our [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: promotional-traffic-entity
      - name: campaignReferenceId
        in: query
        description: ID of a campaign that message belongs to.
        required: false
        style: form
        explode: true
        schema:
          type: string
        example: mycampaign
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessageResponse'
              examples:
                Received text message example:
                  summary: Received text message example
                  value:
                    results:
                    - channel: SMS
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - text: Text message 123
                        cleanText: Text message
                        type: TEXT
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received text message with keyword example:
                  summary: Received text message with keyword example
                  value:
                    results:
                    - channel: SMS
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - text: KWRDText message 123
                        cleanText: Text message
                        keyword: KWRD
                        type: TEXT
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received image with caption message example:
                  summary: Received image with caption message example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/image.jpg
                        text: Image caption
                        type: IMAGE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received audio with caption message example:
                  summary: Received audio with caption message example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-audio
                        text: Audio caption
                        type: AUDIO
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received audio with subject and text message example (MMS only):
                  summary: Received audio with subject and text message example (MMS only)
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-audio
                        text: Audio caption
                        type: AUDIO
                      - text: Text message
                        cleanText: Text message
                        type: TEXT
                      - text: KEYWORD Some subject
                        cleanText: Some subject
                        keyword: KEYWORD
                        type: SUBJECT
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received video with caption example:
                  summary: Received video with caption example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-video
                        text: Video caption
                        type: VIDEO
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received document with caption example:
                  summary: Received document with caption example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-document
                        text: Document caption
                        type: DOCUMENT
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received file with caption example:
                  summary: Received file with caption example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-file
                        text: File caption
                        type: FILE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received multiple file with caption example:
                  summary: Received multiple file with caption example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-file
                        text: File caption
                        type: FILE
                      - url: http://my.domain/media/my-file
                        text: File caption
                        type: FILE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received location with url example:
                  summary: Received location with url example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - latitude: 16.0
                        longitude: 18.0
                        url: http://my.domain/media/my-location
                        type: LOCATION
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received location without url example:
                  summary: Received location without url example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - latitude: 16.0
                        longitude: 18.0
                        type: LOCATION
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received location only with url example:
                  summary: Received location only with url example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - url: http://my.domain/media/my-location
                        type: LOCATION
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received list reply example:
                  summary: Received list reply example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - text: Text for selected option
                        id: selectedItemId
                        type: LIST_REPLY
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received list reply with multiple item selected example:
                  summary: Received list reply with multiple item selected example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - text: 'Text for first selected option '
                        id: selectedItemIdFirst
                        type: LIST_REPLY
                      - text: Text for second selected option
                        id: selectedItemIdSecond
                        type: LIST_REPLY
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received button message example:
                  summary: Received button message example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - text: 'Yes'
                        payload: 'true'
                        id: '1'
                        type: BUTTON_REPLY
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received flow response example:
                  summary: Received flow response example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - response:
                          rating: 5
                          additional_comment: That was very nice :)
                          flow_token: tokenForTracking
                        type: FLOW_RESPONSE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received typing started event example:
                  summary: Received typing started event example
                  value:
                    results:
                    - channel: APPLE_MB
                      sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: TYPING_STARTED
                    messageCount: 1
                    pendingMessageCount: 0
                Received typing stopped event example:
                  summary: Received typing stopped event example
                  value:
                    results:
                    - channel: APPLE_MB
                      sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: TYPING_STOPPED
                    messageCount: 1
                    pendingMessageCount: 0
                Received payment response example:
                  summary: Received payment response example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - referenceId: referenceId
                        paymentId: paymentId
                        status: SUCCESS
                        total:
                          value: 100
                          currency: BRL
                        transaction:
                          id: transactionId
                          type: UPI
                        items:
                        - retailerId: retailerId
                          catalogId: catalogId
                        type: PAYMENT_RESPONSE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received form response example:
                  summary: Received form response example
                  value:
                    results:
                    - channel: APPLE_MB
                      sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                      destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                      content:
                      - isPrivate: false
                        selections:
                        - type: INPUT
                          pageIdentifier: '0'
                          text: Input text
                          items:
                          - title: Input item title
                            value: Input item value
                        - type: PICKER
                          pageIdentifier: '1'
                          text: Picker text
                          items:
                          - title: Picker item title
                            value: Picker item value
                        - type: DATE_PICKER
                          pageIdentifier: '2'
                          text: Date picker text
                          items:
                          - title: Date picker item title
                            value: 2025-01-01T14:00:00.797+0000
                        - type: SELECT
                          pageIdentifier: '3'
                          text: Select text
                          items:
                          - title: Select item title
                            value: Select item value
                        - type: SELECT
                          pageIdentifier: '4'
                          text: Multi-select text
                          items:
                          - title: Multi-select item 1
                            value: Multi-select value 1
                          - title: Multi-select item 2
                            value: Multi-select value 2
                        type: FORM_RESPONSE
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      metadata:
                        correlationData: your-correlation-data
                      event: MO
                    messageCount: 1
                    pendingMessageCount: 0
                Received reaction response example:
                  summary: Received reaction response example
                  value:
                    results:
                    - channel: WHATSAPP
                      sender: '48123234567'
                      destination: '48123098765'
                      content:
                      - emoji: \u2764\uFE0F
                        action: ADDED
                        type: REACTION
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
                Received url response example:
                  summary: Received url response example
                  value:
                    results:
                    - channel: MESSENGER
                      sender: '731401526720514'
                      destination: '24060905360217212'
                      content:
                      - url: http://my.domain/media/my-url
                        type: URL
                      receivedAt: 2020-02-06T14:18:29.797+0000
                      messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                      messageCount: 1
                      platform:
                        entityId: my-entity-id
                        applicationId: my-application-id
                      event: MO
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Bad request:
                  summary: Bad request
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: property.path
                      violation: Violation message.
                    resources: []
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - inbound-message:read
      - messages-api:manage
  /signals/1/trusted-msisdns:
    post:
      tags:
      - platform
      summary: Add phone numbers to a list
      description: "Add phone numbers to a MSISDN list of trusted numbers so that\n Signals never blocks messages sent to these numbers.\n"
      operationId: trusted-msisdns-add
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                OK:
                  summary: OK
                  description: OK
                  value: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.ErrorResponse'
              examples:
                Too few MSISDNs:
                  summary: Too few MSISDNs
                  description: Too few MSISDNs
                  value:
                    errorDetails: At least one MSISDN must be provided.
                Too many MSISDNs:
                  summary: Too many MSISDNs
                  description: Too many MSISDNs
                  value:
                    errorDetails: At most 1000 MSISDN can be provided.
                Invalid MSISDNs:
                  summary: Invalid MSISDNs
                  description: Invalid MSISDNs
                  value:
                    errorDetails: 'Invalid MSISDNs: abc, +-=, 4'
        '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:
      - signals:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Remove phone numbers from a list
      description: 'Remove phone numbers from a MSISDN list of trusted phone numbers.

        '
      operationId: trusted-msisdns-remove
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                OK:
                  summary: OK
                  description: OK
                  value: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.ErrorResponse'
              examples:
                Too few MSISDNs:
                  summary: Too few MSISDNs
                  description: Too few MSISDNs
                  value:
                    errorDetails: At least one MSISDN must be provided.
                Too many MSISDNs:
                  summary: Too many MSISDNs
                  description: Too many MSISDNs
                  value:
                    errorDetails: At most 1000 MSISDN can be provided.
                Invalid MSISDNs:
                  summary: Invalid MSISDNs
                  description: Invalid MSISDNs
                  value:
                    errorDetails: 'Invalid MSISDNs: abc, +-=, 4'
        '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:
      - signals:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /signals/1/trusted-msisdns/{msisdn}/check:
    get:
      tags:
      - platform
      summary: Check for phone numbers on a list
      description: 'Check whether a phone number exists on a MSISDN list of trusted phone numbers.

        '
      operationId: trusted-msisdns-check
      parameters:
      - name: msisdn
        in: path
        description: Phone number (in MSISDN or international format) for which to check whether it is in the trusted MSISDN list.
        required: true
        style: simple
        explode: false
        schema:
          type: string
        example: '38512345678'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnCheckResponse'
              examples:
                OK:
                  summary: OK
                  description: OK
                  value:
                    exists: false
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.ErrorResponse'
              examples:
                Invalid MSISDNs:
                  summary: Invalid MSISDNs
                  description: Invalid MSISDNs
                  value:
                    errorDetails: 'Invalid MSISDNs: abc'
        '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:
      - signals:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 100
        numberOfTimeUnits: 0
        timeUnit: s
  /resource-management/1/inbound-message-configurations:
    get:
      tags:
      - platform
      summary: Get inbound configurations
      description: 'Get all configurations using a filter.<br/>

        If you want configuration for a specific number or resource, then one of the following parameters is required: <code>number, numberKey, resource</code> or <code>resourceKey</code>.<br/>

        If you are using <code>configurationKey</code> none of previously mentioned parameters are needed.'
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: get-inbound-configurations
      parameters:
      - name: configurationKey
        in: query
        description: Unique ID of configuration.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID of configuration.
          example: 58BC6DB7966CB9F69A91EB956DF73239
        example: 58BC6DB7966CB9F69A91EB956DF73239
      - name: number
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '41793026727'
        example: 41793026727
      - name: numberKey
        in: query
        description: Unique ID of a number.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID of a number.
          example: 58BC6DB7966CB9F69A91EB956DF73239
        example: 58BC6DB7966CB9F69A91EB956DF73239
      - name: resource
        in: query
        required: false
        style: form
        explode: true
        schema:
          type: string
          example: '41793026727'
        example: 41793026727
      - name: resourceKey
        in: query
        description: Unique ID of a resource.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Unique ID of a resource.
          example: 58BC6DB7966CB9F69A91EB956DF73239
        example: 58BC6DB7966CB9F69A91EB956DF73239
      - name: keyword
        in: query
        description: Configuration keyword.
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Configuration keyword.
          example: STARTKW
          maxLength: 50
          minLength: 0
        example: STARTKW
      - name: channel
        in: query
        description: Required if <code>number, numberKey, resource</code> or <code>resourceKey</code> present.
        required: true
        style: form
        explode: true
        schema:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType'
        example: SMS
      - name: countryCode
        in: query
        description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
        required: false
        style: form
        explode: true
        schema:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        example: GB
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 2
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Manage inbound configuration
      description: Create and update configuration details for incoming messages. Each action type and channel will require different parameters.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: manage-inbound-configuration
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: token
        replenishRate: 2
        requestedTokens: 1
        burstCapacity: 10
  /resource-management/1/inbound-message-configurations/{configurationKey}:
    delete:
      tags:
      - platform
      summary: Delete inbound configuration
      description: This method will delete the configuration.
      externalDocs:
        description: Read more about keywords
        url: https://www.infobip.com/docs/numbers/keywords-and-actions
      operationId: delete-inbound-configuration
      parameters:
      - name: configurationKey
        in: path
        description: Unique ID of configuration.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: Unique ID of configuration.
          example: 58BC6DB7966CB9F69A91EB956DF73239
        example: 58BC6DB7966CB9F69A91EB956DF73239
      responses:
        '204':
          description: No Content
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/resources:
    post:
      tags:
      - platform
      summary: Search resources
      description: 'Search resources already owned by your account, such as senders and usable numbers, using filters. This endpoint does not return available resources for purchase or request, it only lists resources that are currently assigned to you.<br/>

        Pagination is supported; however, if no pagination arguments are supplied, the full unpaginated result set will be returned.

        '
      operationId: list-resources
      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 items per page.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
          default: 20
          minimum: 1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesResponse'
              examples:
                Response example:
                  summary: Response example
                  value:
                    results:
                    - number: '447860041117'
                      numberKey: 58B3840032C7774BAC840EEEA2C23A44
                      platform:
                        applicationId: myApplicationId
                        entityId: myEntityId
                      numberType: VIRTUAL_LONG_NUMBER
                      countryCode: GB
                      countryName: United Kingdom
                      capabilities:
                      - SMS
                      resourceType: NUMBER
                    paging:
                      page: 0
                      size: 1
                      totalPages: 1
                      totalResults: 1
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/coverage-lookup:
    post:
      tags:
      - platform
      summary: Lookup coverage for a resource
      description: 'Look up the coverage for a single resource by specifying the resource type, identifier (such as sender name or phone number), and associated country code.<br/>

        '
      operationId: lookup-resource-coverage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageInfo'
        '400':
          $ref: '#/components/responses/ApiException400'
        '401':
          $ref: '#/components/responses/ApiException401'
        '403':
          $ref: '#/components/responses/ApiException403'
        '404':
          description: Not Found
        '429':
          $ref: '#/components/responses/ApiException429'
        '500':
          $ref: '#/components/responses/ApiException500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - numbers:manage
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/requirements-lookup:
    post:
      tags:
      - platform
      summary: Get resource requirements
      description: Get a list of requirements needed for requesting a specific resource.
      operationId: resources-requirements-lookup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecsRequestApiDoc'
            examples:
              Alphanumeric Registration:
                summary: Alphanumeric Registration
                value:
                  type: ALPHANUMERIC_REGISTRATION
                  countryCode: HR
                  trafficOrigin: LOCAL
                  trafficType: TRANSACTIONAL
                x-label:
                  type:
                  - Alphanumeric Registration
              Number Purchase:
                summary: Number Purchase
                value:
                  type: NUMBER_PURCHASE
                  quantity: 1
                  numberType: TEN_DIGIT_LONG_CODE
                  capabilities:
                  - SMS
                  countryCode: US
                x-label:
                  type:
                  - Number Purchase
              Number Purchase - Local client type:
                summary: Number Purchase - Local client type
                value:
                  type: NUMBER_PURCHASE
                  quantity: 1
                  numberType: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - SMS
                  clientType: LOCAL
                  countryCode: HR
                x-label:
                  type:
                  - Number Purchase
              RCS Sender Launch:
                summary: RCS Sender Launch
                value:
                  type: RCS_SENDER_LAUNCH
                  countryCode: HR
                  excludedCarriers:
                  - Carrier A
                  - Carrier B
                  trafficOrigin: LOCAL
                x-label:
                  type:
                  - RCS Sender Launch
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecs'
              examples:
                Requirements present:
                  summary: Requirements present
                  value:
                    requirements:
                    - key: companyName
                      type: TEXT
                      name: Company Name
                      description: The legal name of the company.
                      required: true
                      category: BUSINESS_DETAILS
                      validation:
                        minLength: 3
                        maxLength: 100
                    - key: vatNumber
                      type: TEXT
                      name: VAT Number
                      description: The company's VAT registration number.
                      required: false
                      category: BUSINESS_DETAILS
                      validation:
                        pattern: ^[A-Z]{2}[0-9]{8,12}$
                    - key: useCase
                      type: TEXT
                      name: Use Case
                      description: Describe the intended messaging use case.
                      required: true
                      category: USE_CASE_DETAILS
                      options:
                      - OTP
                      - Alerts
                      - Promotions
                      - Notifications
                    - key: expectedMonthlyMessages
                      type: INTEGER
                      name: Expected Monthly Messages
                      description: Estimated number of messages you plan to send per month.
                      required: false
                      category: USE_CASE_DETAILS
                      validation:
                        minValue: 1000
                        maxValue: 10000000
                    - key: companyEmailAddresses
                      type: EMAIL
                      name: Company Email Addresses
                      description: Email addresses associated with the company.
                      required: false
                      multipleValuesSupported: true
                      category: CONTACT_INFORMATION
                    - key: companyWebsite
                      type: URL
                      name: Company Website
                      description: The official website of the company.
                      required: true
                      category: BUSINESS_DETAILS
                    - key: contactPhoneNumber
                      type: GSM
                      name: Contact Phone Number
                      description: Primary contact phone number in international format.
                      required: false
                      category: CONTACT_INFORMATION
                    - key: companyRegistrationDocument
                      type: DOCUMENT
                      name: Company Registration Document
                      description: Official document confirming company registration.
                      required: true
                      category: BUSINESS_DETAILS
                    - key: registrationForm
                      type: DOCUMENT
                      name: Registration Form
                      description: Please fill in the provided template and upload the completed document.
                      required: false
                      category: OTHER
                      attachment:
                        documentId: 103AFCC51DC08FDD351D6ACB689FA071FDF7F7EB92FD6451F62A3AA92EBFA69596150BE4C4BFFBC97182A27D716ED0D3CB67682EF7E0D615EC501064A8B9A201
                        documentType: TEMPLATE
                    - key: registrationConsent
                      type: TEXT
                      name: Registration Consent
                      description: Confirm your consent for Infobip to perform the registration on your behalf.
                      required: true
                      category: OTHER
                      options:
                      - I consent that Infobip will do registration in my name.
                No requirements present:
                  summary: No requirements present
                  value:
                    requirements: []
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Virtual Long Number not supported for US:
                  summary: Virtual Long Number not supported for US
                  value:
                    errorCode: RR-NUMBER-PURCHASE-US-VLN-UNSUPPORTED400
                    description: Virtual Long Number is not supported for the US.
                    action: For the US, TEN_DIGIT_LONG_CODE or TOLL_FREE_NUMBER are the supported number types.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Short Code for US available via web only:
                  summary: Short Code for US available via web only
                  value:
                    errorCode: RR-NUMBER-PURCHASE-US-SC-WEB-ONLY400
                    description: Short Code purchase for the US is not available via API.
                    action: US Short Codes can be requested through Infobip Web Interface.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                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:
                Alphanumeric sender not available for country:
                  summary: Alphanumeric sender not available for country
                  value:
                    errorCode: RR-ALPHA-UNAVAILABLE404
                    description: Alphanumeric sender resource not available for given country.
                    action: Please try again with a different country code.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Alphanumeric Registration
                Numbers not available for given parameters:
                  summary: Numbers not available for given parameters
                  value:
                    errorCode: RR-NUMBER-PURCHASE-UNAVAILABLE404
                    description: Number resource not available for given parameters.
                    action: Please adjust your parameters (capabilities, number type, quantity, country) and try again.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/requests:
    get:
      tags:
      - platform
      summary: Get resource requests
      description: Gets a page of resource requests, using query parameters to filter results.
      operationId: get-resource-requests
      parameters:
      - name: countryCode
        in: query
        description: Filters resources to those that match the supplied country code.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: US,HR
      - name: status
        in: query
        description: Filters resources to those that match the resource request status.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus'
        example: IN_REVIEW,UPDATE_REQUESTED_BY_INTERNAL_REVIEWER,IN_PROGRESS,COMPLETED,REJECTED
      - name: type
        in: query
        description: Filters resources to those that match the supplied resource type.
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
            enum:
            - ALPHANUMERIC_REGISTRATION
            - NUMBER_PURCHASE
            - RCS_SENDER_LAUNCH
        example: ALPHANUMERIC_REGISTRATION,NUMBER_PURCHASE,RCS_SENDER_LAUNCH
      - 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
      - name: size
        in: query
        description: Number of records per page (0..2000). The default value is 20. The maximum value is 2000.
        required: false
        style: form
        explode: true
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: 'Sorting criteria in the format: property(,asc|desc). Default sort order is descending by last modified date. Sortable Properties: ''status'', ''requestedDate''.'
        required: false
        style: form
        explode: true
        schema:
          type: array
          items:
            type: string
        example: requestedDate,desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageResourceOrderApiDoc'
              examples:
                Resource requests page:
                  summary: Resource requests page
                  value:
                    results:
                    - id: d3f96668-b174-4d76-8b21-b3098d566b52
                      type: RCS_SENDER_LAUNCH
                      status: IN_REVIEW
                      countryCode: HR
                      excludedCarriers:
                      - Carrier A
                      - Carrier B
                      senderName: Example sender
                      requestedByEmailAddress: examples@example.com
                      additionalContactEmails:
                      - examples@example.com
                      - example.two@example.com
                      requestedDate: 2026-02-14T13:57:21.000+0000
                      trafficOrigin: LOCAL
                      requirements:
                      - key: legalBrandCompanyName
                        value: example
                      - key: stockExchange
                        value: EXAMPLE
                      - key: contactPersonEmailAddresses
                        value: example@example.com
                      - key: contactPersonPhoneNumber
                        value: '1234567891'
                      - key: attestationLetter
                        value: documentId
                      - key: stopMessage
                        value: stopMessageExample
                      requirementsFeedback: []
                      platform:
                        applicationId: application-id
                        entityId: entity-id
                    - id: c2e85557-a063-4f65-ab10-a2987c455a41
                      type: NUMBER_PURCHASE
                      countryCode: US
                      requestedByEmailAddress: examples@example.com
                      additionalContactEmailAddresses: []
                      requestedDate: 2026-01-28T08:30:55.000+0000
                      status: COMPLETED
                      numberType: TEN_DIGIT_LONG_CODE
                      capabilities:
                      - SMS
                      quantity: 1
                      numbers:
                      - number: '13179090123'
                        numberKey: 7B4C1E93AD25F860E3917D4BC08E52F1
                        status: SUCCESS
                      requirementsFeedback: []
                      requirements:
                      - key: state
                        value: IN
                      - key: npa
                        value: '317'
                      - key: nxx
                        value: '909'
                      platform:
                        applicationId: application-id
                        entityId: entity-id
                    - id: b1d74446-f952-4e54-af09-f1876b344f30
                      type: NUMBER_PURCHASE
                      countryCode: HR
                      requestedByEmailAddress: billing@infobip.com
                      additionalContactEmailAddresses: []
                      requestedDate: 2025-11-19T11:45:10.000+0000
                      status: IN_PROGRESS
                      numberType: VIRTUAL_LONG_NUMBER
                      capabilities:
                      - SMS
                      - MMS
                      quantity: 5
                      numbers:
                      - number: '+38591234567'
                        numberKey: A3F8C21D04E7B96F2150C8DA3E47B01F
                        status: SUCCESS
                      - number: '+38591234568'
                        numberKey: D92E4B810FC6A3571E08B29CD54F7A2E
                        status: SUCCESS
                      requirementsFeedback: []
                      requirements:
                      - key: companyName
                        value: Infobip
                      - key: vatNumber
                        value: HR12345678901
                      - key: companyWebsite
                        value: https://www.infobip.com
                      platform:
                        applicationId: application-id
                        entityId: entity-id
                    - id: e4a07779-a952-4e54-bf10-a2987c455b41
                      type: ALPHANUMERIC_REGISTRATION
                      countryCode: US
                      senderName: InfobipUS
                      requestedByEmailAddress: alphanumeric@infobip.com
                      additionalContactEmailAddresses: []
                      requestedDate: 2025-07-04T16:08:33.000+0000
                      status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                      trafficOrigin: INTERNATIONAL
                      trafficType: PROMOTIONAL
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: expectedMonthlyMessages
                        code: RES_REQ_FEED_VALUE_OOR
                        feedback: Value must be between 1 and 10000000.
                      requirements:
                      - key: companyName
                        value: Infobip
                      - key: companyWebsite
                        value: https://www.infobip.com
                      - key: useCase
                        value: Promotions
                      - key: expectedMonthlyMessages
                        value: 50000000
                      platform:
                        applicationId: application-id
                        entityId: entity-id
                    - id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      type: ALPHANUMERIC_REGISTRATION
                      countryCode: HR
                      senderName: InfobipHR
                      requestedByEmailAddress: alphanumeric@infobip.com
                      additionalContactEmailAddresses: []
                      requestedDate: 2025-03-11T09:22:47.000+0000
                      status: REJECTED
                      trafficOrigin: LOCAL
                      trafficType: TRANSACTIONAL
                      note: Your request has been rejected because it contains invalid information for the selected destination.
                      requirementsFeedback: []
                      requirements:
                      - key: companyName
                        value: Infobip
                      - key: vatNumber
                        value: HR12345678901
                      - key: useCase
                        value: Notifications
                      - key: expectedMonthlyMessages
                        value: 50000
                      - key: companyEmailAddresses
                        value:
                        - contact@infobip.com
                        - info@infobip.com
                      - key: companyWebsite
                        value: https://www.infobip.com
                      - key: contactPhoneNumber
                        value: '+385911234567'
                      platform:
                        applicationId: application-id
                        entityId: entity-id
                    paging:
                      page: 0
                      size: 20
                      totalPages: 1
                      totalResults: 5
        '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:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    post:
      tags:
      - platform
      summary: Submit resource request
      description: Submits a resource request with Infobip. Please note that costs may apply.
      operationId: submit-resource-request
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderRequestApiDoc'
            examples:
              Alphanumeric Registration:
                summary: Alphanumeric Registration
                value:
                  type: ALPHANUMERIC_REGISTRATION
                  senderName: InfobipHR
                  additionalContactEmails:
                  - alphanumeric@infobip.com
                  countryCode: HR
                  trafficOrigin: LOCAL
                  trafficType: TRANSACTIONAL
                  requirements:
                  - key: companyName
                    value: Infobip
                  - key: vatNumber
                    value: HR12345678901
                  - key: useCase
                    value: Notifications
                  - key: expectedMonthlyMessages
                    value: 50000
                  - key: companyEmailAddresses
                    value:
                    - contact@infobip.com
                    - info@infobip.com
                  - key: companyWebsite
                    value: https://www.infobip.com
                  - key: contactPhoneNumber
                    value: '+385911234567'
                  - key: companyRegistrationDocument
                    value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                  - key: registrationForm
                    value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                  - key: registrationConsent
                    value: I consent that Infobip will do registration in my name.
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - Alphanumeric Registration
              Number Purchase - Virtual Long Number:
                summary: Number Purchase - Virtual Long Number
                value:
                  type: NUMBER_PURCHASE
                  quantity: 5
                  numberType: VIRTUAL_LONG_NUMBER
                  capabilities:
                  - SMS
                  - MMS
                  additionalContactEmails:
                  - billing@infobip.com
                  countryCode: HR
                  requirements:
                  - key: companyName
                    value: Infobip
                  - key: vatNumber
                    value: HR12345678901
                  - key: useCase
                    value: Notifications
                  - key: expectedMonthlyMessages
                    value: 50000
                  - key: companyEmailAddresses
                    value:
                    - contact@infobip.com
                    - info@infobip.com
                  - key: companyWebsite
                    value: https://www.infobip.com
                  - key: contactPhoneNumber
                    value: '+385911234567'
                  - key: companyRegistrationDocument
                    value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                  - key: registrationForm
                    value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                  - key: registrationConsent
                    value: I consent that Infobip will do registration in my name.
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  numberType:
                  - Virtual Long Number
              Number Purchase - 10DLC:
                summary: Number Purchase - 10DLC
                value:
                  type: NUMBER_PURCHASE
                  quantity: 1
                  numberType: TEN_DIGIT_LONG_CODE
                  capabilities:
                  - SMS
                  countryCode: US
                  requirements:
                  - key: state
                    value: IN
                  - key: npa
                    value: '317'
                  - key: nxx
                    value: '909'
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  numberType:
                  - 10DLC
              Number Purchase - Toll-Free Number:
                summary: Number Purchase - Toll-Free Number
                value:
                  type: NUMBER_PURCHASE
                  quantity: 1
                  numberType: TOLL_FREE_NUMBER
                  capabilities:
                  - SMS
                  countryCode: US
                  requirements: []
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  numberType:
                  - Toll-Free Number
              Number Purchase - Short Code:
                summary: Number Purchase - Short Code
                value:
                  type: NUMBER_PURCHASE
                  quantity: 1
                  numberType: SHORT_CODE
                  capabilities:
                  - SMS
                  countryCode: DE
                  requirements:
                  - key: companyName
                    value: Infobip
                  - key: companyPhoneNumber
                    value: '+385911234567'
                  - key: contactEmailAddress
                    value: contact@infobip.com
                  - key: useCaseDescription
                    value: Sending transactional notifications to end users.
                  - key: serviceName
                    value: Infobip Notifications
                  - key: messageExample
                    value: Your verification code is 123456.
                  - key: monthlyOutboundSmsEstimate
                    value: '50000'
                  - key: monthlyInboundSmsEstimate
                    value: '5000'
                  - key: typesOfTraffic
                    value: Transactional
                  - key: brandName
                    value: Infobip
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  numberType:
                  - Short Code
              RCS Sender Launch:
                summary: RCS Sender Launch
                value:
                  type: RCS_SENDER_LAUNCH
                  senderName: Example sender
                  additionalContactEmails:
                  - examples@example.com
                  - example.two@example.com
                  countryCode: HR
                  excludedCarriers:
                  - Carrier A
                  - Carrier B
                  trafficOrigin: LOCAL
                  requirements:
                  - key: legalBrandCompanyName
                    value: example
                  - key: stockExchange
                    value: EXAMPLE
                  - key: contactPersonEmailAddresses
                    value: example@example.com
                  - key: contactPersonPhoneNumber
                    value: '1234567891'
                  - key: attestationLetter
                    value: documentId
                  - key: stopMessage
                    value: stopMessageExample
                  platform:
                    applicationId: application-id
                    entityId: entity-id
                x-label:
                  type:
                  - RCS Sender Launch
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderIdentifier'
              examples:
                Resource request created:
                  summary: Resource request created
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Alphanumeric sender name already exists:
                  summary: Alphanumeric sender name already exists
                  value:
                    errorCode: RR-ALPHA-SENDER-ALREADY-EXISTS400
                    description: Alphanumeric sender name already exists for given country.
                    action: Please try again with different sender name.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Alphanumeric Registration
                Alphanumeric pending request limit exceeded:
                  summary: Alphanumeric pending request limit exceeded
                  value:
                    errorCode: RR-ALPHA-SS-LIMIT400
                    description: You can have up to 2 pending sender requests at once.
                    action: Track their status in Get resource request, or contact us for more information.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Alphanumeric Registration
                Alphanumeric not enough credits:
                  summary: Alphanumeric not enough credits
                  value:
                    errorCode: RR-NO-FUNDS400
                    description: Not enough credits. Your account does not meet the credit threshold.
                    action: Please add more funds.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Alphanumeric Registration
                Virtual Long Number not supported for US:
                  summary: Virtual Long Number not supported for US
                  value:
                    errorCode: RR-NUMBER-PURCHASE-US-VLN-UNSUPPORTED400
                    description: Virtual Long Number is not supported for the US.
                    action: For the US, TEN_DIGIT_LONG_CODE or TOLL_FREE_NUMBER are the supported number types.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Short Code for US available via web only:
                  summary: Short Code for US available via web only
                  value:
                    errorCode: RR-NUMBER-PURCHASE-US-SC-WEB-ONLY400
                    description: Short Code purchase for the US is not available via API.
                    action: US Short Codes can be requested through Infobip Web Interface.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Number purchase not enough credits:
                  summary: Number purchase not enough credits
                  value:
                    errorCode: RR-NO-FUNDS400
                    description: Not enough credits. Your account does not meet the credit threshold.
                    action: Please add more funds.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Provided nxx requires valid npa and state combination:
                  summary: Provided nxx requires valid npa and state combination
                  value:
                    errorCode: RR-NUMBER-PURCHASE-NXX-REQUIRES-NPA-STATE400
                    description: Provided nxx requires a valid npa and state combination.
                    action: Please provide a valid npa and state for the requested nxx.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Invalid state and npa combination:
                  summary: Invalid state and npa combination
                  value:
                    errorCode: RR-NUMBER-PURCHASE-INVALID-STATE-NPA-COMBO400
                    description: Invalid state and npa combination.
                    action: Please provide a valid state and npa combination.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                Invalid npa and nxx combination:
                  summary: Invalid npa and nxx combination
                  value:
                    errorCode: RR-NUMBER-PURCHASE-INVALID-NPA-NXX-COMBO400
                    description: Invalid npa and nxx combination.
                    action: Please provide a valid npa and nxx combination.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                RCS sender already launched:
                  summary: RCS sender already launched
                  value:
                    errorCode: RR-RCS-SENDER-ALREADY-LAUNCHED400
                    description: RCS sender has already been launched.
                    action: Sender cannot be launched in multiple countries. Create a new sender to start the launch process.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                RCS sender launch already requested:
                  summary: RCS sender launch already requested
                  value:
                    errorCode: RR-RCS-SENDER-ALREADY-REQUESTED400
                    description: A launch request for this RCS sender is already in progress.
                    action: Please wait for the current launch process to finish before taking any further action with this sender.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                RCS not supported in country:
                  summary: RCS not supported in country
                  value:
                    errorCode: RR-RCS-SENDER-COUNTRY-UNSUPPORTED400
                    description: RCS is not supported in the specified country.
                    action: Please select a supported country to launch an RCS sender.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                RCS sender invalid carriers:
                  summary: RCS sender invalid carriers
                  value:
                    errorCode: RR-RCS-SENDER-INVALID-CARRIERS400
                    description: One or more specified carrier names are invalid for the target country.
                    action: Verify carrier names are correct for the specified country.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                RCS sender invalid brand contact email:
                  summary: RCS sender invalid brand contact email
                  value:
                    errorCode: RR-RCS-SENDER-INVALID-BRAND-CONTACT-EMAIL400
                    description: Brand contact email must be an individual business email, not a shared or team address (e.g., info@, support@, team@).
                    action: Provide a personal business email linked to the contact person's name and company domain.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                RCS sender phone number conflict:
                  summary: RCS sender phone number conflict
                  value:
                    errorCode: RR-RCS-SENDER-PHONE-NUMBER-CONFLICT400
                    description: Company phone number cannot be the same as the brand contact's mobile number.
                    action: Provide a different company phone number that is distinct from the brand contact's personal mobile number.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
                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:
                Alphanumeric sender not available for country:
                  summary: Alphanumeric sender not available for country
                  value:
                    errorCode: RR-ALPHA-UNAVAILABLE404
                    description: Alphanumeric sender resource not available for given country.
                    action: Please try again with a different country code.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Alphanumeric Registration
                Numbers not available for given parameters:
                  summary: Numbers not available for given parameters
                  value:
                    errorCode: RR-NUMBER-PURCHASE-UNAVAILABLE404
                    description: Number resource not available for given parameters.
                    action: Please adjust your parameters (capabilities, number type, quantity, country) and try again.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - Number Purchase
                RCS sender not found:
                  summary: RCS sender not found
                  value:
                    errorCode: RR-RCS-SENDER404
                    description: The specified RCS sender was not found.
                    action: Verify the sender name or create a new sender before proceeding.
                    violations: []
                    resources: []
                  x-label:
                    type:
                    - RCS Sender Launch
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/requests/{id}:
    get:
      tags:
      - platform
      summary: Get resource request
      description: Retrieves a previously submitted resource request by its ID.
      operationId: get-resource-request
      parameters:
      - name: id
        in: path
        description: The ID of the desired resource.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the desired resource.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc'
              examples:
                Alphanumeric Registration - PENDING:
                  summary: Alphanumeric Registration - PENDING
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: PENDING
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - PENDING
                Alphanumeric Registration - AUTOMATIC_VALIDATION:
                  summary: Alphanumeric Registration - AUTOMATIC_VALIDATION
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: AUTOMATIC_VALIDATION
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - AUTOMATIC_VALIDATION
                Alphanumeric Registration - UPDATE_REQUESTED:
                  summary: Alphanumeric Registration - UPDATE_REQUESTED
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: UPDATE_REQUESTED
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - UPDATE_REQUESTED
                Alphanumeric Registration - PENDING_REVIEW:
                  summary: Alphanumeric Registration - PENDING_REVIEW
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: PENDING_REVIEW
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - PENDING_REVIEW
                Alphanumeric Registration - IN_REVIEW:
                  summary: Alphanumeric Registration - IN_REVIEW
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: IN_REVIEW
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - IN_REVIEW
                Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                  summary: Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                Alphanumeric Registration - IN_PROGRESS:
                  summary: Alphanumeric Registration - IN_PROGRESS
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: IN_PROGRESS
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - IN_PROGRESS
                Alphanumeric Registration - COMPLETED:
                  summary: Alphanumeric Registration - COMPLETED
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: COMPLETED
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - COMPLETED
                Alphanumeric Registration - REJECTED:
                  summary: Alphanumeric Registration - REJECTED
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: REJECTED
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    note: Your request has been rejected because it contains invalid information for the selected destination.
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - REJECTED
                Alphanumeric Registration - CANCELED:
                  summary: Alphanumeric Registration - CANCELED
                  value:
                    id: a0c63335-f841-4d43-9ef8-e0765a233f29
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: HR
                    senderName: InfobipHR
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses:
                    - contact@infobip.com
                    requestedDate: 2025-03-11T09:22:47.000+0000
                    status: CANCELED
                    trafficOrigin: LOCAL
                    trafficType: TRANSACTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Alphanumeric Registration
                    status:
                    - CANCELED
                Number Purchase - PENDING:
                  summary: Number Purchase - PENDING
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: PENDING
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - PENDING
                Number Purchase - AUTOMATIC_VALIDATION:
                  summary: Number Purchase - AUTOMATIC_VALIDATION
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: AUTOMATIC_VALIDATION
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - AUTOMATIC_VALIDATION
                Number Purchase - UPDATE_REQUESTED:
                  summary: Number Purchase - UPDATE_REQUESTED
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: UPDATE_REQUESTED
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - UPDATE_REQUESTED
                Number Purchase - PENDING_REVIEW:
                  summary: Number Purchase - PENDING_REVIEW
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: PENDING_REVIEW
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - PENDING_REVIEW
                Number Purchase - IN_REVIEW:
                  summary: Number Purchase - IN_REVIEW
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: IN_REVIEW
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - IN_REVIEW
                Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                  summary: Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                Number Purchase - IN_PROGRESS:
                  summary: Number Purchase - IN_PROGRESS
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: IN_PROGRESS
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers:
                    - number: '+38591234567'
                      numberKey: A3F8C21D04E7B96F2150C8DA3E47B01F
                      status: SUCCESS
                    - number: '+38591234568'
                      numberKey: D92E4B810FC6A3571E08B29CD54F7A2E
                      status: SUCCESS
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - IN_PROGRESS
                Number Purchase - COMPLETED:
                  summary: Number Purchase - COMPLETED
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: COMPLETED
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    note: Only 2 out of 5 requested numbers could be procured.
                    numbers:
                    - number: '+38591234567'
                      numberKey: A3F8C21D04E7B96F2150C8DA3E47B01F
                      status: SUCCESS
                    - number: '+38591234568'
                      numberKey: D92E4B810FC6A3571E08B29CD54F7A2E
                      status: SUCCESS
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - COMPLETED
                Number Purchase - REJECTED:
                  summary: Number Purchase - REJECTED
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: REJECTED
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    note: Your request has been rejected because it contains invalid information for the selected destination.
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - REJECTED
                Number Purchase - CANCELED:
                  summary: Number Purchase - CANCELED
                  value:
                    id: b1d74446-f952-4e54-af09-f1876b344f30
                    type: NUMBER_PURCHASE
                    countryCode: HR
                    requestedByEmailAddress: billing@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: CANCELED
                    numberType: VIRTUAL_LONG_NUMBER
                    capabilities:
                    - SMS
                    - MMS
                    quantity: 5
                    numbers: []
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: vatNumber
                      value: HR12345678901
                    - key: useCase
                      value: Notifications
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: companyEmailAddresses
                      value:
                      - contact@infobip.com
                      - info@infobip.com
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: contactPhoneNumber
                      value: '+385911234567'
                    - key: companyRegistrationDocument
                      value: A3F8C21D04E7B96F2150C8DA3E47B01FCA8D5E92F3B741082E6C50D9A1FB8327E4C09B6D2A75F83190EC621B4D5A7803F96E12C48B3D07A95F12E840BC369241
                    - key: registrationForm
                      value: 2B7E4A91F53D08CC461E9BAD3F80712EDB9C6E53A2F841076D5B40E8C2FA9318B5D07C6E3A84F92180EB531C4D6A8702F85E13C49B4D08A96F23E951BD470352
                    - key: registrationConsent
                      value: I consent that Infobip will do registration in my name.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - Number Purchase
                    status:
                    - CANCELED
                RCS Sender Launch - PENDING:
                  summary: RCS Sender Launch - PENDING
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: PENDING
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - PENDING
                RCS Sender Launch - AUTOMATIC_VALIDATION:
                  summary: RCS Sender Launch - AUTOMATIC_VALIDATION
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: AUTOMATIC_VALIDATION
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - AUTOMATIC_VALIDATION
                RCS Sender Launch - UPDATE_REQUESTED:
                  summary: RCS Sender Launch - UPDATE_REQUESTED
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: UPDATE_REQUESTED
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - UPDATE_REQUESTED
                RCS Sender Launch - PENDING_REVIEW:
                  summary: RCS Sender Launch - PENDING_REVIEW
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: PENDING_REVIEW
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - PENDING_REVIEW
                RCS Sender Launch - IN_REVIEW:
                  summary: RCS Sender Launch - IN_REVIEW
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: IN_REVIEW
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - IN_REVIEW
                RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                  summary: RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback:
                    - key: contactPhoneNumber
                      code: RES_REQ_FEED_REQUIRED
                      feedback: This field is required and cannot be empty.
                    - key: companyName
                      code: RES_REQ_FEED_LENGTH_OOR
                      feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                RCS Sender Launch - IN_PROGRESS:
                  summary: RCS Sender Launch - IN_PROGRESS
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: IN_PROGRESS
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - IN_PROGRESS
                RCS Sender Launch - COMPLETED:
                  summary: RCS Sender Launch - COMPLETED
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: COMPLETED
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - COMPLETED
                RCS Sender Launch - REJECTED:
                  summary: RCS Sender Launch - REJECTED
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: REJECTED
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    note: Your request has been rejected because it contains invalid information for the selected destination.
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - REJECTED
                RCS Sender Launch - CANCELED:
                  summary: RCS Sender Launch - CANCELED
                  value:
                    id: d3f96668-b174-4d76-8b21-b3098d566b52
                    type: RCS_SENDER_LAUNCH
                    status: CANCELED
                    countryCode: HR
                    excludedCarriers:
                    - Carrier A
                    - Carrier B
                    senderName: Example sender
                    requestedByEmailAddress: examples@example.com
                    additionalContactEmails:
                    - examples@example.com
                    requestedDate: 2025-11-19T11:45:10.000+0000
                    trafficOrigin: LOCAL
                    requirements:
                    - key: legalBrandCompanyName
                      value: example
                    - key: stockExchange
                      value: EXAMPLE
                    - key: contactPersonEmailAddresses
                      value: example@example.com
                    - key: contactPersonPhoneNumber
                      value: '1234567891'
                    - key: attestationLetter
                      value: documentId
                    - key: stopMessage
                      value: stopMessageExample
                    requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                  x-label:
                    type:
                    - RCS Sender Launch
                    status:
                    - CANCELED
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Resource request not found:
                  summary: Resource request not found
                  value:
                    errorCode: RR404
                    description: Resource request not found.
                    action: Please verify the resource request ID and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 10
        numberOfTimeUnits: 0
        timeUnit: s
    patch:
      tags:
      - platform
      summary: Update resource request
      description: 'Updates an existing resource request with Infobip. Resource request may only be updated when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.

        Limited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.

        **All requirements data must be provided within the request, not just the incorrect or changed ones.**

        '
      operationId: update-resource-request
      parameters:
      - name: id
        in: path
        description: The ID of the resource request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the resource request.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UpdateResourceOrderRequest'
            examples:
              Update resource request:
                summary: Update resource request
                value:
                  requirements:
                  - key: companyName
                    value: Infobip
                  - key: companyWebsite
                    value: https://www.infobip.com
                  - key: useCase
                    value: Promotions
                  - key: expectedMonthlyMessages
                    value: 50000
                  - key: contactPhoneNumber
                    value: '+13125550123'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc'
              examples:
                Resource request updated:
                  summary: Resource request updated
                  value:
                    id: e4a07779-a952-4e54-bf10-a2987c455b41
                    type: ALPHANUMERIC_REGISTRATION
                    countryCode: US
                    senderName: InfobipUS
                    requestedByEmailAddress: alphanumeric@infobip.com
                    additionalContactEmailAddresses: []
                    requestedDate: 2025-07-04T16:08:33.000+0000
                    status: AUTOMATIC_VALIDATION
                    trafficOrigin: INTERNATIONAL
                    trafficType: PROMOTIONAL
                    requirementsFeedback: []
                    requirements:
                    - key: companyName
                      value: Infobip
                    - key: companyWebsite
                      value: https://www.infobip.com
                    - key: useCase
                      value: Promotions
                    - key: expectedMonthlyMessages
                      value: 50000
                    - key: contactPhoneNumber
                      value: '+13125550123'
                    platform:
                      applicationId: application-id
                      entityId: entity-id
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Resource request is in invalid status:
                  summary: Resource request is in invalid status
                  value:
                    errorCode: RR-INVALID-STATUS400
                    description: The resource request is in a status that does not allow updates or cancellations.
                    action: Please verify the resource request status and perform this action only when it is in an allowed state.
                    violations: []
                    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:
                Resource request not found:
                  summary: Resource request not found
                  value:
                    errorCode: RR404
                    description: Resource request not found.
                    action: Please verify the resource request ID and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/requests/{id}/cancel:
    post:
      tags:
      - platform
      summary: Cancel resource request
      description: 'Cancels an existing resource request with Infobip. Resource request may only be canceled when in UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER status.

        Limited to ALPHANUMERIC_REGISTRATION, NUMBER_PURCHASE and RCS_SENDER_LAUNCH requests only.

        '
      operationId: cancel-resource-request
      parameters:
      - name: id
        in: path
        description: The ID of the resource request.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          format: uuid
          description: The ID of the resource request.
      responses:
        '204':
          description: No Content
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Resource request is in invalid status:
                  summary: Resource request is in invalid status
                  value:
                    errorCode: RR-INVALID-STATUS400
                    description: The resource request is in a status that does not allow updates or cancellations.
                    action: Please verify the resource request status and perform this action only when it is in an allowed state.
                    violations: []
                    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:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Resource request not found:
                  summary: Resource request not found
                  value:
                    errorCode: RR404
                    description: Resource request not found.
                    action: Please verify the resource request ID and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/documents:
    post:
      tags:
      - platform
      summary: Upload document
      description: Upload a document prior to providing it as a requirement within a resource request.
      operationId: upload-document
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UploadDocumentApiDoc'
            examples:
              Upload a document using curl:
                summary: Upload a document using curl
                value: 'curl --request POST ''https://{base_url}/resources/1/documents'' \

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

                  --form ''document="@files/image1.jpg"''

                  '
              Upload a document using Java:
                summary: Upload a document using Java
                value: "OkHttpClient client = new OkHttpClient().newBuilder().build();\nMediaType mediaType = MediaType.parse(\"text/plain\");\nRequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)\n  .addFormDataPart(\"document\",\"@files/image1.jpg\")\n  .build();\nRequest request = new Request.Builder()\n  .url(\"https://{base_url}/resources/1/documents\")\n  .method(\"POST\", body)\n  .addHeader(\"Authorization\", \"{authorization}\")\n  .build();\nResponse response = client.newCall(request).execute();\n"
              Upload a document - HTTP:
                summary: Upload a document - HTTP
                value: 'POST /resources/1/documents HTTP/1.1

                  Host: {base_url}

                  Authorization: {authorization}

                  Content-Length: 1370

                  Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW


                  @files/image1.jpg

                  ------WebKitFormBoundary7MA4YWxkTrZu0gW

                  Content-Disposition: form-data; name="bulkId"

                  '
              Upload a document using PHP:
                summary: Upload a document using PHP
                value: "<?php\n   require_once 'HTTP/Request2.php';\n   $request = new HTTP_Request2();\n   $request->setUrl('https://{base_url}/resources/1/documents');\n   $request->setMethod(HTTP_Request2::METHOD_POST);\n   $request->setConfig(array(\n     'follow_redirects' => TRUE\n   ));\n   $request->setHeader(array(\n     'Authorization' => '{authorization}',\n     'Content-Type' => 'multipart/form-data'\n   ));\n\n   $request->addUpload('document', '/home/files/image.jpg', 'image.jpg', '<Content-Type Header>');\n\n   try {\n     $response = $request->send();\n     if ($response->getStatus() == 200) {\n       echo $response->getBody();\n     }\n     else {\n       echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .\n       $response->getBody();\n     }\n   }\n   catch(HTTP_Request2_Exception $e) {\n     echo 'Error: ' . $e->getMessage();\n   }\n?>\n"
              Upload a document using C#:
                summary: Upload a document using C#
                value: 'var client = new RestClient("https://{base_url}/resources/1/documents");

                  client.Timeout = -1;

                  var request = new RestRequest(Method.POST);

                  request.AddHeader("Authorization", "{authorization}");

                  request.AlwaysMultipartFormData = true;

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

                  IRestResponse response = client.Execute(request);

                  Console.WriteLine(response.Content);

                  '
              Upload a document using JavaScript:
                summary: Upload a document using JavaScript
                value: "var data = new FormData();\ndata.append(\"document\", \"@files/image1.jpg\");\n\nvar 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://%7Bbase_url%7D/resources/1/documents\");\nxhr.setRequestHeader(\"Authorization\", \"{authorization}\");\n\nxhr.send(data);\n"
              Upload a document using Python:
                summary: Upload a document using Python
                value: "import requests\nimport json\n\nurl = 'https://{base_url}/resources/1/documents'\nheaders = {'Authorization': '{authorization}'}\n\nfile = open('files/image1.jpg', 'rb')\nfiles = {'document': ('image1.jpg', file)}\n\ndata = {\n    'document': '@/files/image1.jpg'\n}\n\nresponse = requests.post(url, headers=headers, files=files, data=data)\n\nfile.close()\n\nprint(response.text)\n"
      responses:
        '201':
          description: Document successfully uploaded
          headers:
            Location:
              description: The location of the uploaded document.
              style: simple
              explode: false
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentIdentifier'
              examples:
                Document successfully uploaded:
                  summary: Document successfully uploaded
                  value:
                    documentId: 103AFCC51DC08FDD351D6ACB689FA071FDF7F7EB92FD6451F62A3AA92EBFA69596150BE4C4BFFBC97182A27D716ED0D3CB67682EF7E0D615EC501064A8B9A201
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Maximum upload size exceeded:
                  summary: Maximum upload size exceeded
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: ''
                      violation: Maximum upload size exceeded
                    resources: []
                Document not provided:
                  summary: Document not provided
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: document
                      violation: Must not be null or empty.
                    resources: []
                Unsupported document content type:
                  summary: Unsupported document content type
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: document
                      violation: Unsupported document content type.
                    resources: []
                Document content type is required:
                  summary: Document content type is required
                  value:
                    errorCode: E400
                    description: Request cannot be processed.
                    action: Check the syntax, violations and adjust the request.
                    violations:
                    - property: document
                      violation: Document content type is required.
                    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:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
  /resources/1/documents/{documentId}:
    get:
      tags:
      - platform
      summary: Download document
      description: Download a requirement supporting document (template or sample) or a document you have previously uploaded.
      operationId: download-document
      parameters:
      - name: documentId
        in: path
        description: The ID of the desired document.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: The ID of the desired document.
      responses:
        '200':
          description: OK
          headers:
            Content-Disposition:
              description: File name.
              style: simple
              explode: false
              schema:
                type: string
            Content-Length:
              description: File size.
              style: simple
              explode: false
              schema:
                type: integer
            Content-Type:
              description: File type.
              style: simple
              explode: false
              schema:
                type: string
          content:
            '*/*':
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Document not found:
                  summary: Document not found
                  value:
                    errorCode: RR-DOC404
                    description: Document not found.
                    action: Please verify the document ID and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 1
        numberOfTimeUnits: 0
        timeUnit: s
    delete:
      tags:
      - platform
      summary: Delete document
      description: Delete a document you have previously uploaded.
      operationId: delete-document
      parameters:
      - name: documentId
        in: path
        description: The ID of the document for deletion.
        required: true
        style: simple
        explode: false
        schema:
          type: string
          description: The ID of the document for deletion.
      responses:
        '204':
          description: Document successfully deleted
        '401':
          $ref: '#/components/responses/ApiError401'
        '403':
          $ref: '#/components/responses/ApiError403'
        '404':
          description: Not Found
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ApiError'
              examples:
                Document not found:
                  summary: Document not found
                  value:
                    errorCode: RR-DOC404
                    description: Document not found.
                    action: Please verify the document ID and adjust your request.
                    violations: []
                    resources: []
        '429':
          $ref: '#/components/responses/ApiError429'
        '500':
          $ref: '#/components/responses/ApiError500'
      security:
      - IBSSOTokenHeader: []
      - APIKeyHeader: []
      - Basic: []
      - OAuth2: []
      x-scopes:
      - resource-request-hub:manage
      - resource-request-hub:read
      x-is-early-access: true
      x-throttling-info:
      - type: time
        numberOfRequests: 20
        numberOfTimeUnits: 0
        timeUnit: s
webhooks:
  brand-registration-status-change-notification:
    post:
      tags:
      - platform
      summary: Receive Brand Status Update
      description: 'Any time brand registration is completed or failed, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''BRAND_STATUS_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: brand-registration-status-change-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  brand-auth-2fa-update-notification:
    post:
      tags:
      - platform
      summary: Receive Brand Auth 2FA Update
      description: 'Any time brand 2FA email is sent or authentication is completed, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''BRAND_AUTH_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: brand-auth-2fa-update-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  brand-vet-notification:
    post:
      tags:
      - platform
      summary: Receive Brand Vet Update
      description: 'Any time a brand vet is completed or failed, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''BRAND_VET_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: brand-vet-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  campaign-network-status-notification:
    post:
      tags:
      - platform
      summary: Receive Campaign Network Status Update
      description: 'Any time a campaign changes status on carrier side, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''CAMPAIGN_NETWORK_STATUS_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: campaign-network-status-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  campaign-status-change-notification:
    post:
      tags:
      - platform
      summary: Receive Campaign Status Update
      description: 'Any time campaign status is changed, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''CAMPAIGN_STATUS_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: campaign-status-change-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  campaign-ai-feedback-notification:
    post:
      tags:
      - platform
      summary: Receive AI Campaign Feedback
      description: 'Any time a campaign AI review is finished and ready for the results to be fetched, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''AI_CAMPAIGN_FEEDBACK'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: campaign-ai-feedback-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  campaign-ai-builder-notification:
    post:
      tags:
      - platform
      summary: Receive AI Campaign Builder Completion Notification
      description: 'Any time a campaign AI builder job is finished and ready for the results to be fetched, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''AI_CAMPAIGN_BUILDER'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: campaign-ai-builder-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookResponse'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-aggregate-data-result:
    post:
      tags:
      - platform
      summary: Receive aggregated data result
      description: Receive data response, requested by [Query aggregate traffic data](#platform/metrics-api/query-aggregate-data). This callback will be invoked only once with POST method.
      operationId: receive-aggregate-data-result
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResult'
            examples:
              A simple query result:
                summary: A simple query result
                value:
                  requestId: B61D150B0F6596F68D88D253886432B5
                  status: SUCCESS
                  response:
                    requestedPeriod:
                      sentSince: 2023-04-01T00:00:00.000+0000
                      sentUntil: 2023-04-01T02:00:00.000+0000
                    totalRows: 3
                    columns:
                    - columnName: HOUR
                      columnDataType: DATE_TIME
                    - columnName: DIRECTION
                      columnDataType: STRING
                    - columnName: STATUS_GROUP
                      columnDataType: STRING
                    - columnName: TOTAL_TRAFFIC_COUNT
                      columnDataType: INTEGER
                    rows:
                    - - 2023-04-01T00:00:00.000+0000
                      - INBOUND
                      - DELIVERED
                      - 7
                      - 7
                    - - 2023-04-01T01:00:00.000+0000
                      - OUTBOUND
                      - PENDING
                      - 10
                      - 11
                    - - 2023-04-01T01:00:00.000+0000
                      - OUTBOUND
                      - DELIVERED
                      - 0
                      - 0
              An error query result:
                summary: An error query result
                value:
                  requestId: B61D150B0F6596F68D88D253886432B5
                  status: FAILED
                  failureMessage: Could not load data
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-billing-usage-result:
    post:
      tags:
      - platform
      summary: Receive billing usage result
      description: Receives data response requested by the [Query billing usage data](#platform/billing-usage/query-billing-usage) endpoint. This webhook is called once via POST when the query completes.
      operationId: receive-billing-usage-result
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageResult'
            examples:
              A simple billing usage result:
                summary: A simple billing usage result
                value:
                  requestId: B61D150B0F6596F68D88D253886432B5
                  status: SUCCESS
                  response:
                    requestedPeriod:
                      sentSince: 2026-03-01T00:00:00.000+0000
                      sentUntil: 2026-04-01T00:00:00.000+0000
                    totalRows: 2
                    columns:
                    - columnName: ACCOUNT_NAME
                      columnDataType: STRING
                    - columnName: CATEGORY_CODE
                      columnDataType: STRING
                    - columnName: COUNTRY_NAME
                      columnDataType: STRING
                    - columnName: UNIT_TYPE
                      columnDataType: STRING
                    - columnName: UNIT_PRICE
                      columnDataType: NUMBER
                    - columnName: QUANTITY
                      columnDataType: NUMBER
                    - columnName: TOTAL_PER_UNIT
                      columnDataType: NUMBER
                    - columnName: CURRENCY
                      columnDataType: STRING
                    rows:
                    - - Account A
                      - SMS
                      - United States
                      - message part
                      - 0.0075
                      - 1500
                      - 11.25
                      - USD
                    - - Account A
                      - WHATSAPP
                      - India
                      - message
                      - 0.0089
                      - 450
                      - 4.01
                      - USD
                  metadata:
                    clientRequestedPeriod:
                      sentSince: 2026-03-01T00:00:00.000+0000
                      sentUntil: 2026-04-01T00:00:00.000+0000
                    billingPeriods:
                    - month: 2026-03
                      volumeFinalized: true
              A detailed billing usage result:
                summary: A detailed billing usage result
                value:
                  requestId: B61D150B0F6596F68D88D253886432B5
                  status: SUCCESS
                  response:
                    requestedPeriod:
                      sentSince: 2026-03-01T00:00:00.000+0000
                      sentUntil: 2026-04-01T00:00:00.000+0000
                    totalRows: 3
                    columns:
                    - columnName: APPLICATION_ID
                      columnDataType: STRING
                    - columnName: ENTITY_ID
                      columnDataType: STRING
                    - columnName: CATEGORY_CODE
                      columnDataType: STRING
                    - columnName: COUNTRY_NAME
                      columnDataType: STRING
                    - columnName: TRAFFIC_TYPE
                      columnDataType: STRING
                    - columnName: SENDER_TYPE
                      columnDataType: STRING
                    - columnName: ACCOUNT_KEY
                      columnDataType: STRING
                    - columnName: UNIT_TYPE
                      columnDataType: STRING
                    - columnName: UNIT_PRICE
                      columnDataType: NUMBER
                    - columnName: QUANTITY
                      columnDataType: NUMBER
                    - columnName: TOTAL_PER_UNIT
                      columnDataType: NUMBER
                    - columnName: CURRENCY
                      columnDataType: STRING
                    rows:
                    - - app_a
                      - entity_a
                      - SMS
                      - United States
                      - A2P
                      - ALPHANUMERIC
                      - 565C2852060F94BC771F692C04C055E1
                      - message part
                      - 0.0075
                      - 1500
                      - 11.25
                      - USD
                    - - app_a
                      - entity_a
                      - WHATSAPP
                      - India
                      - MARKETING
                      - DOMAIN
                      - 565C2852060F94BC771F692C04C055E1
                      - message
                      - 0.0089
                      - 450
                      - 4.01
                      - USD
                    - - app_b
                      - entity_b
                      - RCS
                      - United Kingdom
                      - RICH
                      - ALPHANUMERIC
                      - 565C2852060F94BC771F692C04C055E1
                      - message
                      - 0.0244
                      - 200
                      - 4.88
                      - EUR
                  metadata:
                    clientRequestedPeriod:
                      sentSince: 2026-03-01T00:00:00.000+0000
                      sentUntil: 2026-04-01T00:00:00.000+0000
                    billingPeriods:
                    - month: 2026-03
                      volumeFinalized: true
              An error billing usage result:
                summary: An error billing usage result
                value:
                  requestId: B61D150B0F6596F68D88D253886432B5
                  status: FAILED
                  failureMessage: Could not load data
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  receive-blocklist-event:
    post:
      tags:
      - platform
      summary: Receive blocklist event
      description: Anytime a blocklist is added or removed by an end-user action or within the campaign, an event is sent. You need to subscribe to this event using the 'BLOCKLIST' channel, and specify the 'BLOCK' and 'UNBLOCK' events. For more details, see [documentation](https://www.infobip.com/docs/api/platform/subscriptions-api).
      operationId: receive-blocklist-event
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventRequest'
            examples:
              Block event request source type URL Optout:
                summary: Block event request source type URL Optout
                value:
                  results:
                  - event: BLOCK
                    receivedAt: 2023-06-06T14:18:29.797+0000
                    messageId: '1695640910883409241'
                    content:
                      sender: sender@example.com
                      destination: recipient@example.com
                      channel: EMAIL
                      sourceType: URL_OPT_OUT
                      outboundMessageReference:
                        bulkId: '2034072219640523072'
                        outboundMessageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                        sendAt: 2023-06-06T13:18:29.797+0000
              Block event request source type Campaign:
                summary: Block event request source type Campaign
                value:
                  results:
                  - event: BLOCK
                    receivedAt: 2023-06-06T14:18:29.797+0000
                    messageId: '1695640910883409241'
                    content:
                      sender: '385919998888'
                      destination: '41793026731'
                      sourceType: CAMPAIGN
                      campaignReference:
                        campaign: summersale
                        versionId: 1
              Unblock event request source type MO:
                summary: Unblock event request source type MO
                value:
                  results:
                  - event: UNBLOCK
                    receivedAt: 2023-06-06T14:18:29.797+0000
                    messageId: '1695640910883409241'
                    content:
                      sender: '385919998888'
                      destination: '41793026731'
                      sourceType: MO
                      outboundMessageReference:
                        bulkId: '2034072219640523072'
                        outboundMessageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                        sendAt: 2023-06-06T13:18:29.797+0000
                      inboundMessageReference:
                        inboundMessageId: '8695640910883409241'
              Unblock event request source type MO (APPLE_MB):
                summary: Unblock event request source type MO (APPLE_MB)
                value:
                  results:
                  - event: UNBLOCK
                    receivedAt: 2023-06-06T14:18:29.797+0000
                    messageId: '1695640910883409241'
                    content:
                      sender: c5ab692f-b5d8-4bad-bee5-c121dc346a39
                      destination: urn:mbid:AQAAY3hr45FzBEsLpieCa0GANPlF399IiV/0gLSXRvwHauT0ph5Akk/Tx66ekESCF32bAOUHbSDCgQmZpGlyVr+wWepO0vPd7SUSQMUhjm+TTD7b/gGuVS6urpS2PL8I4GT+NW67K6VIO/1TeADk+Yu18i9HQfw=
                      sourceType: MO
                      outboundMessageReference:
                        bulkId: '2034072219640523072'
                        outboundMessageId: 2250be2d4219-3af1-78856-aabe-1362af1edfd2
                        sendAt: 2023-06-06T13:18:29.797+0000
                      inboundMessageReference:
                        inboundMessageId: '8695640910883409241'
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-messages-api-delivery-reports:
    post:
      tags:
      - platform
      summary: Receive delivery reports
      description: Incoming Reports will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > delivery > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: receive-messages-api-delivery-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse'
            examples:
              Delivery report:
                summary: Delivery report
                value:
                  results:
                  - event: DELIVERY
                    channel: WHATSAPP
                    sender: senderNumber
                    destination: '41793026727'
                    sentAt: 2024-02-06T14:18:29.797+0000
                    doneAt: 2024-02-06T17:18:29.797+0000
                    bulkId: '1688025180464000013'
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    status:
                      groupId: 3
                      groupName: DELIVERED
                      id: 5
                      name: DELIVERED_TO_HANDSET
                      description: Message delivered to handset
                    error:
                      groupId: 0
                      groupName: OK
                      id: 0
                      name: NO_ERROR
                      description: No Error
                      permanent: false
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    deviceDetails: deviceDetails
                    networkId: 1
                    campaignReferenceId: campaignRef
          application/xml:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse'
            examples:
              Delivery report:
                summary: Delivery report
                value: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><MessagesApiDeliveryReportResponse>\n  <results>\n    <results>\n      <event>DELIVERY</event>\n      <channel>WHATSAPP</channel>\n      <sender>senderNumber</sender>\n      <destination>41793026727</destination>\n      <sentAt>2024-02-06T14:18:29.797+0000</sentAt>\n      <doneAt>2024-02-06T17:18:29.797+0000</doneAt>\n      <bulkId>1688025180464000013</bulkId>\n      <messageId>ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy</messageId>\n      <messageCount>1</messageCount>\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>my-entity-id</entityId>\n        <applicationId>my-application-id</applicationId>\n      </platform>\n      <deviceDetails>deviceDetails</deviceDetails>\n      <networkId>1</networkId>\n      <campaignReferenceId>campaignRef</campaignReferenceId>\n    </results>\n  </results>\n</MessagesApiDeliveryReportResponse>\n"
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-messages-api-seen-reports:
    post:
      tags:
      - platform
      summary: Receive Seen reports
      description: Incoming Seen Reports will be forwarded to this endpoint. Please provide the endpoint’s URL to your Account Manager and they will set it up for you. Alternatively you can specify the endpoint per each message via the `webhooks > seen > url` parameter. Contact support@infobip.com if you require help.
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: receive-messages-api-seen-reports
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenReport'
            examples:
              Seen report:
                summary: Seen report
                value:
                  results:
                  - event: SEEN
                    channel: WHATSAPP
                    sender: senderNumber
                    destination: '41793026727'
                    sentAt: 2024-02-06T14:18:29.797+0000
                    seenAt: 2024-02-06T14:28:29.797+0000
                    bulkId: '1688025180464000013'
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    callbackData: reference-callback-data-from-outbound-message
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    campaignReferenceId: campaignRef
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  receive-messages-api-incoming-messages:
    post:
      tags:
      - platform
      summary: Receive inbound messages
      description: 'Incoming messages will be forwarded to this endpoint. [Set the inbound configuration](/docs/api/platform/numbers/my-numbers/resource-management/manage-inbound-configuration) for the number or resource by specifying your endpoint and we will send inbound messages to you as soon as they are delivered to us.


        Make sure you set renderer or format to `MO_MESSAGES_API_JSON`.'
      externalDocs:
        description: Learn more about the Messages API and use cases
        url: https://www.infobip.com/docs/messages-api
      operationId: receive-messages-api-incoming-messages
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessage'
            examples:
              Received text message example:
                summary: Received text message example
                value:
                  results:
                  - channel: SMS
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - text: Text message 123
                      cleanText: Text message
                      type: TEXT
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received text message with keyword example:
                summary: Received text message with keyword example
                value:
                  results:
                  - channel: SMS
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - text: KWRDText message 123
                      cleanText: Text message
                      keyword: KWRD
                      type: TEXT
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received image with caption message example:
                summary: Received image with caption message example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/image.jpg
                      text: Image caption
                      type: IMAGE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received audio with caption message example:
                summary: Received audio with caption message example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-audio
                      text: Audio caption
                      type: AUDIO
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received audio with subject and text message example (MMS only):
                summary: Received audio with subject and text message example (MMS only)
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-audio
                      text: Audio caption
                      type: AUDIO
                    - text: Text message
                      cleanText: Text message
                      type: TEXT
                    - text: KEYWORD Some subject
                      cleanText: Some subject
                      keyword: KEYWORD
                      type: SUBJECT
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received video with caption example:
                summary: Received video with caption example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-video
                      text: Video caption
                      type: VIDEO
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received document with caption example:
                summary: Received document with caption example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-document
                      text: Document caption
                      type: DOCUMENT
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received file with caption example:
                summary: Received file with caption example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-file
                      text: File caption
                      type: FILE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received multiple file with caption example:
                summary: Received multiple file with caption example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-file
                      text: File caption
                      type: FILE
                    - url: http://my.domain/media/my-file
                      text: File caption
                      type: FILE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received location with url example:
                summary: Received location with url example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - latitude: 16.0
                      longitude: 18.0
                      url: http://my.domain/media/my-location
                      type: LOCATION
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received location without url example:
                summary: Received location without url example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - latitude: 16.0
                      longitude: 18.0
                      type: LOCATION
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received location only with url example:
                summary: Received location only with url example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - url: http://my.domain/media/my-location
                      type: LOCATION
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received list reply example:
                summary: Received list reply example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - text: Text for selected option
                      id: selectedItemId
                      type: LIST_REPLY
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received list reply with multiple item selected example:
                summary: Received list reply with multiple item selected example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - text: 'Text for first selected option '
                      id: selectedItemIdFirst
                      type: LIST_REPLY
                    - text: Text for second selected option
                      id: selectedItemIdSecond
                      type: LIST_REPLY
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received button message example:
                summary: Received button message example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - text: 'Yes'
                      payload: 'true'
                      id: '1'
                      type: BUTTON_REPLY
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received flow response example:
                summary: Received flow response example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - response:
                        rating: 5
                        additional_comment: That was very nice :)
                        flow_token: tokenForTracking
                      type: FLOW_RESPONSE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received typing started event example:
                summary: Received typing started event example
                value:
                  results:
                  - channel: APPLE_MB
                    sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: TYPING_STARTED
              Received typing stopped event example:
                summary: Received typing stopped event example
                value:
                  results:
                  - channel: APPLE_MB
                    sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: TYPING_STOPPED
              Received payment response example:
                summary: Received payment response example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - referenceId: referenceId
                      paymentId: paymentId
                      status: SUCCESS
                      total:
                        value: 100
                        currency: BRL
                      transaction:
                        id: transactionId
                        type: UPI
                      items:
                      - retailerId: retailerId
                        catalogId: catalogId
                      type: PAYMENT_RESPONSE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received form response example:
                summary: Received form response example
                value:
                  results:
                  - channel: APPLE_MB
                    sender: urn:mbid:AQAAY6xHR8jJXQr78AG+hTy/xz8H/slwhA06+fLuhMyGKnWAB2DNFenG1r8hAFckmalbZiBRorHQXNcnCg7OK94H+tEF/CI4wDdedyL0E+mDYIwDG+Xcd05xQc0i7GNgRGs1QZmn4Yr5foi6H6ebjivoHbo3cl0=
                    destination: e1c86198-d9bf-43ee-a635-7fe9cbcf45ad
                    content:
                    - isPrivate: false
                      selections:
                      - type: INPUT
                        pageIdentifier: '0'
                        text: Input text
                        items:
                        - title: Input item title
                          value: Input item value
                      - type: PICKER
                        pageIdentifier: '1'
                        text: Picker text
                        items:
                        - title: Picker item title
                          value: Picker item value
                      - type: DATE_PICKER
                        pageIdentifier: '2'
                        text: Date picker text
                        items:
                        - title: Date picker item title
                          value: 2025-01-01T14:00:00.797+0000
                      - type: SELECT
                        pageIdentifier: '3'
                        text: Select text
                        items:
                        - title: Select item title
                          value: Select item value
                      - type: SELECT
                        pageIdentifier: '4'
                        text: Multi-select text
                        items:
                        - title: Multi-select item 1
                          value: Multi-select value 1
                        - title: Multi-select item 2
                          value: Multi-select value 2
                      type: FORM_RESPONSE
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    metadata:
                      correlationData: your-correlation-data
                    event: MO
              Received reaction response example:
                summary: Received reaction response example
                value:
                  results:
                  - channel: WHATSAPP
                    sender: '48123234567'
                    destination: '48123098765'
                    content:
                    - emoji: \u2764\uFE0F
                      action: ADDED
                      type: REACTION
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
              Received url response example:
                summary: Received url response example
                value:
                  results:
                  - channel: MESSENGER
                    sender: '731401526720514'
                    destination: '24060905360217212'
                    content:
                    - url: http://my.domain/media/my-url
                      type: URL
                    receivedAt: 2020-02-06T14:18:29.797+0000
                    messageId: ABEGVUGWh3gEAgo-sLTvmQCS5kwjhsy
                    messageCount: 1
                    platform:
                      entityId: my-entity-id
                      applicationId: my-application-id
                    event: MO
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
  resource-request-status-change-notification:
    post:
      tags:
      - platform
      summary: Receive resource request status update
      description: 'Any time resource request status is changed, an event is sent.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''RESOURCE_REQUEST_STATUS_UPDATE'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: resource-request-status-change-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocRequestBody'
            examples:
              Alphanumeric Registration - UPDATE_REQUESTED:
                summary: Alphanumeric Registration - UPDATE_REQUESTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      status: UPDATE_REQUESTED
                      type: ALPHANUMERIC_REGISTRATION
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Alphanumeric Registration
                  status:
                  - UPDATE_REQUESTED
              Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                summary: Alphanumeric Registration - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                      type: ALPHANUMERIC_REGISTRATION
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Alphanumeric Registration
                  status:
                  - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
              Alphanumeric Registration - COMPLETED:
                summary: Alphanumeric Registration - COMPLETED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      status: COMPLETED
                      type: ALPHANUMERIC_REGISTRATION
                      requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Alphanumeric Registration
                  status:
                  - COMPLETED
              Alphanumeric Registration - REJECTED:
                summary: Alphanumeric Registration - REJECTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      status: REJECTED
                      type: ALPHANUMERIC_REGISTRATION
                      requirementsFeedback: []
                      note: Your request has been rejected because it contains invalid information for the selected destination.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Alphanumeric Registration
                  status:
                  - REJECTED
              Number Purchase - UPDATE_REQUESTED:
                summary: Number Purchase - UPDATE_REQUESTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: b1d74446-f952-4e54-af09-f1876b344f30
                      status: UPDATE_REQUESTED
                      type: NUMBER_PURCHASE
                      numbers: []
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  status:
                  - UPDATE_REQUESTED
              Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                summary: Number Purchase - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: b1d74446-f952-4e54-af09-f1876b344f30
                      status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                      type: NUMBER_PURCHASE
                      numbers: []
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  status:
                  - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
              Number Purchase - COMPLETED:
                summary: Number Purchase - COMPLETED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: b1d74446-f952-4e54-af09-f1876b344f30
                      status: COMPLETED
                      type: NUMBER_PURCHASE
                      numbers:
                      - number: '+38591234567'
                        numberKey: A3F8C21D04E7B96F2150C8DA3E47B01F
                        status: SUCCESS
                      - number: '+38591234568'
                        numberKey: D92E4B810FC6A3571E08B29CD54F7A2E
                        status: SUCCESS
                      requirementsFeedback: []
                      note: Only 2 out of 5 requested numbers could be procured.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  status:
                  - COMPLETED
              Number Purchase - REJECTED:
                summary: Number Purchase - REJECTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-03-11T09:22:47.000+0000
                    content:
                      id: b1d74446-f952-4e54-af09-f1876b344f30
                      status: REJECTED
                      type: NUMBER_PURCHASE
                      numbers: []
                      requirementsFeedback: []
                      note: Your request has been rejected because it contains invalid information for the selected destination.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - Number Purchase
                  status:
                  - REJECTED
              RCS Sender Launch - UPDATE_REQUESTED:
                summary: RCS Sender Launch - UPDATE_REQUESTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-11-19T11:45:10.000+0000
                    content:
                      id: d3f96668-b174-4d76-8b21-b3098d566b52
                      status: UPDATE_REQUESTED
                      type: RCS_SENDER_LAUNCH
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - RCS Sender Launch
                  status:
                  - UPDATE_REQUESTED
              RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER:
                summary: RCS Sender Launch - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-11-19T11:45:10.000+0000
                    content:
                      id: d3f96668-b174-4d76-8b21-b3098d566b52
                      status: UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
                      type: RCS_SENDER_LAUNCH
                      requirementsFeedback:
                      - key: contactPhoneNumber
                        code: RES_REQ_FEED_REQUIRED
                        feedback: This field is required and cannot be empty.
                      - key: companyName
                        code: RES_REQ_FEED_LENGTH_OOR
                        feedback: Text length must be between 2 and 100.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - RCS Sender Launch
                  status:
                  - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
              RCS Sender Launch - COMPLETED:
                summary: RCS Sender Launch - COMPLETED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-11-19T11:45:10.000+0000
                    content:
                      id: d3f96668-b174-4d76-8b21-b3098d566b52
                      status: COMPLETED
                      type: RCS_SENDER_LAUNCH
                      requirementsFeedback: []
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - RCS Sender Launch
                  status:
                  - COMPLETED
              RCS Sender Launch - REJECTED:
                summary: RCS Sender Launch - REJECTED
                value:
                  results:
                  - event: RESOURCE_REQUEST_STATUS_UPDATE
                    receivedAt: 2025-11-19T11:45:10.000+0000
                    content:
                      id: d3f96668-b174-4d76-8b21-b3098d566b52
                      status: REJECTED
                      type: RCS_SENDER_LAUNCH
                      requirementsFeedback: []
                      note: Your request has been rejected because it contains invalid information for the selected destination.
                    platform:
                      applicationId: application-id
                      entityId: entity-id
                x-label:
                  type:
                  - RCS Sender Launch
                  status:
                  - REJECTED
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
  resource-request-reminder-notification:
    post:
      tags:
      - platform
      summary: Receive resource request reminder
      description: 'When a resource request requires an update and remains inactive, reminder events are sent at 3, 15 and 27 days of inactivity. After 30 days, the request is automatically rejected.

        You need to subscribe to this event over ''REGISTRATION'' channel, and specify the ''RESOURCE_REQUEST_REMINDER'' event.'
      externalDocs:
        description: Learn more about subscription.
        url: https://www.infobip.com/docs/api/platform/subscriptions-api/create-subscription
      operationId: resource-request-reminder-notification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocRequestBody'
            examples:
              Reminder:
                summary: Reminder
                value:
                  results:
                  - event: RESOURCE_REQUEST_REMINDER
                    content:
                      id: a0c63335-f841-4d43-9ef8-e0765a233f29
                      status: UPDATE_REQUESTED
                      type: ALPHANUMERIC_REGISTRATION
                      daysUntilRejection: 27
      responses:
        '200':
          description: Your server returns this code if it accepts the callback.
      x-is-early-access: true
components:
  schemas:
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: SMS
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse:
      type: object
      description: Security configuration.
      properties:
        authId:
          type: string
          description: Unique authorization ID.
      title: Security
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdProfileRequest:
      type: object
      description: Notification profile.
      properties:
        webhook:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook'
        security:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityRequest'
        clientCertificateId:
          type: string
          description: Client certificate ID.
          maxLength: 255
          minLength: 0
        maxBucketSize:
          type: integer
          format: int32
          description: Specifies a maximum number of messages to be sent within a single request.
          maximum: 2000
          minimum: 1
        windowSize:
          type: integer
          format: int32
          description: A maximum number of concurrent connections (active requests) per client.
          maximum: 10000
          minimum: 20
        connectTimeout:
          type: integer
          format: int32
          description: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.
          maximum: 30000
          minimum: 300
        readTimeout:
          type: integer
          format: int32
          description: A maximum period of inactivity in milliseconds between two consecutive data packets.
          maximum: 90000
          minimum: 1000
        enabledSSLProtocols:
          type: array
          description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
          enum:
          - TLSv1.2
          - TLSv1.3
          items:
            type: string
            description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
            enum:
            - TLSv1.2
            - TLSv1.3
          uniqueItems: true
        headers:
          type: object
          additionalProperties:
            type: string
          description: 'Set of key:value pairs that will be sent in a HTTP request as headers.Note: ''Authorization'' header (if configured here for any reason) can be overridden with one from security config.'
        responseRegex:
          type: string
          description: Response regex.
        responseBodyRegex:
          type: string
          description: Response body regex.
        rateLimit:
          type: integer
          format: int32
          description: Limits the number of requests per second.
          maximum: 5000
          minimum: 1
      title: Profile
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Registration
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        shared:
          type: boolean
          description: Indicates whether a resource is shared.
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Open Channel
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform:
      type: object
      description: Platform properties.
      properties:
        applicationId:
          type: string
          description: Campaign application id.
          example: application-id
        entityId:
          type: string
          description: Campaign entity id.
          example: entity-id
      title: CampaignWebhookPlatform
    96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.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
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeys:
      type: object
      properties:
        apiKeys:
          type: array
          description: List of API keys
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse'
      title: ApiKeys
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation:
      type: object
      description: Used for forwarding messages to Conversations service.
      properties:
        enabled:
          type: boolean
          description: Flag which indicates if action is enabled.
      title: UseConversation
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryStatus:
      type: object
      description: Messaged status.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group.
        groupName:
          type: string
          description: Status group name.
        id:
          type: integer
          format: int32
          description: Status ID.
        name:
          type: string
          description: Status name.
        description:
          type: string
          description: Human-readable description of the status.
      required:
      - description
      - groupId
      - groupName
      - id
      - name
      title: MessagesApiDeliveryStatus
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUnifiedNumberCampaignApiModel:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The identifier for the campaign.
          readOnly: true
        referenceId:
          type: string
          description: Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.
          maxLength: 50
          minLength: 0
        applicationId:
          type: string
          description: CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.
        entityId:
          type: string
          description: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
        name:
          type: string
          description: The name of the campaign.
          maxLength: 30
          minLength: 1
          pattern: '[A-Za-z0-9_ ]*'
        createdDate:
          type: string
          format: date-time
          description: The date and time when the campaign was created.
          readOnly: true
        lastModifiedDate:
          type: string
          format: date-time
          description: The date and time when the campaign was last modified.
          readOnly: true
        stage:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage'
        priority:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo'
        type:
          type: string
          enum:
          - TOLL_FREE_UNIFIED_NUMBER
        campaignFeedback:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback'
        privacyPolicyUrl:
          type: string
          description: Public URL to the privacy policy that outlines how user data is collected, stored, and used.
        termsAndConditionsUrl:
          type: string
          description: URL where the terms and conditions of the campaign are located.
        messageVolume:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume'
        numbers:
          type: array
          description: US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.
          items:
            type: string
            description: US TFN numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 18881234567. This property can be used instead of 'numberKeys' to specify the campaign numbers; it is not returned in the API response.
          uniqueItems: true
          writeOnly: true
        numberKeys:
          type: array
          description: The numberKey(s) of the numbers to use with the campaign. Campaign must have at least one TFN number associated before it can be submitted for review. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.
          items:
            type: string
          maxItems: 25
          minItems: 1
          uniqueItems: true
          writeOnly: true
        numberPreviews:
          type: array
          description: The number(s) to use with the campaign. This property is read-only and ignored in POST/PUT calls.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview'
          readOnly: true
          uniqueItems: true
        useCase:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase'
        programSummary:
          type: string
          description: A brief description of the purpose of the campaign.
          maxLength: 500
          minLength: 0
        exampleMessage:
          type: string
          description: The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.
          maxLength: 1000
          minLength: 0
        optIns:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns'
        optInImageURLs:
          type: array
          description: List of URLs linking to screenshots that show how end-users opt in to receive messages.
          items:
            type: string
            description: List of URLs linking to screenshots that show how end-users opt in to receive messages.
            pattern: (?i)https?:\/\/\S+
          uniqueItems: true
        additionalInformation:
          type: string
          description: Free-form field for any extra details relevant to the campaign—such as custom use cases or compliance clarification.
          maxLength: 500
          minLength: 0
        countryCode:
          type: string
          description: The country where the brand is located.
          maxLength: 2
          minLength: 1
        address:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address'
        supportPhone:
          type: string
          description: The business phone number to contact about brand compliance issues.
          maxLength: 16
          minLength: 3
          pattern: \+?[1-9]\d{1,14}
        supportEmail:
          type: string
          description: The business email address to contact about brand compliance issues. Must be a well formed email address that does not include a '=' character.
        businessContactFirstName:
          type: string
          description: First name of the primary contact person for the brand or business entity. Used for verification or compliance outreach.
          maxLength: 100
          minLength: 1
        businessContactLastName:
          type: string
          description: Last name of the primary contact person for the brand or business entity.
          maxLength: 100
          minLength: 1
        legalName:
          type: string
          description: The legal name of the brand.
          maxLength: 255
          minLength: 1
        businessDBA:
          type: string
          description: '''Doing Business As'' name if different from the legal business name.'
          maxLength: 500
          minLength: 0
        businessName:
          type: string
          description: The customer defined name of brand or business entity.
          maxLength: 500
          minLength: 0
        businessWebsite:
          type: string
          description: The website for the brand or business entity.
          maxLength: 500
          minLength: 0
        customerCareEmail:
          type: string
          description: The email address the user may contact to get customer care.  Must be a well formed email address that does not include a '=' character.
          maxLength: 255
          minLength: 1
        taxId:
          type: string
          description: The tax identifier for the brand. Not required for sole proprietor brands.
          maxLength: 50
          minLength: 0
        taxIdIssuingCountry:
          type: string
          description: The country where tax identifier is issued. If not specified, the value from countryCode will be used.
          maxLength: 2
          minLength: 1
        legalEntityType:
          type: string
          description: Legal entity type of the business.
          enum:
          - PRIVATE_COMPANY
          - PUBLIC_COMPANY
          - NON_PROFIT
          - GOVERNMENT
          - SOLE_PROPRIETOR
        businessRegistrationType:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType'
        campaignVerifyToken:
          type: string
          description: Campaign Verify token for POLITICAL campaigns.
        priorityId:
          type: string
          format: uuid
          description: Priority information used in latest campaign review.
          writeOnly: true
      required:
      - businessContactFirstName
      - businessContactLastName
      - businessWebsite
      - customerCareEmail
      - exampleMessage
      - legalEntityType
      - legalName
      - messageVolume
      - name
      - numberKeys
      - optInImageURLs
      - optIns
      - programSummary
      - supportEmail
      - supportPhone
      - useCase
      title: TollFreeUnifiedNumberCampaignApiModel
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Zalo
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Network:
      type: string
      description: The network with which the campaign has been registered.
      enum:
      - ATT
      - T_MOBILE
      - VERIZON
      - US_CELLULAR
      - INTEROP
      - CLEARSKY
      - GOOGLE_VOICE
      - LIBERTY
      - DISH
      - CHARTER_SPECTRUM
      - C_SPIRE
      - GOOGLE_FI
      - TRACFONE
      title: Network
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySubscriptionResponse:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID.
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse'
      title: Subscription
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationResponse:
      type: object
      properties:
        resourceType:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType'
        channel:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType'
        applicationId:
          type: string
          description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
          example: test-application
          maxLength: 255
        entityId:
          type: string
          description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
          example: test-entity
          maxLength: 255
        resourceId:
          type: string
          description: The unique identifier of the resource. It depends on both the `resourceType` and `channel`.<br/>Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.<br/>Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel.
          example: test-resource
          maxLength: 255
      required:
      - applicationId
      - channel
      - resourceId
      - resourceType
      title: ResourceAssociationResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate:
      type: object
      description: Details of the template.
      properties:
        templateName:
          type: string
          description: Name of the template.
        language:
          type: string
          description: Language of the template.
        referenceId:
          type: string
          description: Reference field (used only in Apple) to provide context of what the message is for (e.g. order number, case identifier, etc).
      required:
      - templateName
      title: MessagesApiTemplate
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents:
      type: string
      enum:
      - ACCOUNT_REGISTRATION
      - ACCOUNT_UPDATE_NOTIFICATION
      - BILLING
      - BUSINESS_APP_CONTACT_SYNC
      - BUSINESS_APP_MESSAGE_ECHO
      - BUSINESS_APP_MESSAGE_HISTORY
      - CLICK
      - DELIVERY
      - IDENTITY_CHANGE
      - INBOUND_MESSAGE
      - MARKETING_SUBSCRIPTION_UPDATE
      - PAYMENT_STATUS
      - SEEN
      - TEMPLATE_UPDATE
      title: Event
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookMessage'
      title: CampaignNetworkStatusWebhookResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkStatus:
      type: object
      properties:
        network:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Network'
        state:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkState'
        messageClass:
          type: string
          description: 'This value is provided by some carriers to help determine throughput and daily limits.

            Refer to the [current documentation](https://www.infobip.com/docs/10dlc/throughput) for how to interpret these values as they may change over time.'
        throughput:
          type: integer
          format: int32
          description: 'This value represents the throughput limit, which is calculated based on the message class and brand tier.

            Its meaning varies depending on the carrier: for AT&T, it denotes messages per minute, while for T-Mobile, it denotes messages per day.

            If the throughput value is null, the throughput is considered unlimited.'
        brandTier:
          type: string
          description: This value indicates the brand tier for T-Mobile, which determines the corresponding throughput limit.
      title: NetworkStatus
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - CLICK
          - DELIVERY
          - INBOUND_MESSAGE
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberWebhookStatusNotifApiDoc:
      type: object
      properties:
        id:
          type: string
          description: ID of the resource request.
        status:
          type: string
          description: Status of the resource request.
          enum:
          - UPDATE_REQUESTED
          - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
          - REJECTED
          - COMPLETED
        type:
          type: string
          description: Type of resource.
          enum:
          - NUMBER_PURCHASE
        numbers:
          type: array
          description: List of numbers linked with the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber'
        requirementsFeedback:
          type: array
          description: Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc'
        note:
          type: string
          description: A note containing extra data about the request.
      required:
      - id
      - status
      title: NUMBER_PURCHASE
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDto:
      type: object
      properties:
        id:
          type: string
          description: Field ID.
          example: caad56e4-2a1c-4ae8-9717-ebb40d05533d
        dataType:
          $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDataType'
        name:
          type: string
          description: Field name.
          example: Custom name
        isPredefined:
          type: boolean
          description: Indicates whether the field is predefined by a catalog type. You cannot create predefined fields.
          example: true
      required:
      - dataType
      - id
      - isPredefined
      - name
      title: CatalogFieldDto
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents:
      type: string
      enum:
      - CONVERSATION_ASSIGNMENT_UPDATED
      - CONVERSATION_CREATED
      - CONVERSATION_MESSAGE_DELETED
      - CONVERSATION_MESSAGE_RECEIVED
      - CONVERSATION_MESSAGE_UPDATED
      - CONVERSATION_STATUS_UPDATED
      title: Event
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the resource.
        type:
          type: string
          description: Type of resource.
          enum:
          - RCS_SENDER_LAUNCH
        status:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus'
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        excludedCarriers:
          type: array
          description: List of carrier names excluded from the sender launch.
          items:
            type: string
            description: List of carrier names excluded from the sender launch.
        senderName:
          type: string
          description: Sender name.
        requestedByEmailAddress:
          type: string
          description: Email address of the requester.
        additionalContactEmails:
          type: array
          description: Additional email addresses.
          items:
            type: string
            description: Additional email addresses.
        requestedDate:
          type: string
          format: date-time
          description: Date and time the resource was requested.
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
        note:
          type: string
          description: A note containing extra data about the request.
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        requirementsFeedback:
          type: array
          description: List of feedback for requirements.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      title: RCS_SENDER_LAUNCH
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents:
      type: string
      enum:
      - CLICK
      - DELIVERY
      - INBOUND_MESSAGE
      - TEMPLATE_UPDATE
      title: Event
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents:
      type: string
      enum:
      - CONVERSATION_ASSIGNMENT_UPDATED
      - CONVERSATION_CREATED
      - CONVERSATION_MESSAGE_DELETED
      - CONVERSATION_MESSAGE_RECEIVED
      - CONVERSATION_MESSAGE_UPDATED
      - CONVERSATION_STATUS_UPDATED
      title: Event
    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
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest:
      type: object
      description: Notification profile object holding settings for your webhook URL and a reference to security settings.
      properties:
        profileId:
          type: string
          description: ID of a notification profile. You can provide this ID if you want to associate your subscription with a different notification profile.
          maxLength: 255
          minLength: 1
      required:
      - profileId
      title: Profile
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookContent:
      type: object
      description: Event content.
      properties:
        aiCampaignFeedbackRequestUuid:
          type: string
          format: uuid
          description: Unique identifier of the AI review request, matching the requestUuid returned when the campaign was submitted for AI review.
      title: CampaignAiFeedbackWebhookContent
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryError:
      type: object
      description: Message error if occurred, 0 if there is no error.
      properties:
        groupId:
          type: integer
          format: int32
          description: Error group ID.
        groupName:
          type: string
          description: Error group name.
        id:
          type: integer
          format: int32
          description: Error ID.
        name:
          type: string
          description: Error name.
        description:
          type: string
          description: Human-readable description of the error.
        permanent:
          type: boolean
          description: Tells if the error is permanent.
      required:
      - id
      title: MessagesApiDeliveryError
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookMessage'
      title: BrandAuthUpdateWebhookResponse
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyEntity:
      type: object
      properties:
        entityName:
          type: string
          description: Descriptive name of the resource.
          example: Test name
          maxLength: 255
      title: ModifyEntity
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolAvailability:
      type: string
      enum:
      - AVAILABLE
      - IN_USE
      title: NumberPoolAvailability
    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
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ModifyApplication:
      type: object
      properties:
        applicationName:
          type: string
          description: Descriptive name of the resource.
          example: Test name
          maxLength: 255
      title: ModifyApplication
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentityNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Mobile Identity
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID.
        name:
          type: string
          description: Subscription group name.
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse'
        events:
          type: array
          description: List of events to subscribe.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionEvent'
        criteria:
          type: array
          description: List of applicationId/entityId pairs.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
        resources:
          type: array
          description: List of resources.
          items:
            type: string
            description: List of resources.
        users:
          type: array
          description: List  of users.
          items:
            type: string
            description: List  of users.
      title: Subscription
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration:
      type: object
      properties:
        keyword:
          type: string
          description: Configuration keyword.
          maxLength: 50
          minLength: 0
        action:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction'
        otherActions:
          type: array
          description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
          items:
            type: string
            description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
            readOnly: true
          readOnly: true
        applicationId:
          type: string
          description: ID of the Application that would be associated with the configuration.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the configuration.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        key:
          type: string
          description: Unique ID of configuration.
          readOnly: true
      required:
      - action
      title: MmsConfiguration
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination:
      type: object
      description: Represents a simple destination.
      properties:
        to:
          type: string
          description: The destination address of the message. It can be alphanumeric or numeric.
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - to
      title: To Destination
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - BRAND_AUTH_UPDATE
          example: BRAND_AUTH_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform'
      title: BrandAuthUpdateWebhookMessage
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequest:
      type: object
      properties:
        accountId:
          type: string
          description: Unique identifier for account this API key will belong to. If not provided accountId of the user making the API request will be set. CPaaSX Applications and Entities can be set only on api keys that belong to the account of the user making the request and only if that account is main account.
        name:
          type: string
          description: Name of this API Key.
        allowedIPs:
          type: array
          description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
          externalDocs:
            description: It is recommended to set up AllowedIPs by security recommendations
            url: https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users
          items:
            type: string
            description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
            externalDocs:
              description: It is recommended to set up AllowedIPs by security recommendations
              url: https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users
        validFrom:
          type: string
          format: date-time
          description: Date from which this API key will be valid. Time is in UTC. Should not be earlier than creation date. If not provided default is date of creation.
        validTo:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC. Should not be earlier than validFrom or creation time. If not provided default is 1 year from creation.
        permissions:
          type: array
          description: List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and 'WEB_SDK' permissions. API key cannot be created with both permissions and a collection of Applications and/or Entities in <code>platform</code>.
          enum:
          - PUBLIC_API
          - 2FA_CLIENT
          - WEB_SDK
          items:
            type: string
            description: List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and 'WEB_SDK' permissions. API key cannot be created with both permissions and a collection of Applications and/or Entities in <code>platform</code>.
            enum:
            - PUBLIC_API
            - 2FA_CLIENT
            - WEB_SDK
        platform:
          type: array
          description: A collection of CPaaS X Applications and Entities that will be linked to the API Key. API key cannot be created with both permissions and a collection of Applications and/or Entities.
          externalDocs:
            description: API Key will only have access to these endpoints.
            url: https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform'
        scopeGuids:
          type: array
          description: List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key.
          items:
            type: string
            description: List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key.
          uniqueItems: true
      required:
      - name
      title: CreateApiKeyRequest
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocRequestBody:
      type: object
      properties:
        results:
          type: array
          description: List of events provided in a single request.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocResult'
      title: WebhookReminderNotifApiDocRequestBody
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - AI_CAMPAIGN_BUILDER
          example: AI_CAMPAIGN_BUILDER
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform'
      title: CampaignAiBuilderWebhookMessage
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.EmailStatus:
      type: object
      properties:
        description:
          type: string
          description: Human-readable description of the status.
          readOnly: false
          writeOnly: false
        name:
          type: string
          description: '[Status name](https://www.infobip.com/docs/essentials/response-status-and-error-codes).'
          readOnly: false
          writeOnly: false
      title: EmailStatus
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateApiKeyRequestV1:
      type: object
      properties:
        name:
          type: string
          description: Name of the API key
        allowedIPs:
          type: array
          description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
          items:
            type: string
            description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
        validTo:
          type: string
          format: date-time
          description: Date from which this API key is/will be valid. Time is in UTC
        validFrom:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC.
        enabled:
          type: boolean
          description: Only enabled API keys will be accepted. When revoking existing API key, this property can be set to false.
        permissions:
          type: array
          description: List of permissions this API key has granted. Default permission is 'ALL'. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission'
      required:
      - name
      title: CreateApiKeyRequestV1
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse:
      type: object
      properties:
        certificateId:
          type: string
          description: Certificate identifier.
        status:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus'
      title: CertificateStatusResponse
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission:
      type: string
      description: List of permissions this API key has granted. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.
      enum:
      - ALL
      - TFA
      - PUSH_CLIENT
      - PEOPLE_EVENTS_PUBLIC_CLIENT
      - EXTERNAL_INTEGRATIONS
      title: Permission
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseDetails:
      type: object
      description: Other details of the message.
      title: MessageResponseDetails
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogItemDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Item ID.
          example: 10000
        values:
          type: array
          description: A list of item field values. Maximum <code>1000</code> values.
          items:
            $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogValueDto'
      required:
      - id
      - values
      title: CatalogItemDto
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents:
      type: string
      enum:
      - DELIVERY
      - INBOUND_MESSAGE
      title: Event
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Facebook
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language:
      type: string
      enum:
      - en
      - es
      - ca
      - da
      - nl
      - fr
      - de
      - it
      - ja
      - ko
      - 'no'
      - pl
      - ru
      - sv
      - fi
      - hr
      - sl
      - ro
      - pt_pt
      - pt_br
      - zh_cn
      - zh_tw
      title: Language
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSecurityRequest:
      type: object
      description: Security configuration.
      properties:
        type:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType'
        credentials:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload'
      title: Security
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PurchaseNumberRequest:
      type: object
      properties:
        numberKey:
          type: string
        number:
          type: string
        applicationId:
          type: string
          description: ID of the Application that would be associated with the number.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the number.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
      title: PurchaseNumberRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents:
      type: string
      enum:
      - CLICK
      - CONSENT_UPDATE
      - DELIVERY
      - INBOUND_MESSAGE
      - SEEN
      - TEMPLATE_UPDATE
      title: Event
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateSmsOrVoiceMessageRequest:
      type: object
      properties:
        language:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language'
          description: Language code which message is written in. This is used when sending text-to-speech messages. If not defined, it will default to English (`en`).
          readOnly: false
          writeOnly: true
        messageText:
          type: string
          description: Content of the message being sent which contains at minimum one placeholder for a PIN code (`{{pin}}`). Placeholder format is `{{placeholderName}}`.
          readOnly: false
          writeOnly: true
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: true
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: The type of PIN code that will be generated and sent as part of a 2FA message.
          readOnly: false
          writeOnly: true
        regional:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions'
          description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending a message to requires additional information.
          readOnly: false
          writeOnly: true
        repeatDTMF:
          type: string
          description: If the PIN is sent as a voice message, the DTMF code allows the recipient to replay the message.
          readOnly: false
          writeOnly: true
        senderId:
          type: string
          description: The name that will appear as the sender of the 2FA message (e.g. CompanyName).
          readOnly: false
          writeOnly: true
        speechRate:
          type: number
          format: double
          description: The speed of narration for messages sent as voice. Supported range is from `0.5` to `2`.
          readOnly: false
          writeOnly: true
        voiceName:
          type: string
          description: 'Defines the voice that will be used for the chosen language (example: Joanna). For each supported language, we may offer different voices (learn more [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages)). You can use this [method](https://www.infobip.com/docs/api/channels/voice/voice-message/get-voices) to retrieve all voices for the given language. If not defined, it will default to the standard voice for the selected language (if available). If the standard voice is not available, the request will fail. To avoid that, you can choose one of the neural voices (charges will apply).'
          readOnly: false
          writeOnly: true
      title: UpdateSmsOrVoiceMessageRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Open Channel
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents:
      type: string
      enum:
      - CLICK
      - COMPLAINT
      - DELIVERY
      - HIGH_BOUNCE_RATE_BLOCKED
      - HIGH_BOUNCE_RATE_WARNING
      - LATE_BOUNCE
      - OPEN
      - UNSUBSCRIBE
      title: Event
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequestViaEmail:
      type: object
      properties:
        landingPagePlaceholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced when using personalized opt out landing page. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"landingPagePlaceholders":{"name":"John", "surname": "Smith"}`'
          readOnly: false
          writeOnly: true
        placeholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"placeholders":{"firstName":"John"}`'
          readOnly: false
          writeOnly: true
      title: ResendPinRequestViaEmail
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover:
      type: object
      description: Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
      oneOf:
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiFailover'
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFailover'
      title: MessagesApiBaseFailover
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TransliterationCode:
      type: string
      description: 'The transliteration of your sent message from one script to another. Transliteration is used to replace characters which are not recognized as part of your defaulted alphabet. Possible values: `TURKISH`, `GREEK`, `CYRILLIC`, `SERBIAN_CYRILLIC`, `BULGARIAN_CYRILLIC`, `CENTRAL_EUROPEAN`, `BALTIC`, `PORTUGUESE`, `COLOMBIAN`, and `NON_UNICODE`. Supported by SMS.'
      enum:
      - NONE
      - TURKISH
      - GREEK
      - CYRILLIC
      - SERBIAN_CYRILLIC
      - CENTRAL_EUROPEAN
      - BALTIC
      - NON_UNICODE
      - PORTUGUESE
      - COLOMBIAN
      - BULGARIAN_CYRILLIC
      - ALL
      title: TransliterationCode
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityType:
      type: string
      description: Type of a priority
      enum:
      - TEN_DLC
      - SHORT_CODE
      - TFN
      title: PriorityType
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaWebhookStatusNotifApiDoc:
      type: object
      properties:
        id:
          type: string
          description: ID of the resource request.
        status:
          type: string
          description: Status of the resource request.
          enum:
          - UPDATE_REQUESTED
          - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
          - REJECTED
          - COMPLETED
        type:
          type: string
          description: Type of resource.
          enum:
          - ALPHANUMERIC_REGISTRATION
        requirementsFeedback:
          type: array
          description: Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc'
        note:
          type: string
          description: A note containing extra data about the request.
      required:
      - id
      - status
      title: ALPHANUMERIC_REGISTRATION
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Voice and Video
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryReportResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming Delivery reports.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult'
      required:
      - results
      title: MessagesApiDeliveryReportResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Line
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Customer Engagement
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageOrderingOptions:
      type: object
      description: Message ordering options.
      properties:
        respectOrder:
          type: boolean
          default: true
          description: If set to `true`, messages will be sent in the same order as they are provided in the request.
        stopOnFailure:
          type: boolean
          default: true
          description: It can be used in combination with `respectOrder` to stop sending messages when first message from request fails.
      title: MessageOrderingOptions
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultMessageFlow:
      type: object
      description: Campaign message flow for Short Code campaigns
      properties:
        optInMessage:
          type: string
          description: Opt-in confirmation message
        exampleMessage1:
          type: string
          description: First example message
        exampleMessage2:
          type: string
          description: Second example message
        helpMessage:
          type: string
          description: Help response message
        optOutMessage:
          type: string
          description: Opt-out response message
      title: ShortCodeCampaignBuilderResultMessageFlow
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificatesSortType:
      type: string
      enum:
      - CERTIFICATE_ID
      title: CertificatesSortType
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogTypes:
      type: string
      description: Catalog type.
      enum:
      - BLANK
      - PRODUCTS
      - STORES
      - ARTICLES
      example: BLANK
      title: CatalogTypes
    8107508a6b6ebe39d7ea5cd4a2338a61e45bf1b939b4ec9bc51846ab35de14ea.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      required:
      - requestError
      title: ApiException
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebOptIn:
      type: object
      description: The type of opt in that requires a user to follow a URL.
      properties:
        callToAction:
          type: string
          description: "    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n"
          maxLength: 1024
          minLength: 20
        url:
          type: string
          maxLength: 255
          minLength: 11
      required:
      - callToAction
      title: WebOptIn
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement:
      type: object
      description: List of requirements for the resource.
      properties:
        key:
          type: string
          description: The key of the requirement.
        value:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.JsonNode'
      required:
      - key
      - value
      title: FilledRequirement
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfilePage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse'
        paging:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo'
      title: ProfilePage
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinResponse:
      type: object
      properties:
        attemptsRemaining:
          type: integer
          format: int32
          description: Number of remaining PIN attempts.
          readOnly: true
          writeOnly: false
        msisdn:
          type: string
          description: Phone number (`MSISDN`) to which the 2FA message was sent.
          readOnly: true
          writeOnly: false
        pinError:
          type: string
          description: Indicates whether an error has occurred during PIN verification.
          readOnly: true
          writeOnly: false
        pinId:
          type: string
          description: Sent PIN code ID.
          readOnly: true
          writeOnly: false
        verified:
          type: boolean
          description: Indicates whether the phone number (`MSISDN`) was successfully verified.
          readOnly: true
          writeOnly: false
      title: VerifyPinResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryResult:
      type: object
      description: Incoming Delivery reports.
      properties:
        event:
          type: string
          default: DELIVERY
          description: Event type (delivery report in this case).
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundDlrChannel'
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        destination:
          type: string
          description: Message destination address.
        sentAt:
          type: string
          description: 'Tells when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        doneAt:
          type: string
          description: 'Tells when the message was finished processing by Infobip (ie. delivered to destination, delivered to destination network, etc.). Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        callbackData:
          type: string
          description: Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists).
        messageCount:
          type: integer
          format: int32
          description: The number of parts the message content was split into.
        status:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryStatus'
        error:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDeliveryError'
        platform:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform'
        deviceDetails:
          type: string
          description: Device name if available.
        mccMnc:
          type: integer
          format: int32
          description: Mobile country and network codes.
        networkId:
          type: integer
          format: int32
          description: Network id dependent on Country.
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      required:
      - bulkId
      - channel
      - destination
      - doneAt
      - error
      - event
      - messageCount
      - messageId
      - sender
      - sentAt
      - status
      title: MessagesApiDeliveryResult
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UpdateResourceOrderRequest:
      type: object
      properties:
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
      required:
      - requirements
      title: UpdateResourceOrderRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup:
      type: object
      description: Voice setup configuration.
      properties:
        applicationId:
          type: string
          description: ID of the Application that would be associated with the voice setup.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the voice setup.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        action:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails'
      required:
      - action
      title: VoiceSetup
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType:
      type: string
      description: Defines action type. It is not possible to create new action type.
      enum:
      - PULL
      - HTTP_FORWARD
      - SMPP_FORWARD
      - MAIL_FORWARD
      - NO_ACTION
      - BLOCK
      - AUTORESPONSE
      - USSD
      - SEND_BULK_MT
      - EMAIL_TO_SMS_FORWARD
      - CNS_FWD
      - USE_CONVERSATIONS
      - FORWARD_TO_PSTN
      - FORWARD_TO_IP
      - FORWARD_TO_IVR
      - VOICE_NUMBER_MASKING
      - VOICE_CALL_DROP
      - FORWARD_TO_WEBRTC
      - VOICE_FORWARD_TO_CONVERSATIONS
      - VOICE_FORWARD_TO_CONVERSATIONS_WITH_FLOW
      - CALL_FORWARD_TO_APPLICATION
      - FORWARD_TO_SUBSCRIPTION
      - FORWARD_TO_CALL_ROUTING
      - USE_ANSWERS
      - VOICE_FORWARD_TO_ANSWERS
      - VOICE_FORWARD_TO_FLOW
      - VOICE_FORWARD_TO_FLOW_WITH_CONVERSATIONS
      - FORWARD_TO_OPERATOR_CONNECT
      - FORWARD_TO_EXTERNAL_INTEGRATION
      - FORWARD_TO_AI_AGENT
      - FORWARD_TO_MARKUP_LANGUAGE
      - OTHER
      title: MoActionType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents:
      type: string
      enum:
      - BLOCK
      - UNBLOCK
      title: Event
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignStage:
      type: string
      description: The new campaign registration.
      enum:
      - REGISTERED
      - REJECTED
      - DEREGISTERED
      - SUBMITTED
      - APPROVED_BY_INTERNAL_REVIEWER
      example: REJECTED
      title: WebhookCampaignStage
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.Paging:
      type: object
      description: Pagination information.
      properties:
        page:
          type: integer
          format: int32
          description: Current page.
          example: 1
        size:
          type: integer
          format: int32
          description: Page size.
          example: 20
        totalPages:
          type: integer
          format: int32
          description: Total amount of pages.
          example: 5
        totalResults:
          type: integer
          format: int64
          description: Total amount of results.
          example: 100
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: Paging
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType:
      type: string
      description: An array of communication channels the number can support.
      enum:
      - SMS
      - VOICE
      - MMS
      - WHATSAPP
      - WHATSAPP_VOICE
      title: NumberCapabilityType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - CLICK
          - CONSENT_UPDATE
          - DELIVERY
          - INBOUND_MESSAGE
          - SEEN
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerifyPinRequest:
      type: object
      properties:
        pin:
          type: string
          description: The PIN code to verify.
          readOnly: false
          writeOnly: true
      required:
      - pin
      title: VerifyPinRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UpdateOwnedNumberRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: ID of the Application that would be associated with the number.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          minLength: 1
        entityId:
          type: string
          description: ID of the Entity that would be associated with the number.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
      required:
      - applicationId
      title: UpdateOwnedNumberRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Blocklist
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents:
      type: string
      enum:
      - DELIVERY
      - INBOUND_MESSAGE
      title: Event
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageInfo:
      type: object
      description: Information about the number coverage.
      properties:
        number:
          type: string
          description: Phone number.
          example: '447860041117'
        numberKey:
          type: string
          description: Number key.
          example: 58B3840032C7774BAC840EEEA2C23A44
        platform:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs'
        numberType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType'
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Number
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan:
      type: object
      description: "\nRepresents the time within which a message is opened after the message is delivered using time buckets.\n\nFor example, you can filter only for messages opened within 1 second after they were delivered. The `from` bucket is inclusive, while the `to` bucket is exclusive.\n    "
      properties:
        from:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeBucket'
        to:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeBucket'
      title: TimeSpan
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse:
      type: object
      description: Security configuration.
      properties:
        authId:
          type: string
          description: Unique authorization ID.
        type:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType'
        credentials:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload'
      title: Security
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service, e.g. 2FA for login, 2FA for changing the password, etc.
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: Use this parameter if you wish to override the sender from the [created](#channels/sms/create-2fa-email-message-template) Email message template parameter `from`.
          readOnly: false
          writeOnly: false
        landingPagePlaceholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced when using personalized opt out landing page. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"landingPagePlaceholders":{"name":"John", "surname": "Smith"}`'
          readOnly: false
          writeOnly: true
        messageId:
          type: string
          description: The ID of the Email message template (message with the PIN placeholder) that is sent to the recipient.
          readOnly: false
          writeOnly: false
        placeholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"placeholders":{"firstName":"John"}`'
          readOnly: false
          writeOnly: false
        to:
          type: string
          description: 'Email address to which the 2FA message will be sent. Example: john.smith@example.com.'
          readOnly: false
          writeOnly: false
      required:
      - applicationId
      - messageId
      - to
      title: StartEmailAuthenticationRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindowResponse:
      type: object
      description: Used to specify a time-window in which a response message is allowed to be sent. If not defined there is no limitation when message will be sent.
      properties:
        from:
          type: string
          description: Exact time of day in which the sending can start. Consists of hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as <code>HH:mm</code>.
          example: 08:35
        to:
          type: string
          description: Exact time of day in which the sending will end. Consists of an hour and minute properties, both mandatory. Time is expressed in the UTC time zone. Formatted as <code>HH:mm</code>.
          example: '16:35'
        days:
          type: array
          description: Days which are included in the delivery time window.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek'
          uniqueItems: true
        deliveryTimeZone:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZoneResponse'
      required:
      - days
      - deliveryTimeZone
      - from
      - to
      title: DeliveryTimeWindowResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - CAMPAIGN_NETWORK_STATUS_UPDATE
          example: CAMPAIGN_NETWORK_STATUS_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform'
      title: CampaignNetworkStatusWebhookMessage
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase:
      type: string
      description: Campaign use case.
      enum:
      - TWO_FA
      - APP_NOTIFICATIONS
      - APPOINTMENTS
      - AUCTIONS
      - AUTO_DEALERSHIP_SERVICES
      - BANKING
      - BILLING
      - BOOKING_CONFIRMATIONS
      - BUSINESS_UPDATES
      - COVID_19_ALERTS
      - CAREER_TRAINING
      - CHATBOT
      - CONVERSATIONAL_ALERTS
      - COURIER_SERVICES_DELIVERIES
      - EDUCATIONAL
      - EMERGENCY_ALERTS
      - EMPLOYEE_ALERTS_NOTIFICATIONS
      - EVENTS_PLANNING
      - FINANCIAL_SERVICES
      - FRAUD_ALERTS
      - FUNDRAISING
      - GENERAL_MARKETING
      - HR_STAFFING
      - HEALTHCARE
      - HOUSING_COMMUNITY_UPDATES
      - INSURANCE_SERVICES
      - JOB_ALERTS
      - LEGAL_SERVICES
      - MIXED
      - MOTIVATIONAL_REMINDERS
      - NOTARY_NOTIFICATIONS
      - NOTIFICATIONS
      - ORDER_NOTIFICATIONS
      - POLITICAL
      - PUBLIC_WORKS
      - REAL_ESTATE_SERVICES
      - RECEIPT_NOTIFICATIONS
      - RELIGIOUS_SERVICES
      - REPAIR_DIAGNOSTICS_ALERTS
      - REWARDS_PROGRAM
      - SURVEYS
      - SYSTEM_ALERTS
      - WAITLIST_ALERTS
      - WEBINAR_REMINDERS
      - WORKSHOP_ALERTS
      title: TollFreeUseCase
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.IndiaDltOptions:
      type: object
      properties:
        contentTemplateId:
          type: string
          description: Registered DLT content template ID which matches message you are sending.
          maxLength: 30
          minLength: 0
          readOnly: false
          writeOnly: false
        principalEntityId:
          type: string
          description: Your assigned DLT principal entity ID.
          maxLength: 30
          minLength: 0
          readOnly: false
          writeOnly: false
        teleMarketerId:
          type: string
          description: Your assigned Telemarketer ID (required for Aggregators).
          maxLength: 255
          minLength: 0
          readOnly: false
          writeOnly: false
      required:
      - principalEntityId
      title: IndiaDltOptions
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback:
      type: object
      description: List of feedback for requirements.
      properties:
        key:
          type: string
          description: Key of the requirement for which feedback is provided.
        code:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode'
        feedback:
          type: string
          description: Feedback for the requirement.
      title: FilledRequirementFeedback
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RegionalOptions:
      type: object
      description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending an SMS to requires additional information.
      properties:
        indiaDlt:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.IndiaDltOptions'
        turkeyIys:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TurkeyIysOptions'
        southKorea:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SouthKoreaOptions'
      title: RegionalOptions
    17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationRequest:
      type: object
      properties:
        configuration:
          allOf:
          - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationConfiguration'
          description: Created 2FA application configuration.
          readOnly: false
          writeOnly: true
        enabled:
          type: boolean
          description: Indicates whether the created application is enabled.
          readOnly: false
          writeOnly: true
        name:
          type: string
          description: 2FA application name.
          readOnly: false
          writeOnly: true
      required:
      - name
      title: ApplicationRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.OptIns:
      type: object
      properties:
        keyword:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.KeywordOptIn'
        web:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebOptIn'
        verbal:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VerbalOptIn'
        interactiveVoiceResponse:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.InteractiveVoiceResponseOptIn'
      title: OptIns
    e8b4ac5a98b4fdd5509637ee70be50d1c508e5a4c9ac2c19485e7cdc7eb9bd4e.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealDocument:
      type: object
      description: A document attached to a brand identity appeal.
      properties:
        documentId:
          type: string
          format: uuid
          description: ID of the previously uploaded document.
        documentType:
          type: string
          description: Classification of the document type. Defaults to OTHER if not specified.
          enum:
          - IRS_CP575
          - OTHER
      required:
      - documentId
      title: AppealDocument
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.UpdateEmailMessageRequest:
      type: object
      properties:
        emailTemplateId:
          type: integer
          format: int64
          description: Email template ID that should reference a previously created Email template.
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: The sender of the 2FA message, an email address with an optional sender name (e.g. `company@example.com` or `Jane Smith <jane.smith@somecompany.com>`).
          readOnly: false
          writeOnly: false
        landingPageId:
          type: string
          description: Opt out landing page ID that should reference a previously created landing page template.
          readOnly: false
          writeOnly: false
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: true
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: The type of PIN code that will be generated and sent as part of a 2FA message.
          readOnly: false
          writeOnly: true
      title: UpdateEmailMessageRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelDestination:
      type: object
      description: An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
      properties:
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel'
        to:
          type: string
          description: The destination address of the message associated with given channel. It can be alphanumeric or numeric.
        messageId:
          type: string
          deprecated: true
          description: The ID that uniquely identifies the message sent.
          maxLength: 200
          minLength: 0
      required:
      - channel
      - to
      title: MessagesApiChannelDestination
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateInterval:
      type: object
      description: "\nTime period for billing data in UTC.\n\n`sentSince` is inclusive and `sentUntil` is exclusive. Billing usage data is available for the current month and the\nprevious two calendar months.\n        "
      properties:
        sentSince:
          type: string
          format: date
          description: "\nStart of period (inclusive). Uses UTC timezone.\n\nFormat: `yyyy-MM-dd`.\n        "
          example: '2026-03-01'
        sentUntil:
          type: string
          format: date
          description: "\nEnd of period (exclusive). Uses UTC timezone.\n\nFormat: `yyyy-MM-dd`.\n        "
          example: '2026-04-01'
      required:
      - sentSince
      - sentUntil
      title: DateInterval
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent:
      type: object
      description: Content of the message.
      properties:
        header:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader'
        body:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody'
        buttons:
          type: array
          description: List of buttons of the message.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton'
        confirmationBody:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageConfirmationBody'
        senderDisplayInfo:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSenderDisplayInfo'
        footer:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFooter'
      required:
      - body
      title: MessagesApiMessageContent
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequest:
      type: object
      properties:
        accountId:
          type: string
          description: Unique identifier for account this API key belongs to. If not provided accountId of the user making the API request will be set. CPaaSX Applications and Entities can be set only on api keys that belong to the account of the user making the request and only if that account is main account.
        name:
          type: string
          description: Name of this API Key.
        allowedIPs:
          type: array
          description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
          externalDocs:
            description: It is recommended to set up AllowedIPs by security recommendations
            url: https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users
          items:
            type: string
            description: List of IP addresses or IP ranges from which this API key will be used. Authentication will fail from any other IP not specified in this list.
            externalDocs:
              description: It is recommended to set up AllowedIPs by security recommendations
              url: https://www.infobip.com/docs/essentials/security-recommendations#entry-point-specific-users
        validFrom:
          type: string
          format: date-time
          description: Date from which this API key is/will be valid. Time is in UTC.
        validTo:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC.
        enabled:
          type: boolean
          description: Enable or disable API key.
        permissions:
          type: array
          description: List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and WEB_SDK permissions. API key cannot be updated with both permissions and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent all current permissions assigned to api key will be removed and 'PUBLIC_API' will be set as default.
          enum:
          - PUBLIC_API
          - 2FA_CLIENT
          - WEB_SDK
          items:
            type: string
            description: List of permissions this API key has granted. Default permission is 'PUBLIC_API'. API key cannot be created with both 'PUBLIC_API' and WEB_SDK permissions. API key cannot be updated with both permissions and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent all current permissions assigned to api key will be removed and 'PUBLIC_API' will be set as default.
            enum:
            - PUBLIC_API
            - 2FA_CLIENT
            - WEB_SDK
        platform:
          type: array
          description: A collection of CPaaS X Applications and Entities that will be linked to the API key. All Applications and Entities will be removed from the api key if an empty platform list is sent and 'PUBLIC_API' will be assigned as default permission. Or, to remove a specific Application/Entity pair, omit it from the platform list.
          externalDocs:
            description: 'WARNING: linking an existing API Key to an Application and/or Entity will limit access to these endpoints.'
            url: https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform'
        scopeGuids:
          type: array
          description: List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key. An API key cannot be updated with both scopes and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent, all current scopes assigned to the API Key will be removed and it will no longer be able to access any API endpoint.
          items:
            type: string
            description: List of [API scopes](https://www.infobip.com/docs/essentials/api-essentials/api-authorization#available-api-scopes-api-scopes) that will be assigned to the API key. An API key cannot be updated with both scopes and a collection of Applications and/or Entities in <code>platform</code>. If an empty list is sent, all current scopes assigned to the API Key will be removed and it will no longer be able to access any API endpoint.
          uniqueItems: true
      title: UpdateApiKeyRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookContent:
      type: object
      description: Event content.
      properties:
        campaignId:
          type: string
          format: uuid
          description: The ID of campaign.
          example: 38a1c2c6-55f2-11ee-a061-325096b39f47
        tcrId:
          type: string
          description: The ID of the campaign as defined by The Campaign Registry. This field is present only for 10DLC campaigns.
          example: C0O3XVU
        campaignStatus:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignStage'
        rejectionReasons:
          type: string
          description: The rejection reasons. This field is present only when new campaign registration status is 'REJECTED'.
          example: Unable to verify, need website.
        rejectionDetails:
          type: array
          description: The rejection reasons details. This field is present only when new campaign registration status is 'REJECTED'.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReasonPayload'
        rejectionDate:
          type: string
          format: date-time
          description: The rejection date. This field is present only when new campaign registration status is 'REJECTED'.
      title: CampaignStatusWebhookContent
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleCustomerEngagementEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Customer Engagement
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc:
      type: object
      description: Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.
      properties:
        key:
          type: string
          description: Key of the requirement for which feedback is provided.
        code:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode'
        feedback:
          type: string
          description: Feedback for the requirement.
      title: FilledRequirementFeedbackApiDoc
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents:
      type: string
      enum:
      - CAP_CHECK
      - CLICK
      - CONVERSATION_STARTED
      - DELIVERY
      - INBOUND_MESSAGE
      - SEEN
      - SENDER_LAUNCH_UPDATE
      - SENDER_UPDATE
      - SUGGESTION
      - TEMPLATE_UPDATE
      - TEST_NUMBER_UPDATE
      - TYPING_INDICATOR
      title: Event
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Email
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamDelivery:
      type: object
      description: CNAM Delivery is enabled on your DID at an additional charge that allows you to see the caller identification of the person calling you.
      properties:
        enabled:
          type: boolean
          default: false
          description: Indicates whether configuration is enabled or not.
      title: CnamDelivery
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResult:
      type: object
      properties:
        requestId:
          type: string
          description: The identifier of original request returned by [Query aggregated traffic data](#platform/metrics-api/query-aggregate-data) endpoint.
        status:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataStatus'
        response:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataResponse'
        failureMessage:
          type: string
          description: The message describing the failure. This field is present only if the request failed.
      required:
      - requestId
      - status
      title: QueryAggregateDataResult
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase:
      type: string
      description: Campaign use case.
      enum:
      - ALERTS
      - CHAT
      - DONATION
      - EDUCATION
      - FRAUD_ALERTS
      - PROMOTIONAL_MARKETING
      - PUBLIC_SERVICE_ANNOUNCEMENT
      - TWO_FACTOR_AUTH
      - VOTING_POLLING
      - POLITICAL
      - M2M
      - SWEEPSTAKE
      title: TenDlcUseCase
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandType:
      type: string
      description: The type of brand.
      enum:
      - TENDLC_NON_PROFIT
      - TENDLC_PRIVATE_COMPANY
      - TENDLC_PUBLIC_COMPANY
      - TENDLC_GOVERNMENT
      title: BrandType
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToDelete:
      type: object
      description: To.
      properties:
        to:
          type: string
          description: 'Destination address that needs to be removed from blocklist. Addresses must be a number in international format (example: `41793026727`), a valid email address (example: `recipient@example.com`) or valid email domain (example: `example.com`).'
          maxLength: 255
          minLength: 1
      required:
      - to
      title: ToDelete
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Kakao Brand Message
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.PagingResponse:
      type: object
      properties:
        page:
          type: integer
          format: int32
        pageSize:
          type: integer
          format: int32
        orderDirection:
          type: string
        orderBy:
          type: string
        totalCount:
          type: integer
          format: int64
        totalPages:
          type: integer
          format: int32
      title: PagingResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverage:
      type: object
      description: Information about the networks configured for the resource.
      properties:
        outbound:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NetworkView'
          uniqueItems: true
        inbound:
          type: boolean
          description: Indicates if inbound configuration exists.
          example: false
      title: IbResourceCoverage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents:
      type: string
      enum:
      - CLICK
      - DELIVERY
      title: Event
    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
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButtonType:
      type: string
      enum:
      - QUICK_REPLY
      - OPEN_URL
      - PHONE_NUMBER
      - FLOW
      - COPY_CODE
      - CATALOG
      - MULTI_PRODUCT
      title: MessagesApiTemplateButtonType
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButton:
      type: object
      description: List of buttons of the message.
      discriminator:
        propertyName: type
        mapping:
          REPLY: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageReplyButton'
          OPEN_URL: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOpenUrlButton'
          DIAL_PHONE: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDialPhoneButton'
          SHOW_LOCATION: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageShowLocationButton'
          REQUEST_LOCATION: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRequestLocationButton'
          ADD_CALENDAR_EVENT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAddCalendarEventButton'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButtonType'
      required:
      - type
      title: MessagesApiMessageButton
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenReport:
      type: object
      properties:
        results:
          type: array
          description: Collection of reports, one per every message.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenResult'
      required:
      - results
      title: MessagesApiSeenReport
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BusinessRegistrationType:
      type: string
      description: 'Type of tax identification number provided. Value depend on selected taxId issuing country. For US it can be only EIN.

        Not required for sole proprietor brands.'
      enum:
      - EIN
      - CBN
      - NEQ
      - PROVINCIAL_NUMBER
      - CRN
      - VAT
      - ACN
      - ABN
      - BRN
      - SIREN
      - SIRET
      - NZBN
      - UST_IDNR
      - CIF
      - NIF
      - CNPJ
      - UID
      - OTHER
      title: BusinessRegistrationType
    b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.OAuthApiException:
      type: object
      properties:
        error:
          type: string
          description: Deprecated, use requestError field instead. Shows error message.
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: OAuthApiException
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.AccountsResponse:
      type: object
      properties:
        accounts:
          type: array
          description: List of accounts
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account'
      title: AccountsResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealPreview:
      type: object
      description: Summary information about a single brand appeal.
      properties:
        appealId:
          type: string
          format: uuid
          description: Unique identifier of the appeal.
        status:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealStatus'
        submittedAt:
          type: string
          format: date-time
          description: Timestamp when the appeal was submitted.
        rejectionReason:
          type: string
          description: Reason for rejection. Present only when the appeal status is REJECTED.
      title: BrandAppealPreview
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeUseCase:
      type: string
      description: Campaign use case.
      enum:
      - ALERTS
      - CHAT
      - DONATION
      - EDUCATION
      - FRAUD_ALERTS
      - PROMOTIONAL_MARKETING
      - PUBLIC_SERVICE_ANNOUNCEMENT
      - SWEEPSTAKES_CONTEST
      - TWO_FACTOR_AUTH
      - VOTING_POLLING
      - POLITICAL
      - EMERGENCY_NOTIFICATIONS
      - DELIVERY_NOTIFICATIONS
      - SECURITY_ALERT
      title: ShortCodeUseCase
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs:
      type: object
      description: Platform applicationId and entityId to apply to inbound messages that pair to this configuration. If not provided, or if set to default values (applicationId = default and entityId = null), values from the associated number/resource will be used.
      externalDocs:
        description: Find out more about Application and Entity Management
        url: https://www.infobip.com/docs/api/platform/application-entity
      properties:
        applicationId:
          type: string
          description: Platform applicationId.
          example: myApplicationId
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: Platform entityId.
          example: myEntityId
          maxLength: 255
          minLength: 0
      title: PlatformDocs
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.DeletableChannel:
      type: string
      description: Channel for which blocklist record/s will be removed.
      enum:
      - SMS
      - EMAIL
      - VIBER
      - RCS
      - MMS
      - APPLE_MB
      - WHATSAPP
      title: DeletableChannel
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.Content:
      type: object
      description: Event content.
      properties:
        sender:
          type: string
          description: The sender ID for which blocklist happened.
        destination:
          type: string
          description: Blocklisted destination address.
        channel:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ViewableChannel'
        sourceType:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.EventSourceType'
        outboundMessageReference:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.OutboundMessageReference'
        inboundMessageReference:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.InboundMessageReference'
        campaignReference:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CampaignReference'
      required:
      - destination
      - sourceType
      title: Content
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec:
      type: object
      description: List of requirements needed for the resource request.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TextRequirementSpec'
          INTEGER: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.IntegerRequirementSpec'
          EMAIL: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.EmailRequirementSpec'
          URL: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UrlRequirementSpec'
          GSM: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.GsmRequirementSpec'
          DOCUMENT: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentRequirementSpec'
      properties:
        type:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FieldType'
      title: RequirementSpec
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VerbalOptIn:
      type: object
      description: The type of opt in that requires a user to verbally confirm.
      properties:
        callToAction:
          type: string
          description: "    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n"
          maxLength: 1024
          minLength: 20
      required:
      - callToAction
      title: VerbalOptIn
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealResponse:
      type: object
      description: Response returned after successfully submitting a brand identity appeal.
      properties:
        appealId:
          type: string
          format: uuid
          description: Unique identifier assigned to the submitted appeal.
      title: BrandAppealResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction:
      type: object
      description: List of other configured actions on this keyword. Ignored in POST/PUT calls.
      discriminator:
        propertyName: type
        mapping:
          AUTORESPONSE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseAction'
          BLOCK: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockAction'
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType'
        editable:
          type: boolean
          description: Flag which indicates if given action is editable. Ignored on POST/PUT requests.
          readOnly: true
      readOnly: true
      required:
      - type
      title: MoNonForwardAction
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application:
      type: object
      properties:
        applicationName:
          type: string
          description: Descriptive name of the resource.
          example: Test name
          maxLength: 255
        applicationId:
          type: string
          description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
          example: test-application
          maxLength: 255
      required:
      - applicationId
      title: Application
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogFieldDto:
      type: object
      properties:
        name:
          type: string
          description: Field name.
          example: Custom label
      required:
      - name
      title: UpdateCatalogFieldDto
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination:
      type: object
      description: Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
      oneOf:
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelsDestination'
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiToDestination'
      title: MessageDestination
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType:
      type: string
      enum:
      - NUMERIC
      - ALPHA
      - HEX
      - ALPHANUMERIC
      title: PinType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleBlocklistEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Blocklist
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.OutboundMessageReference:
      type: object
      description: Outbound message reference, if matched by the Infobip platform.
      properties:
        bulkId:
          type: string
          description: ID of the bulk of outgoing messages.
        outboundMessageId:
          type: string
          description: ID of the paired outgoing message.
        sendAt:
          type: string
          format: date-time
          description: Date and time when the bulk or message was scheduled to be sent.
      title: OutboundMessageReference
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NetworkView:
      type: object
      description: Network data.
      properties:
        mccNnc:
          type: string
          description: Norm net code uniquely identifying the specific mobile network operator.
          example: '310260'
        networkName:
          type: string
          description: Network name.
          example: Some network
      title: NetworkView
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent:
      type: object
      description: Incoming messages
      discriminator:
        propertyName: event
        mapping:
          MO: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMoEvent'
          TYPING_STARTED: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStartedEvent'
          TYPING_STOPPED: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundTypingStoppedEvent'
      properties:
        event:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEventType'
      required:
      - event
      title: MessagesApiInboundEvent
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.VerificationResponse:
      type: object
      properties:
        verifications:
          type: array
          description: Collection of verifications
          items:
            $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.Verification'
          readOnly: true
          writeOnly: false
      title: VerificationResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookContent:
      type: object
      description: Event content.
      properties:
        aiCampaignBuilderRequestUuid:
          type: string
          format: uuid
          description: Unique identifier of the AI campaign builder request, matching the requestUuid returned when the campaign builder was started.
      title: CampaignAiBuilderWebhookContent
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageAggregate:
      type: string
      enum:
      - DAY
      - MONTH
      - APPLICATION_ID
      - ENTITY_ID
      - ACCOUNT_NAME
      - ACCOUNT_KEY
      - CATEGORY_CODE
      - CATEGORY_NAME
      - SUBCATEGORY_CODE
      - SUBCATEGORY_NAME
      - USER_NAME
      - DIRECTION
      - TRAFFIC_TYPE
      - SENDER
      - SENDER_TYPE
      - NETWORK_NAME
      - NORM_NET_CODE
      - COUNTRY_NAME
      - COUNTRY_CODE
      - COUNTRY_PREFIX
      - CAMPAIGN_ID
      - CAMPAIGN_REFERENCE
      - TEMPLATE_ID
      title: BillingUsageAggregate
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - BRAND_VET_UPDATE
          example: BRAND_VET_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform'
      title: BrandVetStatusWebhookMessage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Mobile Push
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents:
      type: string
      enum:
      - DELIVERY
      - SEEN
      - SENT
      title: Event
    17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationConfiguration:
      type: object
      properties:
        allowMultiplePinVerifications:
          type: boolean
          default: true
          description: Indicates whether multiple PIN verification is allowed.
          readOnly: false
          writeOnly: false
        pinAttempts:
          type: integer
          format: int32
          default: 10
          description: Number of possible PIN attempts.
          readOnly: false
          writeOnly: false
        pinTimeToLive:
          type: string
          default: 15m
          description: 'Validity period of PIN in specified time unit. Required format: `{timeLength}{timeUnit}`. `timeLength` is optional with a default value of 1. `timeUnit` can be set to: `ms`, `s`, `m`, `h` or `d` representing milliseconds, seconds, minutes, hours, and days respectively. Must not exceed one year, although much lower value is recommended.'
          readOnly: false
          writeOnly: false
        sendPinPerApplicationLimit:
          type: string
          default: 10000/1d
          description: 'Overall number of requests over a specified time period for generating a PIN and sending a message using a single application. Required format: `{attempts}/{timeLength}{timeUnit}`. `attempts` and `timeunit` are mandatory and `timeLength` is optional with a default value of 1. `timeUnit` is one of: `ms`, `s`, `m`, `h` or `d` representing milliseconds, seconds, minutes, hours, and days respectively. Must not exceed one year, although much lower value is recommended.'
          readOnly: false
          writeOnly: false
        sendPinPerPhoneNumberLimit:
          type: string
          default: 3/1d
          description: 'Number of requests over a specified time period for generating a PIN and sending a message to one destination. Required format: `{attempts}/{timeLength}{timeUnit}`. `attempts` and `timeunit` are mandatory and `timeLength` is optional with a default value of 1. `timeUnit` is one of: `ms`, `s`, `m`, `h` or `d` representing milliseconds, seconds, minutes, hours, and days respectively. Must not exceed one year, although much lower value is recommended.'
          readOnly: false
          writeOnly: false
        verifyPinLimit:
          type: string
          default: 1/3s
          description: 'The number of PIN verification requests over a specififed time period from one phone number (MSISDN). Required format: `{attempts}/{timeLength}{timeUnit}`. `attempts` and `timeunit` are mandatory and `timeLength` is optional with a default value of 1. `timeUnit` is one of: `ms`, `s`, `m`, `h` or `d` representing milliseconds, seconds, minutes, hours, and days respectively. Must not exceed one day, although much lower value is recommended.'
          readOnly: false
          writeOnly: false
      title: ApplicationConfiguration
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataRequest:
      type: object
      properties:
        filterBy:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataFilter'
        aggregateBy:
          type: array
          description: "\nAn array of strings that defines the properties used for data aggregation. Each item in the array represents an aggregation parameter, with a corresponding column in the response showing values for the chosen aggregate.\n`CHANNEL_CODE` is always included in results for metric accuracy, even if not specified in aggregateBy. For further details,\nrefer to our [documentation](https://www.infobip.com/docs/metrics-api/metrics-and-filters#aggregationdimensions).\n\nAvailable aggregates:\n* `ACCOUNT_KEY` - groups the results by account key, displaying account-specific values.\n* `HOUR` - groups the results by hour, showing corresponding hourly timestamp values.\n* `DAY` - groups the results by day, showing corresponding day values.\n* `WEEK_SATURDAY_START` - groups the results by week, starting on Saturday, with corresponding timestamp values.\n* `WEEK_SUNDAY_START` - groups the results by week, starting on Sunday, with corresponding timestamp values.\n* `WEEK_MONDAY_START` - groups the results by week, starting on Monday, with corresponding timestamp values.\n* `MONTH` - groups the results by month, showing monthly values.\n* `QUARTER` - groups the results by quarter, showing quarterly values.\n* `YEAR` - groups the results by year, displaying annual values.\n* `TIME_TO_DELIVER` - groups the results by message delivery time, showing time-to-deliver period descriptions.\n* `TIME_TO_ANSWER` - groups the results by call answer time, showing time-to-answer period descriptions.\n* `TIME_TO_CLICK_FROM_SEEN` - groups the results by the time (in seconds) between a message being seen and a URL being clicked, showing calculated values.\n* `TIME_TO_CLICK_FROM_DELIVERED` - groups the results by the time (in seconds) between message delivery and a URL being clicked, showing calculated values.\n* `TIME_TO_SEEN_FROM_DELIVERED` - groups the results by the time (in seconds) between message delivery and the message being seen, showing calculated values.\n* `TIME_TO_OPEN_FROM_DELIVERED` - groups the results by the time (in seconds) between message delivery and the message being opened, showing calculated values.\n* `CHANNEL_CODE` - groups the results by channel, showing corresponding channel code values.\n* `CHANNEL_NAME` - groups the results by channel name, showing corresponding channel name values.\n* `CAPABILITY` - groups the results by capability, showing corresponding capability code values.\n* `DIRECTION` - groups the results by traffic direction, showing whether it was OUTBOUND (sent to a client) or INBOUND (received from a client).\n* `TRAFFIC_TYPE` - groups the results by traffic type, showing specific traffic type values.\n* `SENDER` - groups the results by sender, showing sender-specific values.\n* `SENDER_TYPE` - groups the results by type of sender, showing sender type values.\n* `SENDER_DOMAIN` - groups the results by sender domain, showing domain-specific values.\n* `RECIPIENT_DOMAIN` - groups the results by recipient domain, showing domain-specific values.\n* `URL` - groups the results by initial URL in a message, showing URL-specific values.\n* `COMMUNICATION` - groups the results by communication ID, showing the unique ID associated with each message.\n* `CAMPAIGN_REFERENCE` - groups the results by campaign reference ID, showing associated campaign reference values.\n* `NETWORK_ID` - groups the results by network, showing network ID values.\n* `NETWORK_NAME` - groups the results by network name, showing the name associated with each network ID.\n* `COUNTRY_ID` - groups the results by country, showing country ID values.\n* `COUNTRY_NAME` - groups the results by country name, showing the name associated with each country.\n* `APPLICATION_ID` - groups the results by application, showing corresponding application ID values.\n* `ENTITY_ID` - groups the results by entity, showing corresponding entity ID values.\n* `STATUS_GROUP` - groups response results by status group, showing corresponding status group values.\n* `STATUS` - groups response results by status name, showing corresponding status values.\n* `ERROR_GROUP` - groups response results by error group, showing corresponding error group values.\n* `ERROR_CODE` - groups response results by error code, showing corresponding error code values.\n            "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TrafficAggregate'
          uniqueItems: true
        metrics:
          type: array
          description: "\nThe metrics parameter accepts an array of non-empty strings that specify the metrics to retrieve. Each column in the response will contain values corresponding to the selected metric type.\n\nFor detailed information on the metrics available through the API, including specific details, limitations, and channel applicability, please refer to our comprehensive\n[documentation](https://www.infobip.com/docs/metrics-api/metrics-and-filters) on available metrics.\n\nAvailable metrics:\n* `TOTAL_TRAFFIC_COUNT` - Total number of messages or message segments sent to and received from customers (inbound and outbound).\n* `TOTAL_ACCEPTED_TRAFFIC_COUNT` - The total number of accepted Email messages sent to your customers (outbound).\n* `TOTAL_SMS_MESSAGES_COUNT` - Total number of SMS messages sent to and received from customers (inbound and outbound). Messages split into multiple segments due to length are counted as a single distinct message.\n* `INTERACTION_COUNT` - Number of distinct messaging interactions. Combined with the `TRAFFIC_TYPE` dimension, it helps analyze specific messaging traffic by breaking down interactions into different WhatsApp or RCS categories, such as conversations or sessions.\n* `TOTAL_SENT_TRAFFIC_COUNT` - Total number of messages submitted for delivery (outbound).\n* `DELIVERED_TRAFFIC_COUNT` - Total number of messages delivered to a recipient.\n* `TRAFFIC_DELIVERY_RATE` - Percentage of messages successfully delivered to recipients. Calculated using the formula: Total delivered / (Total sent - Total rejected) for all channels except Email, where it is calculated as Total delivered / Total sent.\n* `TRAFFIC_DELIVERED_IN_5_SEC_RATE` - Percentage of messages delivered within a 5-second timeframe.\n* `TOTAL_RECEIVED_TRAFFIC_COUNT` - Total number of messages received from customers (inbound).\n* `RECEIVED_TO_SENT_TRAFFIC_RATIO` - Ratio of received (inbound) to sent (outbound) messages that were not rejected.\n* `FAILED_TRAFFIC_COUNT` - Total number of sent (outbound) messages that were not delivered to recipients.\n* `TOTAL_BOUNCE_COUNT` - Total number of emails not delivered, including soft (temporary) and hard (permanent) bounces.\n* `TOTAL_BOUNCE_RATE` - Percentage of emails that were not delivered, calculated by summing soft and hard bounces and dividing by the total sent.\n* `TOTAL_DROPPED_COUNT` - Submitted emails that were dropped before delivery due to factors such as unsubscribes, bounced addresses, spam marking, or sender errors.\n* `TOTAL_DROPPED_RATE` - Percentage of dropped emails, calculated by dividing the number of dropped emails by the accepted emails.\n* `TOTAL_SUPPRESSED_COUNT` - Number of emails not sent due to a bounce or recipient actions like spam marking.\n* `SOFT_BOUNCE_COUNT` - Number of emails temporarily undeliverable due to reasons like full inboxes, temporary domain unavailability, or lack of recipient opt-in.\n* `SOFT_BOUNCE_RATE` - Percentage of temporarily undeliverable emails, calculated by dividing soft bounces by total sent.\n* `HARD_BOUNCE_COUNT` - Number of emails permanently undeliverable to specific recipients.\n* `HARD_BOUNCE_RATE` - Percentage of permanently undeliverable emails, calculated by dividing hard bounces by total sent.\n* `SEEN_OPENED_TRAFFIC_COUNT` - Total number of messages seen or opened. Recipients can turn off their read receipts, resulting in a lower seen count.\n* `SEEN_OPENED_TRAFFIC_RATE` - Percentage of messages seen or opened by unique recipients. Recipients can turn off their read receipts, resulting in a lower seen rate.\n* `VIEWED_TOTAL_COUNT` - Number of email opens per recipient, including multiple opens by the same user.\n* `VIEWED_TOTAL_RATE` - Percentage of recipients who opened an email campaign.\n* `UNIQUE_CLICKS_COUNT` - Number of unique recipients who clicked any link in a message, counted only once per recipient regardless of multiple clicks.\n* `UNIQUE_CLICK_THROUGH_RATE` - Percentage of unique recipients who clicked a link compared to total messages delivered, counting each recipient only once.\n* `UNIQUE_URL_CLICK_COUNT` - Number of unique URLs clicked in a single message.\n* `CLICK_TO_OPEN_RATE` - Percentage of unique clicks divided by unique opens or views, counting each recipient only once.\n* `TOTAL_CLICKS_COUNT` - Total clicks on all URLs in a message, including multiple clicks on the same link. For example, if a message contains 3 links and each is clicked twice, the total clicks count is 6.\n* `TOTAL_CLICK_RATE` - Percentage of recipients who clicked any link, calculated as the total clicks across all URLs divided by the total delivered messages. For example, if 200 SMS messages are sent and there are 400 total clicks, the `TOTAL_CLICK_RATE` is 200%.\n* `UNSUBSCRIBED_USER_COUNT` - Number of recipients who unsubscribed (opted out) from further communications from the sender.\n* `UNSUBSCRIBED_USER_RATE` - Percentage of recipients who unsubscribed (opted out) from further communications from the sender.\n* `EMAIL_COMPLAINTS_COUNT` - Number of emails reported as spam by recipients.\n* `EMAIL_COMPLAINTS_RATE` - Percentage of emails reported as spam by recipients.\n* `TOTAL_CALL_COUNT` - Total number of calls sent to your customers (outbound) and calls received from your customers (inbound).\n* `TOTAL_ATTEMPTED_CALL_COUNT` - Total number of calls initiated for delivery (outbound).\n* `TOTAL_SEIZED_CALL_COUNT` - Total number of calls that have successfully reached the recipient's device and started ringing, regardless of whether they were ultimately answered or not.\n* `TOTAL_ANSWERED_CALL_COUNT` - Total number of calls that were successfully answered, including both inbound calls (initiated by the customer) and outbound calls (initiated by the business).\n* `TOTAL_RECEIVED_CALL_COUNT` - Total number of calls you received from customers (inbound).\n* `AMD_PROCESSED_CALL_COUNT` - The number of calls that used Automated machine detection.\n* `ANSWERED_BY_PERSON_CALL_COUNT` - Number of calls initiated by the business that were successfully answered by a person (human).\n* `ANSWERED_BY_VOICE_DETECTION_CALL_COUNT` - Number of calls initiated by the business that were successfully answered by a voice detection system (e.g., voicemail, automated system).\n* `NOT_ANSWERED_CALL_COUNT` - Total number of outbound calls that were not answered by the recipient.\n* `BUSY_CALL_COUNT` - Total number of outbound calls that received a busy signal or were rejected due to the recipient's line being busy.\n* `CANCELED_CALL_COUNT` - Total number of outbound calls that were canceled at the origination end before they could have been successfully routed to the end user.\n* `FAILED_CALL_COUNT` - Total number of calls that were not successfully delivered for various reasons, including being declined or rejected by the user, rejected by the operator, or due to the end user's unavailability to receive the call at the time of the attempt.\n* `ANSWER_SEIZURE_RATIO` - The percentage of successfully answered calls out of the total number of call attempts that resulted in a seizure (i.e., a call attempt that resulted in a ring-back tone).\n* `ANSWER_RATE` - The percentage of calls that are successfully answered by the called party out of the total number of calls that were attempted.\n* `BUSY_RATE` - The percentage of calls that receive a busy signal out of the total number of attempted calls.\n* `HUNG_UP_COUNT` - The total number of call or session terminations, including those initiated by users after successful interactions and those caused by system errors.\n* `NORMAL_HUNG_UP_COUNT` - The number of regular call or session terminations initiated by users after successful interactions.\n* `ERROR_HUNG_UP_COUNT` - The number of call or session terminations caused by encountered errors within the system.\n* `TOTAL_CALL_DURATION` - The cumulative duration of all calls made to and received from customers (inbound and outbound).\n\nFor more detailed information and examples, please visit:\n- [Metrics and Filters](https://www.infobip.com/docs/metrics-api/metrics-and-filters#metrics)\n- [Constraints](https://www.infobip.com/docs/metrics-api/querying-data#constraints)\n- [Examples](https://www.infobip.com/docs/metrics-api/examples)\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.MetricType'
          minItems: 1
          uniqueItems: true
      required:
      - aggregateBy
      - filterBy
      - metrics
      title: AggregateDataRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBodyType:
      type: string
      enum:
      - TEXT
      - CAROUSEL
      title: MessagesApiTemplateBodyType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest'
      - type: object
        properties:
          optInMessage:
            type: string
            description: The message sent to the user after they have subscribed.
          helpMessage:
            type: string
            description: The message sent to a user after they have asked for help.
          optOutMessage:
            type: string
            description: The message sent to a user after they have asked to stop receiving messages.
          ctaWebsite:
            type: string
            description: CTA website URL
          ctas:
            type: array
            description: List of call-to-action texts
            items:
              type: string
              description: List of call-to-action texts
          useCases:
            type: array
            description: The use cases for this campaign.
            items:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase'
          ageGated:
            type: boolean
            description: Whether the campaign is age-gated (18+)
          directLending:
            type: boolean
            description: Whether the campaign involves direct lending
          messageFlow:
            type: string
            description: Message flow description
      description: Request to submit 10DLC campaign info for AI compliance review with full details
      required:
      - ageGated
      - brandName
      - brandSupportEmail
      - brandWebsite
      - ctaWebsite
      - ctas
      - customerCareEmail
      - directLending
      - helpMessage
      - messageExamples
      - messageFlow
      - optInMessage
      - optOutMessage
      - programDescription
      - reviewType
      - useCases
      title: TenDlcAiReviewRequest
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadata:
      type: object
      description: Additional billing data metadata included in the response.
      properties:
        clientRequestedPeriod:
          allOf:
          - $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.clientRequestedPeriod'
          description: Originally requested time period referenced in the response.
        billingPeriods:
          type: array
          description: Metadata for each covered calendar month.
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadataPeriod'
      required:
      - billingPeriods
      - clientRequestedPeriod
      title: BillingUsageMetadata
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryDay:
      type: string
      description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DeliveryDay
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Entity:
      type: object
      properties:
        entityName:
          type: string
          description: Descriptive name of the resource.
          example: Test name
          maxLength: 255
        entityId:
          type: string
          description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
          example: test-entity
          maxLength: 255
      required:
      - entityId
      title: Entity
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: MMS
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.GetApiKeysResponse:
      type: object
      properties:
        apiKeys:
          type: array
          description: List of API keys.
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey'
        paging:
          $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.PagingResponse'
      required:
      - paging
      title: GetApiKeysResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview:
      type: object
      properties:
        numberKey:
          type: string
          description: Unique ID of the number.
        number:
          type: string
          description: Number.
        countryCode:
          type: string
          description: Number's country code.
      title: NumberPreview
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelsDestination:
      type: object
      description: Represents a destination which can be specified by a `channel`. **It is required for a message failover**.
      properties:
        messageId:
          type: string
          description: The ID that uniquely identifies the message sent. If failover is defined, then it will override values provided in `byChannel` array and be applied to each message in failover flow.
          maxLength: 200
          minLength: 0
        byChannel:
          type: array
          description: An array of substitute destinations, each associated with a specific `channel`. Only one substitute destination is allowed per `channel`. A substitute destination must be provided for the main `channel` defined in the `message`.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiChannelDestination'
      required:
      - byChannel
      title: Channels Destination
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider:
      type: string
      description: Provider for imported brand vet.
      enum:
      - AEGIS_MOBILE
      - CAMPAIGN_VERIFY
      - WMC_GLOBAL
      title: VettingProvider
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationResponse:
      type: object
      properties:
        callStatus:
          type: string
          description: Call status, e.g. `PENDING_ACCEPTED`.
          readOnly: false
          writeOnly: false
        externalMessageId:
          type: string
          description: Message ID used for delivery tracking.
          readOnly: false
          writeOnly: false
        ncStatus:
          type: string
          description: 'Status of sent [Number Lookup](https://www.infobip.com/docs/number-lookup). Number Lookup status can have one of the following values: `NC_DESTINATION_UNKNOWN`, `NC_DESTINATION_REACHABLE`, `NC_DESTINATION_NOT_REACHABLE`, `NC_NOT_CONFIGURED`. Contact your Account Manager, if you get the `NC_NOT_CONFIGURED` status. SMS will not be sent only if Number Lookup status is `NC_NOT_REACHABLE`.'
          readOnly: false
          writeOnly: false
        pinId:
          type: string
          description: Sent PIN code ID.
          readOnly: false
          writeOnly: false
        smsStatus:
          type: string
          description: 'Sent SMS status. Can have one of the following values: `MESSAGE_SENT`, `MESSAGE_NOT_SENT`.'
          readOnly: false
          writeOnly: false
        to:
          type: string
          description: 'Phone number to which the 2FA message will be sent. Example: `41793026727`.'
          readOnly: false
          writeOnly: false
      title: StartAuthenticationResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes:
      type: string
      description: Campaign attributes that indicate special content characteristics
      enum:
      - AGE_GATED
      - DIRECT_LENDING
      title: CampaignBuilderCampaignAttributes
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReasonPayload:
      type: object
      description: The rejection reasons details. This field is present only when new campaign registration status is 'REJECTED'.
      properties:
        errorCode:
          type: string
          description: Predefined code.
          example: '1001'
        description:
          type: string
          description: Rejection reason.
          example: Campaign appears to be for an age gated content type but age gate attribute is not selected.
      title: RejectionReasonPayload
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback:
      type: object
      description: Offers additional information regarding the campaign, includes rejection reason and time.
      properties:
        rejectionReasons:
          type: array
          description: The reasons for the rejection.
          items:
            type: string
            description: The reasons for the rejection.
        rejectionDetails:
          type: array
          description: Rejection reasons details.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReason'
        rejectionDate:
          type: string
          format: date-time
          description: The time of the rejection.
      readOnly: true
      title: CampaignFeedback
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceInfo:
      type: object
      description: Resource basic info.
      oneOf:
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceInfo'
      title: IbResourceInfo
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SendingSpeedLimit:
      type: object
      description: Limits the send speed when sending messages in bulk to deliver messages over a longer period of time. You may wish to use this to allow your systems or agents to handle large amounts of incoming traffic, e.g., if you are expecting recipients to follow through with a call-to-action option from a message you sent. Not setting a send speed limit can overwhelm your resources with incoming traffic.
      properties:
        amount:
          type: integer
          format: int32
          description: The number of messages to be sent per timeUnit. By default, the system sends messages as fast as the infrastructure allows. Use this parameter to adapt sending capacity to your needs. The system is only able to work against its maximum capacity for ambitious message batches.
        timeUnit:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SpeedLimitTimeUnit'
      required:
      - amount
      title: SendingSpeedLimit
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessage:
      type: object
      description: Represents a single message.
      properties:
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel'
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination'
        content:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent'
        options:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions'
        webhooks:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks'
        failover:
          type: array
          description: Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover'
      required:
      - channel
      - content
      - destinations
      title: Messages API message
    e35a706fc99c4749296ef942f9e5af764730e23804a8d85886e3d0a3e3fc2340.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SeenStatusReporting:
      type: object
      description: Provides options for configuring the seen report behavior.
      properties:
        url:
          type: string
          description: The URL on your call back server where a seen report will be sent.
      title: SeenStatusReporting
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDataType:
      type: string
      description: 'Field data type. Note: Once created, you cannot change the data type.'
      enum:
      - TEXT
      - INTEGER
      - DECIMAL
      - DATE
      - TIME
      - DATE_TIME
      - BOOLEAN
      title: CatalogFieldDataType
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEventType:
      type: string
      description: Event type.
      enum:
      - MO
      - TYPING_STARTED
      - TYPING_STOPPED
      title: MessagesApiInboundEventType
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction:
      type: object
      description: Forward action configuration.
      discriminator:
        propertyName: type
        mapping:
          HTTP_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardAction'
          MAIL_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardAction'
          SMPP_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardAction'
          PULL: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullAction'
          FORWARD_TO_EXTERNAL_INTEGRATION: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToExternalIntegrationAction'
          NO_ACTION: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NoAction'
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType'
        description:
          type: string
          description: Additional action description.
          example: My description.
      title: MoAction
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Mobile Identity
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareEvent:
      type: object
      properties:
        format:
          type: string
        event:
          type: string
      required:
      - event
      - format
      title: Event with format
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status:
      type: string
      description: Current bulk status.
      enum:
      - PENDING
      - PAUSED
      - PROCESSING
      - CANCELED
      - FINISHED
      - FAILED
      example: PENDING
      title: Status
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataFilter:
      type: object
      description: "\nA JSON object specifying the criteria to filter the results. Each field in the object represents a different filter\ncriterion, enabling detailed and complex filtering.\n        "
      properties:
        accountKeys:
          type: array
          description: "\nSpecifies a list of unique account keys (identifiers).\n\nIf not provided, the metrics data for the requester's account will be used by default.\n\nExample:\n\n```\n\"accountKeys\": [\"account_key_1\", \"account_key_2\"]\n```\n\nTo retrieve all available account keys, refer to the\n[Account list endpoint](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).\n        "
          items:
            type: string
            description: "\nSpecifies a list of unique account keys (identifiers).\n\nIf not provided, the metrics data for the requester's account will be used by default.\n\nExample:\n\n```\n\"accountKeys\": [\"account_key_1\", \"account_key_2\"]\n```\n\nTo retrieve all available account keys, refer to the\n[Account list endpoint](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).\n        "
          uniqueItems: true
        includeSubaccounts:
          type: boolean
          default: false
          description: "\nDetermines whether to include traffic data from sub-accounts (children accounts) along with the specified accounts in\n `accountKeys`.\n\nIf set to true, the traffic data for the specified accounts and their sub-accounts is aggregated.\n\nIf set to false, only the traffic data for the specified accounts in `accountKeys` is considered.\n\nThis parameter is optional. If not provided, it defaults to false.\n\nExample:\n\n```\n\"includeSubaccounts\": true\n```\n        "
          example: true
        sentSince:
          type: string
          format: date-time
          description: "\nThe start date-time for filtering sent traffic (inclusive).\n\nHas the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.\n        "
        sentUntil:
          type: string
          format: date-time
          description: "\nThe end date-time for filtering sent traffic (exclusive).\n\nHas the following format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`.\n        "
        timeToDeliver:
          type: array
          description: "\nRepresents the time within which a message is delivered using time buckets.\n\nFor example, you can filter only for messages delivered within a second. The `from` bucket is inclusive, while the `to` bucket is exclusive.\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        timeToAnswer:
          type: array
          description: "\nRepresents the time it took for the call to be answered using time buckets.\n\nFor example, you can filter only for calls answered within a second. The `from` bucket is inclusive, while the `to` bucket is exclusive.\n    "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        timeToClickFromSeen:
          type: array
          description: "\nRepresents the time within which a URL is clicked after the message is seen using time buckets.\n\nFor example, you can filter only messages whose URLs were clicked within 1 second after they were seen. The `from`\nbucket is inclusive, while the `to` bucket is exclusive.\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        timeToClickFromDelivered:
          type: array
          description: "\nRepresents the time within which a URL is clicked after the message is delivered using time buckets.\n\nFor example, you can filter only for messages whose URLs were clicked within 1 second after delivery. The `from` bucket\n is inclusive, while the `to` bucket is exclusive.\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        timeToSeenFromDelivered:
          type: array
          description: "\nRepresents the time within which a message is seen after the message is delivered using time buckets.\n\nFor example, you can filter only for messages seen within 1 second after they were delivered. The `from` bucket is\ninclusive, while the `to` bucket is exclusive.\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        timeToOpenFromDelivered:
          type: array
          description: "\nRepresents the time within which a message is opened after the message is delivered using time buckets.\n\nFor example, you can filter only for messages opened within 1 second after they were delivered. The `from` bucket is inclusive, while the `to` bucket is exclusive.\n    "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeSpan'
          uniqueItems: true
        channelCodes:
          type: array
          description: '

            Specifies communication channels and/or services. This is a list of available channels/services and their codes:


            * `SMS` - SMS

            * `EMAIL` - Email

            * `FACEBOOK` - Facebook Messenger

            * `INSTAGRAM` - Instagram Messaging

            * `KAKAO` - Kakao

            * `LINE` - Line

            * `MMS` - MMS

            * `RCS` - RCS

            * `TELEGRAM` - Telegram

            * `VIBER` - Viber

            * `VOICE_VIDEO` - Voice and Video

            * `WHATSAPP` - WhatsApp

            * `ZALO` - Zalo

            * `APPLE_MB` - Apple Messages for Business

            '
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ChannelCode'
          minLength: 1
          uniqueItems: true
        capabilities:
          type: array
          description: "\nSpecifies the function, technology, or flavor within the selected channelCodes, making it easier to identify similar\nservices across channels or services.\n\nAvailable capabilities and their codes:\n\n* `PHONE` – Phone\n* `WEBRTC` – WebRTC\n* `SIPTRUNK` – SIP Trunks\n* `VIBER_BC` – Viber Business Calls\n* `WHATSAPP_BC` – WhatsApp Business Calls\n* `LINE_OA` – LINE Official Account\n* `LINE_ON` – LINE Official Notifications\n* `KAKAO_A` – Kakao Alim\n* `KAKAO_B` – Kakao Brand Message\n* `KAKAO_S` – Kakao Sangdam\n* `ZALO_NS` – Zalo Notification Services\n* `ZALO_F` – Zalo Follower\n* `VIBER_BM` – Viber Business Messages\n* `VIBER_BOTS` – Viber Bots\n* `MESSENGER` – Messenger\n* `INSTAGRAM_DM` – Instagram Direct Messaging\n    "
          items:
            type: string
            description: "\nSpecifies the function, technology, or flavor within the selected channelCodes, making it easier to identify similar\nservices across channels or services.\n\nAvailable capabilities and their codes:\n\n* `PHONE` – Phone\n* `WEBRTC` – WebRTC\n* `SIPTRUNK` – SIP Trunks\n* `VIBER_BC` – Viber Business Calls\n* `WHATSAPP_BC` – WhatsApp Business Calls\n* `LINE_OA` – LINE Official Account\n* `LINE_ON` – LINE Official Notifications\n* `KAKAO_A` – Kakao Alim\n* `KAKAO_B` – Kakao Brand Message\n* `KAKAO_S` – Kakao Sangdam\n* `ZALO_NS` – Zalo Notification Services\n* `ZALO_F` – Zalo Follower\n* `VIBER_BM` – Viber Business Messages\n* `VIBER_BOTS` – Viber Bots\n* `MESSENGER` – Messenger\n* `INSTAGRAM_DM` – Instagram Direct Messaging\n    "
          uniqueItems: true
        directions:
          type: array
          description: "\nSpecifies the direction of traffic, indicating whether the message was sent to the user (OUTBOUND) or received from the user (INBOUND).\n    "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Direction'
          uniqueItems: true
        trafficTypes:
          type: array
          description: "\nSpecifies the types of traffic. For a full list of values, refer to\n[traffic types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#traffictypes).\n        "
          items:
            type: string
            description: "\nSpecifies the types of traffic. For a full list of values, refer to\n[traffic types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#traffictypes).\n        "
          uniqueItems: true
        senders:
          type: array
          description: "\nSpecifies the sender IDs, which can be alphanumeric or numeric.\n\nExample:\n\n```\n\"senders\": [\"mySender\", \"12345\", \"15551234567\", \"jane.smith@somecompany.com\"]\n```\n        "
          items:
            type: string
            description: "\nSpecifies the sender IDs, which can be alphanumeric or numeric.\n\nExample:\n\n```\n\"senders\": [\"mySender\", \"12345\", \"15551234567\", \"jane.smith@somecompany.com\"]\n```\n        "
          uniqueItems: true
        senderTypes:
          type: array
          description: "\nSpecifies the types of senders. For a full list of values, refer to\n[sender types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#sendertypes).\n\nExample:\n\n```\n\"senderTypes\": [\"ALPHANUMERIC\", \"SHORT_CODE\", \"VIRTUAL_LONG_NUMBER\", \"DOMAIN\"]\n```\n        "
          items:
            type: string
            description: "\nSpecifies the types of senders. For a full list of values, refer to\n[sender types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#sendertypes).\n\nExample:\n\n```\n\"senderTypes\": [\"ALPHANUMERIC\", \"SHORT_CODE\", \"VIRTUAL_LONG_NUMBER\", \"DOMAIN\"]\n```\n        "
          uniqueItems: true
        communicationIds:
          type: array
          description: "\nSpecifies the list of communication IDs associated with either a Broadcast or a Moments/Flow campaign.\n\nUse communication IDs to filter data related to specific campaigns.\n\nFor detailed information on the differences between Broadcast and Flow campaigns, refer to the\n[Broadcast](https://www.infobip.com/docs/broadcast) and [Flow overview](https://www.infobip.com/docs/moments).\n\nExample:\n\n```\n\"communicationIds\": [12354646546, 45534466546, 754564654689]\n```\n        "
          items:
            type: integer
            format: int64
            description: "\nSpecifies the list of communication IDs associated with either a Broadcast or a Moments/Flow campaign.\n\nUse communication IDs to filter data related to specific campaigns.\n\nFor detailed information on the differences between Broadcast and Flow campaigns, refer to the\n[Broadcast](https://www.infobip.com/docs/broadcast) and [Flow overview](https://www.infobip.com/docs/moments).\n\nExample:\n\n```\n\"communicationIds\": [12354646546, 45534466546, 754564654689]\n```\n        "
          uniqueItems: true
        campaignReferenceIds:
          type: array
          description: "\nSpecifies the list of campaign reference IDs used for traffic sent over Infobip APIs.\n\nUse `campaignReferenceIDs` to filter data related to specific campaigns.\n        "
          items:
            type: string
            description: "\nSpecifies the list of campaign reference IDs used for traffic sent over Infobip APIs.\n\nUse `campaignReferenceIDs` to filter data related to specific campaigns.\n        "
          uniqueItems: true
        networkIds:
          type: array
          description: "\nList of network IDs.\n        "
          items:
            type: integer
            format: int32
            description: "\nList of network IDs.\n        "
          uniqueItems: true
        countryIds:
          type: array
          description: "\nList of country IDs.\n    "
          items:
            type: integer
            format: int32
            description: "\nList of country IDs.\n    "
          uniqueItems: true
        platforms:
          type: array
          description: "\nSpecifies the platform object, which is a combination of an applicationId and entityId. These IDs uniquely identify each application and entity configured on the Infobip platform.\n\nUse this object and its related parameters to filter data for a specific application and entity combination. Note that these parameters should only be used if you leverage CPaaS X applications and entities to manage your traffic.\n\nFor detailed information on applications and entities in the CPaaS X ecosystem, refer to the\n[CPaaSX overview](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Platform'
          uniqueItems: true
        applicationId:
          type: string
          deprecated: true
          description: "\nA unique identifier assigned to an application, use case, or environment within the Infobip CPaaS X ecosystem.\n\nUse this parameter to filter data for a specific application.\n\nTo retrieve all available application IDs, refer to the\n[Application list endpoint](https://www.infobip.com/docs/api/platform/application-entity/get-applications).\n\nExample:\n\n```\n\"applicationId\": \"your_application_id\"\n```\n        "
        entityId:
          type: string
          deprecated: true
          description: "\nA unique identifier assigned to an entity, such as a brand, customer, or other defined component, within the Infobip CPaaS X ecosystem.\n\nUse this parameter to filter data for a specific entity.\n\nTo retrieve all available entity IDs, refer to the\n[Entity list endpoint](https://www.infobip.com/docs/api/platform/application-entity/get-entities).\n\nExample:\n\n```\n\"entityId\": \"your_entity_id\"\n```\n        "
        statusGroups:
          type: array
          description: "\nSpecifies the general status code groups.\n\nFor the list of possible values, refer to\n[general status codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.GeneralStatus'
          uniqueItems: true
        statuses:
          type: array
          description: "\nSpecifies the message status reason.\n\nFor the list of possible values, refer to\n[message status reasons](https://www.infobip.com/docs/essentials/response-status-and-error-codes).\n        "
          items:
            type: string
            description: "\nSpecifies the message status reason.\n\nFor the list of possible values, refer to\n[message status reasons](https://www.infobip.com/docs/essentials/response-status-and-error-codes).\n        "
          uniqueItems: true
        errorGroups:
          type: array
          description: "\nSpecifies the general error code groups.\n\nFor the list of possible values, refer to\n[error codes groups](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ErrorCodeGroup'
          uniqueItems: true
        errorCodes:
          type: array
          description: "\nSpecifies the error codes.\n\nFor the list of possible values, refer to\n[error codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
          items:
            type: string
            description: "\nSpecifies the error codes.\n\nFor the list of possible values, refer to\n[error codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
          uniqueItems: true
      required:
      - channelCodes
      - sentSince
      - sentUntil
      title: AggregateDataFilter
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareBlocklistEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - BLOCK
          - UNBLOCK
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.UrlOptions:
      type: object
      description: 'Sets up [URL shortening](https://www.infobip.com/docs/url-shortening) and tracking feature. Does not apply to channels that do not support it: Instagram, LINE, Messenger, Viber Bot.'
      properties:
        shortenUrl:
          type: boolean
          default: true
          description: Enable shortening of the URLs within a message. Set this to `true`, if you want to set up other URL options.
        trackClicks:
          type: boolean
          default: true
          description: 'Enable tracking of short URL clicks within a message: which URL was clicked, how many times, and by whom.'
        trackingUrl:
          type: string
          description: The URL of your callback server on to which the Click report will be sent.
        removeProtocol:
          type: boolean
          default: false
          description: Remove a protocol, such as `https://`, from links to shorten a message. Note that some mobiles may not recognize such links as a URL.
        customDomain:
          type: string
          description: Select a predefined custom domain to use when generating a short URL.
      title: UrlOptions
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook:
      type: object
      description: Webhook configuration.
      properties:
        contentType:
          type: string
          maxLength: 255
          minLength: 0
        notifyUrl:
          type: string
          description: Your webhook URL, where the notifications will be sent to.
          maxLength: 512
          minLength: 0
      required:
      - notifyUrl
      title: Webhook
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileResponse:
      type: object
      description: Notification profile.
      properties:
        profileId:
          type: string
          description: Unique profile ID.
        security:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse'
      title: Profile
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookContent:
      type: object
      description: Event content.
      properties:
        brandId:
          type: string
          format: uuid
          description: The ID of the brand.
          example: 0579c038-55f2-11ee-9458-325096b39f47
        brandStatus:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandRegistrationStatus'
        rejectionReasons:
          type: array
          description: The rejection reasons. This field is present only when brand registration status is 'FAILURE'.
          example:
          - Tax id does not match with the company name or business type.
          items:
            type: string
            description: The rejection reasons. This field is present only when brand registration status is 'FAILURE'.
            example: '["Tax id does not match with the company name or business type."]'
      title: BrandRegistrationWebhookContent
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Channel:
      type: string
      enum:
      - APPLE_MB
      - INSTAGRAM_DM
      - LINE_ON
      - MESSENGER
      - MMS
      - RCS
      - SMS
      - VIBER_BM
      - VIBER_BOT
      - WHATSAPP
      title: Channel
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Platform:
      type: object
      description: "\nSpecifies the platform object, which is a combination of an applicationId and entityId. These IDs uniquely identify each application and entity configured on the Infobip platform.\n\nUse this object and its related parameters to filter data for a specific application and entity combination. Note that these parameters should only be used if you leverage CPaaS X applications and entities to manage your traffic.\n\nFor detailed information on applications and entities in the CPaaS X ecosystem, refer to the\n[CPaaSX overview](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).\n        "
      properties:
        applicationId:
          type: string
          description: "\nA unique identifier assigned to an application, use case, or environment within the Infobip CPaaS X ecosystem.\n\nUse this parameter to filter data for a specific application.\n\nTo retrieve all available application IDs, refer to the\n[Application list endpoint](https://www.infobip.com/docs/api/platform/application-entity/get-applications).\n            "
          example: your_application_id
        entityId:
          type: string
          description: "\nA unique identifier assigned to an entity, such as a brand, customer, or other defined component, within the Infobip CPaaS X ecosystem.\n\nUse this parameter to filter data for a specific entity.\n\nTo retrieve all available entity IDs, refer to the\n[Entity list endpoint](https://www.infobip.com/docs/api/platform/application-entity/get-entities).\n        "
          example: your_entity_id
      title: Platform
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - CLICK
          - DELIVERY
          - INBOUND_MESSAGE
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberRequirementSpecsRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - NUMBER_PURCHASE
        quantity:
          type: integer
          format: int32
          description: Amount of numbers. Default value is 1.
          maximum: 49
          minimum: 1
        numberType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType'
        capabilities:
          type: array
          description: Capabilities of the numbers.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability'
        clientType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType'
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
      required:
      - capabilities
      - countryCode
      - numberType
      - type
      title: NUMBER_PURCHASE
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreate:
      type: object
      description: Blocklist.
      properties:
        destinations:
          type: array
          description: Destination addresses that need to be blocklisted.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToCreate'
        sender:
          type: string
          description: The sender ID for which blocklist happened.
          maxLength: 255
          minLength: 1
        channel:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CreatableChannel'
        accountKey:
          type: string
          description: Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. [API to retrieve account key](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).
      required:
      - destinations
      title: BlocklistCreate
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandRegistrationStatus:
      type: string
      description: The new brand registration status.
      enum:
      - SUCCESS
      - FAILURE
      - PENDING
      - PENDING_2FA
      example: FAILURE
      title: WebhookBrandRegistrationStatus
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDeleteRequest:
      type: object
      description: Blocklist request.
      properties:
        blocklist:
          type: array
          description: Blocklist elements that need to be removed from blocklist. Number of destinations cannot exceed 50 000.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDelete'
      required:
      - blocklist
      title: BlocklistDeleteRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiFailover:
      type: object
      description: Configuration of a single failover step
      properties:
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel'
        sender:
          type: string
          description: Sender for channel specified above.
        content:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContent'
        validityPeriod:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod'
      required:
      - channel
      title: Message failover
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.InboundMessageReference:
      type: object
      description: Inbound message reference, if matched by the Infobip platform.
      properties:
        inboundMessageId:
          type: string
          description: ID of the message that triggered the event if matched by the Infobip platform. For example, MO message ID.
      title: InboundMessageReference
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageSenderDisplayInfo:
      type: object
      description: Sender display info (name and avatar). Used only for Viber Bot messages.
      properties:
        name:
          type: string
          description: The sender's name to display.
          maxLength: 28
          minLength: 0
        avatarUrl:
          type: string
          description: The sender's avatar URL.
      title: MessagesApiMessageSenderDisplayInfo
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeaderType:
      type: string
      enum:
      - TEXT
      title: MessagesApiMessageHeaderType
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceInfo:
      type: object
      description: Information about alphanumeric type of resource.
      properties:
        senderName:
          type: string
          description: Alphanumeric sender name.
          example: MySender
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          description: Capabilities of the sender.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Alphanumeric
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseCampaign:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign'
        paging:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo'
      title: PageResponseCampaign
    6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.ErrorResponse:
      type: object
      description: Error response object.
      properties:
        errorDetails:
          type: string
          description: Details of the error, if the request fails.
      title: ErrorResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations:
      type: object
      description: Used for forwarding messages to Conversations service.
      externalDocs:
        description: Find out more about Conversations
        url: https://www.infobip.com/docs/conversations
      properties:
        enabled:
          type: boolean
          description: Flag which indicates if this action should be enabled. If set to false, the effect will be the same as adding the conversations to unset which will remove the object.
          example: true
      required:
      - enabled
      title: UseConversations
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.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
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData'
      - type: object
        properties:
          useCase:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeUseCase'
          messageFlow:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultMessageFlow'
          channelNote:
            type: string
            description: Channel-specific note.
          termsConditions:
            type: string
            writeOnly: true
          privacyPolicy:
            type: string
            writeOnly: true
      description: Campaign builder result for Toll Free Number campaigns.
      title: TollFreeCampaignBuilderResultData
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewResults:
      type: object
      properties:
        reviewStatus:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewStatus'
        campaignErrors:
          type: array
          description: List of compliance errors found during the AI campaign review. Empty when the review is still processing or the campaign is compliant.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewError'
      title: ExternalAutomaticReviewResults
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationStatusPublic:
      type: string
      description: The state of the registration for this brand.
      enum:
      - ACTIVE
      - PENDING
      - PENDING_2FA
      - PENDING_APPEAL
      - REJECTED
      example: REJECTED
      title: BrandRegistrationStatusPublic
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartAuthenticationRequest:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service, e.g. 2FA for login, 2FA for changing the password, etc.
          readOnly: false
          writeOnly: true
        from:
          type: string
          description: Use this parameter if you wish to override the sender ID from the [created](#channels/sms/create-2fa-message-template) message template parameter `senderId`.
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
          readOnly: false
          writeOnly: true
        placeholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"placeholders":{"firstName":"John"}`'
          readOnly: false
          writeOnly: true
        to:
          type: string
          description: 'Phone number to which the 2FA message will be sent. Example: 41793026727.'
          readOnly: false
          writeOnly: true
        trackDelivery:
          type: boolean
          default: false
          description: 'Enables sending of delivery reports via [Subscriptions](https://www.infobip.com/docs/cpaas-x/subscriptions-management). 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)`.'
          readOnly: false
          writeOnly: true
      required:
      - applicationId
      - messageId
      - to
      title: StartAuthenticationRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod:
      type: string
      description: Method used to obtain consumer opt-in consent for messaging
      enum:
      - VERBAL
      - ONLINE
      - KEYWORD
      - IVR
      title: CampaignBuilderOptInMethod
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderIdentifier:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the resource request.
      title: ResourceOrderIdentifier
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SenderType:
      type: string
      description: Sender type.
      enum:
      - ALPHANUMERIC
      - VIRTUAL_LONG_NUMBER
      - SHORT_CODE
      - TOLL_FREE_NUMBER
      example: ALPHANUMERIC
      title: SenderType
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.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
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks:
      type: object
      description: Provides options for configuring message webhooks.
      properties:
        delivery:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDelivery'
        contentType:
          type: string
          description: Preferred delivery report content type, `application/json` or `application/xml`.
        callbackData:
          type: string
          description: Additional data that can be used for identifying, managing, or monitoring a message. Data included here will also be automatically included in the message Delivery Report and Seen Report. The maximum value is 4000 characters.
          maxLength: 4000
          minLength: 0
        seen:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SeenStatusReporting'
      title: MessagesApiWebhooks
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiBuilderWebhookMessage'
      title: CampaignAiBuilderWebhookResponse
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.DocumentIdentifier:
      type: object
      properties:
        documentId:
          type: string
          description: The ID of the document.
      title: DocumentIdentifier
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents:
      type: string
      enum:
      - DELIVERY
      title: Event
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the resource.
        type:
          type: string
          description: Type of resource.
          enum:
          - ALPHANUMERIC_REGISTRATION
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        senderName:
          type: string
          description: Sender name.
        requestedByEmailAddress:
          type: string
          description: Email address of the requester.
        additionalContactEmailAddresses:
          type: array
          description: Additional email addresses.
          items:
            type: string
            description: Additional email addresses.
        requestedDate:
          type: string
          format: date-time
          description: Date and time the resource was requested.
        status:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus'
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
        trafficType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType'
        note:
          type: string
          description: A note containing extra data about the request.
        requirementsFeedback:
          type: array
          description: List of feedback for requirements.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback'
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      title: ALPHANUMERIC_REGISTRATION
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogFieldDto:
      type: object
      properties:
        id:
          type: string
          description: Field ID.
          example: caad56e4-2a1c-4ae8-9717-ebb40d05533d
        dataType:
          $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogFieldDataType'
        name:
          type: string
          description: Field name.
          example: Custom name
      required:
      - dataType
      - name
      title: CreateCatalogFieldDto
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents:
      type: string
      enum:
      - CLICK
      - CONSENT_UPDATE
      - DELIVERY
      - INBOUND_MESSAGE
      - SEEN
      title: Event
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform:
      type: object
      description: A collection of CPaaS X Applications and Entities that will be linked to the API key. All Applications and Entities will be removed from the api key if an empty platform list is sent and 'PUBLIC_API' will be assigned as default permission. Or, to remove a specific Application/Entity pair, omit it from the platform list.
      externalDocs:
        description: 'WARNING: linking an existing API Key to an Application and/or Entity will limit access to these endpoints.'
        url: https://www.infobip.com/docs/cpaas-x/application-and-entity-management#api-keys-endpoints-list-api-keys-with-application-and-entity
      properties:
        key:
          type: string
          description: Unique identifier of application and/or entity association.
          readOnly: true
        applicationId:
          type: string
          description: ID of a CPaaS X Application. Once linked to an Application, the API key can only be used to send messages using linked Applications. Mandatory for every Application and/or Entity pair. Use the default value to reference a default Application. Use an existing Application created using [create-application endpoint](https://www.infobip.com/docs/api/platform/application-entity/create-application) or specify a new applicationId to create a new Application.
        entityId:
          type: string
          description: ID of a CPaaS X Entity. Once linked to an Entity, the API key can only be used to send messages using linked Entities. Use an existing Entity created using [create-entity endpoint](https://www.infobip.com/docs/api/platform/application-entity/create-entity) or specify a new entityId to create a new Entity.
        action:
          $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Action'
      required:
      - applicationId
      title: Platform
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequestOptions:
      type: object
      description: Options applicable to all messages in the request.
      properties:
        schedule:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RequestSchedulingSettings'
        tracking:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.UrlOptions'
        messageOrdering:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageOrderingOptions'
      title: MessagesApiRequestOptions
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.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
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.ResendPinRequest:
      type: object
      properties:
        placeholders:
          type: object
          additionalProperties:
            type: string
          description: 'Key value pairs that will be replaced during message sending. Placeholder keys should NOT contain curly brackets and should NOT contain a `pin` placeholder. Valid example: `"placeholders":{"firstName":"John"}`'
          readOnly: false
          writeOnly: true
        trackDelivery:
          type: boolean
          default: false
          description: 'Enables sending of delivery reports via [Subscriptions](https://www.infobip.com/docs/cpaas-x/subscriptions-management). 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)`.'
          readOnly: false
          writeOnly: true
      title: ResendPinRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewStatus:
      type: string
      description: The current status of the AI campaign review.
      enum:
      - PROCESSING
      - COMPLIANT
      - NON_COMPLIANT
      title: ExternalAutomaticReviewStatus
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageConfirmationBody:
      type: object
      description: Body of the confirmation message.
      properties:
        text:
          type: string
          description: Text to be sent.
        description:
          type: string
          description: Description to be sent.
        imageUrl:
          type: string
          description: URL of the image.
      required:
      - text
      title: MessagesApiMessageConfirmationBody
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.InteractiveVoiceResponseOptIn:
      type: object
      description: The type of opt in that requires a user to record a confirmation.
      properties:
        callToAction:
          type: string
          description: "    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n"
          maxLength: 1024
          minLength: 20
      required:
      - callToAction
      title: InteractiveVoiceResponseOptIn
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageGeneralStatus:
      type: string
      description: Status group name that describes which category the status code belongs to, i.e., [PENDING](https://www.infobip.com/docs/essentials/response-status-and-error-codes#pending-general-status-codes), [UNDELIVERABLE](https://www.infobip.com/docs/essentials/response-status-and-error-codes#undeliverable-general-status-codes), [DELIVERED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#delivered-general-status-codes), [EXPIRED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#expired-general-status-codes), [REJECTED](https://www.infobip.com/docs/essentials/response-status-and-error-codes#rejected-general-status-codes).
      enum:
      - ACCEPTED
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: MessageGeneralStatus
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ViewableChannel:
      type: string
      description: Channel used for sending for which blocklist happened.
      enum:
      - SMS
      - EMAIL
      - VOICE_OUTBOUND_TTS
      - NEW_PUSH_NOTIF
      - VIBER
      - RCS
      - WHATSAPP
      - APPLE_MB
      - MMS
      title: ViewableChannel
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.StartEmailAuthenticationResponse:
      type: object
      properties:
        emailStatus:
          allOf:
          - $ref: '#/components/schemas/aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.EmailStatus'
          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.
          readOnly: false
          writeOnly: false
        pinId:
          type: string
          description: Sent PIN code ID.
          readOnly: false
          writeOnly: false
        to:
          type: string
          description: 'Email address to which the 2FA message has been sent. Example: john.smith@example.com.'
          readOnly: false
          writeOnly: false
      title: StartEmailAuthenticationResponse
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageEntity:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Entity'
        paging:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageInfo'
      title: PageEntity
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UnsetOption:
      type: string
      description: Used for unsetting configuration options. <br /> <b>If a property appears both in unset, and in the body of the request, it will <u>FIRST</u> be removed, and then <u>UPDATED</u> with the value from the request body!</b>
      enum:
      - USERNAME
      - PLATFORM
      - FORWARDING
      - CONVERSATIONS
      - ANSWERS
      - AUTORESPONSE
      - BLOCKLISTCONFIGURATION
      example: FORWARDING
      title: UnsetOption
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType:
      type: string
      description: Campaign type.
      enum:
      - TEN_DIGIT_LONG_CODE
      - EXTERNAL_TEN_DIGIT_LONG_CODE
      - SHORT_CODE
      - DCA2_TEN_DIGIT_LONG_CODE
      - TOLL_FREE_NUMBER
      - TOLL_FREE_UNIFIED_NUMBER
      - TOLL_FREE_EXTERNALLY_VERIFIED
      - RCS_SENDER_LAUNCH
      title: CampaignType
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageDataFilter:
      type: object
      description: "\nA JSON object specifying criteria to filter the results. Each field in the object represents a different filter\ncriterion to enable detailed and complex filtering.\n        "
      properties:
        dateInterval:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateInterval'
        accountKeys:
          type: array
          description: "\nSpecifies a list of unique account keys (identifiers).\n\nIf not provided, data for all accounts in the customer hierarchy will be included.\n\nTo retrieve all available account keys, refer to the\n[Account list endpoint](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).\n        "
          example:
          - account_key_1
          - account_key_2
          items:
            type: string
            description: "\nSpecifies a list of unique account keys (identifiers).\n\nIf not provided, data for all accounts in the customer hierarchy will be included.\n\nTo retrieve all available account keys, refer to the\n[Account list endpoint](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).\n        "
            example: '["account_key_1","account_key_2"]'
          uniqueItems: true
        categories:
          type: array
          description: "\nChannel or service categories to filter by.\n\nIf not provided, all billing categories available to the authenticated account are included.\n        "
          enum:
          - SMS
          - SMS_OPERATOR_FEE
          - MMS
          - MMS_OPERATOR_FEE
          - EMAIL
          - RCS
          - WHATSAPP
          - VIBER
          - APPLE_MB
          - MOBILE_PUSH
          - NUMBER_LOOKUP
          - CARRIER_LOOKUP
          - EMAIL_VALIDATION
          - AGENTOS
          - AI
          items:
            type: string
            description: "\nChannel or service categories to filter by.\n\nIf not provided, all billing categories available to the authenticated account are included.\n        "
            enum:
            - SMS
            - SMS_OPERATOR_FEE
            - MMS
            - MMS_OPERATOR_FEE
            - EMAIL
            - RCS
            - WHATSAPP
            - VIBER
            - APPLE_MB
            - MOBILE_PUSH
            - NUMBER_LOOKUP
            - CARRIER_LOOKUP
            - EMAIL_VALIDATION
            - AGENTOS
            - AI
          uniqueItems: true
        subCategories:
          type: array
          description: "\nSubcategories of categories (service variants). Currently applicable to Viber only.\n        "
          enum:
          - VIBER_BM
          - VIBER_BOTS
          items:
            type: string
            description: "\nSubcategories of categories (service variants). Currently applicable to Viber only.\n        "
            enum:
            - VIBER_BM
            - VIBER_BOTS
          uniqueItems: true
        countryCodes:
          type: array
          description: "\nSpecifies ISO 3166-1 alpha-2 country codes to filter billing data for specific countries.\n        "
          example:
          - US
          - DE
          - IN
          items:
            type: string
            description: "\nSpecifies ISO 3166-1 alpha-2 country codes to filter billing data for specific countries.\n        "
            example: '["US","DE","IN"]'
          uniqueItems: true
        platforms:
          type: array
          description: "\nSpecifies the platform object, which is a combination of an applicationId and entityId. These IDs uniquely identify\neach application and entity configured on the Infobip platform.\n\nUse this object and its related parameters to filter data for a specific application and entity combination. Note that\nthese parameters should only be used if you leverage CPaaS X applications and entities to manage your traffic.\n\nFor detailed information on applications and entities in the CPaaS X ecosystem, refer to the\n[CPaaSX overview](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Platform'
          uniqueItems: true
        directions:
          type: array
          description: "\nSpecifies the direction of traffic, indicating whether the message was sent to the user (OUTBOUND) or received from the user (INBOUND).\n        "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Direction'
          uniqueItems: true
        trafficTypes:
          type: array
          description: "\nSpecifies the types of traffic. For a full list of values, refer to\n[traffic types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#traffictypes).\n        "
          example:
          - UTILITY
          - FREE_FORM
          items:
            type: string
            description: "\nSpecifies the types of traffic. For a full list of values, refer to\n[traffic types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#traffictypes).\n        "
            example: '["UTILITY","FREE_FORM"]'
          uniqueItems: true
        senders:
          type: array
          description: "\nSpecifies the sender IDs, which can be alphanumeric or numeric.\n        "
          example:
          - mySender
          - '12345'
          - '15551234567'
          - jane.smith@somecompany.com
          items:
            type: string
            description: "\nSpecifies the sender IDs, which can be alphanumeric or numeric.\n        "
            example: '["mySender","12345","15551234567","jane.smith@somecompany.com"]'
          uniqueItems: true
        senderTypes:
          type: array
          description: "\nSpecifies the types of senders. For a full list of values, refer to\n[sender types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#sendertypes).\n        "
          example:
          - ALPHANUMERIC
          - SHORT_CODE
          - VIRTUAL_LONG_NUMBER
          - DOMAIN
          items:
            type: string
            description: "\nSpecifies the types of senders. For a full list of values, refer to\n[sender types](https://www.infobip.com/docs/metrics-api/metrics-and-filters#sendertypes).\n        "
            example: '["ALPHANUMERIC","SHORT_CODE","VIRTUAL_LONG_NUMBER","DOMAIN"]'
          uniqueItems: true
        campaignReferenceIds:
          type: array
          description: "\nSpecifies the list of campaign reference IDs used for traffic sent over Infobip APIs.\n\nUse `campaignReferenceIds` to filter data related to specific campaigns.\n        "
          example:
          - summer-sale
          - bf2026
          items:
            type: string
            description: "\nSpecifies the list of campaign reference IDs used for traffic sent over Infobip APIs.\n\nUse `campaignReferenceIds` to filter data related to specific campaigns.\n        "
            example: '["summer-sale","bf2026"]'
          uniqueItems: true
        campaignIds:
          type: array
          description: "\nCampaign IDs, also known as communication IDs, associated with Broadcast or Moments/Flow campaigns.\n\nUse these values to filter billing data related to specific campaigns.\n\nFor detailed information on the differences between Broadcast and Flow campaigns, refer to the\n[Broadcast](https://www.infobip.com/docs/broadcast) and [Flow overview](https://www.infobip.com/docs/moments).\n        "
          example:
          - 12354646546
          - 45534466546
          - 754564654689
          items:
            type: integer
            format: int64
            description: "\nCampaign IDs, also known as communication IDs, associated with Broadcast or Moments/Flow campaigns.\n\nUse these values to filter billing data related to specific campaigns.\n\nFor detailed information on the differences between Broadcast and Flow campaigns, refer to the\n[Broadcast](https://www.infobip.com/docs/broadcast) and [Flow overview](https://www.infobip.com/docs/moments).\n        "
          uniqueItems: true
        templateIds:
          type: array
          description: "\nWhatsApp template IDs.\n        "
          example:
          - '5653923468715475'
          - '5253923468715475'
          items:
            type: string
            description: "\nWhatsApp template IDs.\n        "
            example: '["5653923468715475","5253923468715475"]'
          uniqueItems: true
      required:
      - dateInterval
      title: BillingUsageDataFilter
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionResponse'
        paging:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo'
      title: SubscriptionPage
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RegisterCampaignRequest:
      type: object
      properties:
        priorityId:
          type: string
          format: uuid
          description: The ID of the campaign priority you would like to use.
          externalDocs:
            description: Find out more about Campaign Priority.
            url: https://www.infobip.com/docs/api/platform/numbers/number-registration/campaigns/get-campaign-priorities
      title: RegisterCampaignRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTrafficType:
      type: string
      description: Traffic type classification for message sending. Supported by Viber for non-template messages only.
      enum:
      - PROMOTIONAL
      - TRANSACTIONAL
      title: MessagesApiTrafficType
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnDataType:
      type: string
      description: 'Data type of the values related to a given column. The available data types are:

        * `STRING` - type used for string values.

        * `INTEGER` - type used for integral numbers.

        * `NUMBER` - type used for floating point numbers.

        * `BOOLEAN` - type used for boolean values.

        * `DATE_TIME` - type used to display date and time together (in UTC timezone, formatted as yyyy-MM-ddTHH:mm:ss).

        '
      enum:
      - STRING
      - INTEGER
      - NUMBER
      - BOOLEAN
      - DATE_TIME
      title: ColumnDataType
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateAccountRequest:
      type: object
      properties:
        name:
          type: string
          description: New name for the account
        enabled:
          type: boolean
          description: Enable or disable the account
      title: UpdateAccountRequest
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - ALPHANUMERIC_REGISTRATION
        senderName:
          type: string
          description: Sender name. GSM7 format required, with at least one letter.
          maxLength: 11
          minLength: 3
        additionalContactEmails:
          type: array
          description: Email addresses that would be contacted by Infobip support team for any request related matter.
          items:
            type: string
            description: Email addresses that would be contacted by Infobip support team for any request related matter.
          maxItems: 3
          minItems: 0
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
        trafficType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType'
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      required:
      - countryCode
      - requirements
      - senderName
      - type
      title: ALPHANUMERIC_REGISTRATION
    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
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.clientRequestedPeriod:
      type: object
      description: Originally requested time period referenced in the response.
      properties:
        sentSince:
          type: string
          format: date-time
          description: Start of the sent traffic date-time period (inclusive).
          example: '2023-04-01T00:00:00Z'
        sentUntil:
          type: string
          format: date-time
          description: End of the sent traffic date-time period (exclusive).
          example: '2023-04-01T00:00:00Z'
      required:
      - sentSince
      - sentUntil
      title: clientRequestedPeriod
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ClientRequestStatus:
      type: string
      description: Request processing status.
      enum:
      - IN_PROGRESS
      - SUCCESS
      - FAILED
      title: ClientRequestStatus
    fc7dd544c10bf8ba502ba371088d1382022decf6a1acc2d0fa20f0b7f272047d.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage:
      type: string
      enum:
      - DRAFT
      - SUBMITTED_FOR_REVIEW
      - IN_REVIEW
      - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
      - APPROVED_BY_INTERNAL_REVIEWER
      - SUBMITTED
      - REJECTED_EXTERNALLY
      - REGISTERED
      - REJECTED
      - ON_HOLD
      - DEREGISTERED
      - REGISTERED_PENDING_UPDATE
      - REGISTERED_PENDING_DEREGISTRATION
      - ARCHIVED
      - BLOCKED
      - SUSPENDED
      - APPEALED
      - IN_MIGRATION
      - PAUSED
      readOnly: true
      title: CampaignStage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionRequest:
      oneOf:
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentitySubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest'
      title: SubscriptionRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStage:
      type: string
      enum:
      - DRAFT
      - SUBMITTED
      title: BrandStage
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand:
      type: object
      discriminator:
        propertyName: type
        mapping:
          TENDLC_NON_PROFIT: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NonProfitBrand'
          TENDLC_PRIVATE_COMPANY: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PrivateCompanyBrand'
          TENDLC_PUBLIC_COMPANY: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PublicCompanyBrand'
          TENDLC_GOVERNMENT: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.GovernmentBrand'
          TOLL_FREE_NUMBER: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeBrand'
      properties:
        id:
          type: string
          format: uuid
          description: The identifier for the brand.
          readOnly: true
        applicationId:
          type: string
          description: CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.
        entityId:
          type: string
          description: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
        name:
          type: string
          description: The customer defined name of brand.
          maxLength: 100
          minLength: 1
        stage:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStage'
        website:
          type: string
          description: The website for the brand.
          maxLength: 100
          minLength: 11
        createdDate:
          type: string
          format: date-time
          description: The date and time when the brand was created.
          readOnly: true
        lastModifiedDate:
          type: string
          format: date-time
          description: The date and time when the brand was last modified.
          readOnly: true
        type:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandType'
      required:
      - name
      - type
      - website
      title: Brand
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssRequestV2:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Platform'
        channel:
          type: string
          description: 'Channel for which the Sending Strategy is created. Supported channels: SMS, MMS, RCS. If left empty, Sending Strategy will be applied to all supported channels.'
          example: SMS
          maxLength: 255
          minLength: 1
        destinationCountryCode:
          type: string
          description: Country code, in two-letter ISO standard, of the country the messages are terminating to for which the Sending Strategy will be used. If left empty, Sending Strategy will attempt to be used for all the countries where you have senders provisioned.
          example: US
        useStickySender:
          type: boolean
          default: false
          description: If true, the same sender will be used for any subsequent interactions with the end user (inside one country).
          example: false
        useGeolocatedSender:
          type: boolean
          default: false
          description: If true, the sender will be selected from the list of senders based on the nearest local area code. Supported for US and CA for now.
          example: false
        priorities:
          type: array
          description: Priorities of the senders that can be defined in case there is more than one sender for a destination country.
          items:
            $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Priority'
      title: SssRequestV2
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageInfo:
      type: object
      description: Information about resource coverage.
      oneOf:
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoCoverageInfo'
      - $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.FacebookCoverageInfo'
      title: IbResourceCoverageInfo
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleLineEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Line
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NetworkState:
      type: string
      description: The state of the campaign's registration with this network.
      enum:
      - ACTIVE
      - PENDING
      - NOT_REGISTERED
      - CERTIFICATION
      title: NetworkState
    b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenRequest:
      type: object
      description: Request used for creating OAuth2 token.
      properties:
        client_id:
          type: string
          description: The username created when signing up with Infobip.
        client_secret:
          type: string
          description: The password created when signing up with Infobip.
        grant_type:
          type: string
          allOf:
          - $ref: '#/components/schemas/b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.GrantType'
          description: Grant type as defined by the OAuth framework.
        code:
          type: string
          description: Authorization code received from the authorization server. This parameter is required only if the `grant_type` is set to `authorization_code`.
      required:
      - client_id
      - client_secret
      - grant_type
      title: TokenRequest
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageApiRequest:
      type: object
      description: "\nContains filter criteria, aggregation dimensions, and query options for the billing usage report.\n        "
      properties:
        filterBy:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageDataFilter'
        aggregateBy:
          type: array
          description: "\nAn array of strings that defines the properties used for data aggregation. Each item in the array represents an\naggregation parameter, with a corresponding column in the response showing values for the chosen aggregate.\n\nIf neither `ACCOUNT_NAME` nor `ACCOUNT_KEY` is specified, `ACCOUNT_NAME` is prepended to the response columns automatically.\nIf neither `CATEGORY_NAME` nor `CATEGORY_CODE` is specified, `CATEGORY_CODE` is prepended to the response columns automatically.\n\nAvailable aggregation dimensions:\n\n**Time:**\n* `DAY` - Day-level aggregation\n* `MONTH` - Month-level aggregation\n\n**CPaaSX Context:**\n* `APPLICATION_ID` - CPaaSX application identifier\n* `ENTITY_ID` - CPaaSX entity identifier\n\n**Account:**\n* `ACCOUNT_NAME` - Account display name\n* `ACCOUNT_KEY` - Account identifier\n* `USER_NAME` - User who initiated traffic\n\n**Service:**\n* `CATEGORY_NAME` - Channel/service display name\n* `CATEGORY_CODE` - Channel/service code\n* `SUBCATEGORY_NAME` - Service variant name\n* `SUBCATEGORY_CODE` - Service variant code\n* `DIRECTION` - Inbound/Outbound\n* `TRAFFIC_TYPE` - Channel-specific classification\n\n**Sender:**\n* `SENDER` - Sender ID/number/domain\n* `SENDER_TYPE` - VLN, shortcode, alphanumeric\n\n**Geography:**\n* `NETWORK_NAME` - Mobile operator name\n* `NORM_NET_CODE` - MCC+MNC code\n* `COUNTRY_NAME` - Destination country\n* `COUNTRY_CODE` - ISO 3166-1 alpha-2 code\n* `COUNTRY_PREFIX` - International dialing code\n\n**Campaign:**\n* `CAMPAIGN_ID` - Campaign identifier\n* `CAMPAIGN_REFERENCE` - External campaign reference\n* `TEMPLATE_ID` - WhatsApp template ID\n            "
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageAggregate'
          uniqueItems: true
        options:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageQueryOptions'
      required:
      - aggregateBy
      - filterBy
      title: QueryBillingUsageApiRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData:
      type: object
      description: Campaign builder result data. The structure varies based on the campaign type.
      discriminator:
        propertyName: campaignType
        mapping:
          TEN_DIGIT_LONG_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData'
          SHORT_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData'
          TOLL_FREE_NUMBER: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData'
      oneOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData'
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData'
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultData'
      properties:
        campaignType:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType'
        optInMethods:
          type: array
          description: Opt-in configuration.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultOptIn'
        termsConditionsSample:
          type: string
          description: Terms and conditions content sample.
        privacyPolicySample:
          type: string
          description: Privacy policy content sample.
      title: CampaignBuilderResultData
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeaderType:
      type: string
      enum:
      - TEXT
      - DOCUMENT
      - IMAGE
      - VIDEO
      - LOCATION
      title: MessagesApiTemplateHeaderType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Address:
      type: object
      description: The address of the brand.
      properties:
        city:
          type: string
          description: The city in which the brand is located.
          maxLength: 50
          minLength: 1
        state:
          type: string
          description: State or province. For the United States, please use 2 character codes. E.g. 'CA' for California.
          maxLength: 20
          minLength: 1
        street:
          type: string
          description: The street address for the brand.
          maxLength: 100
          minLength: 1
        zipCode:
          type: string
          description: The zipcode in which the brand is located.
          maxLength: 10
          minLength: 1
      required:
      - city
      - street
      - zipCode
      title: Address
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Kakao Alim
    bad08f31d0530c669218bdbac07f91125fbbb50284a2712ce5d27fb95dd26628.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogItemDto:
      type: object
      properties:
        values:
          type: array
          description: A list of item field values. Maximum <code>1000</code> values.
          items:
            $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogValueDto'
      required:
      - values
      title: CreateCatalogItemDto
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogValueDto:
      type: object
      properties:
        fieldId:
          type: string
          description: Field ID.
          example: f5cdcb82-7a5b-4707-b37a-4153da514403
        value:
          type: string
          description: Field value.
          example: Custom field value
      required:
      - fieldId
      - value
      title: UpdateCatalogValueDto
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair:
      type: object
      description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
      properties:
        applicationId:
          type: string
          description: CPaaS X property identifying an application, an use case or an environment on your system. Should only be set if you are using CPaaS X Applications with your traffic.
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
          maxLength: 255
          minLength: 0
        callsConfigurationId:
          type: string
          description: CPaaS X calls configuration identifier. Should only be set if you are using CPaaS X Applications with your traffic.
          maxLength: 255
          minLength: 0
      title: ApplicationEntityPair
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToCreate:
      type: object
      description: To.
      properties:
        to:
          type: string
          description: 'Destination address that needs to be blocklisted. Addresses must be a number in international format (example: `41793026727`),  a valid email address (example: `recipient@example.com`) or valid email domain (example: `example.com`).'
          maxLength: 255
          minLength: 1
      required:
      - to
      title: ToCreate
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader:
      type: object
      description: Header of a template message.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextHeader'
          DOCUMENT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateDocumentHeader'
          IMAGE: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateImageHeader'
          VIDEO: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateVideoHeader'
          LOCATION: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateLocationHeader'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeaderType'
      required:
      - type
      title: MessagesApiTemplateHeader
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceInfo:
      type: object
      description: Information about Apple type of resource.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        displayName:
          type: string
          description: Display name.
          example: MyDisplayName
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          description: Capabilities of the sender.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Apple
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.MetricType:
      type: string
      enum:
      - TOTAL_TRAFFIC_COUNT
      - TOTAL_ACCEPTED_TRAFFIC_COUNT
      - TOTAL_SMS_MESSAGES_COUNT
      - INTERACTION_COUNT
      - UNIQUE_CLICKS_COUNT
      - TOTAL_CLICKS_COUNT
      - UNIQUE_CLICK_THROUGH_RATE
      - DELIVERED_TRAFFIC_COUNT
      - FAILED_TRAFFIC_COUNT
      - TRAFFIC_DELIVERY_RATE
      - TRAFFIC_DELIVERED_IN_5_SEC_RATE
      - SEEN_OPENED_TRAFFIC_COUNT
      - SEEN_OPENED_TRAFFIC_RATE
      - TOTAL_SENT_TRAFFIC_COUNT
      - TOTAL_RECEIVED_TRAFFIC_COUNT
      - RECEIVED_TO_SENT_TRAFFIC_RATIO
      - UNIQUE_URL_CLICK_COUNT
      - TOTAL_BOUNCE_COUNT
      - TOTAL_BOUNCE_RATE
      - TOTAL_SUPPRESSED_COUNT
      - SOFT_BOUNCE_COUNT
      - SOFT_BOUNCE_RATE
      - HARD_BOUNCE_COUNT
      - HARD_BOUNCE_RATE
      - VIEWED_TOTAL_COUNT
      - VIEWED_TOTAL_RATE
      - TOTAL_CLICK_RATE
      - CLICK_TO_OPEN_RATE
      - UNSUBSCRIBED_USER_COUNT
      - UNSUBSCRIBED_USER_RATE
      - EMAIL_COMPLAINTS_COUNT
      - EMAIL_COMPLAINTS_RATE
      - TOTAL_CALL_COUNT
      - TOTAL_ATTEMPTED_CALL_COUNT
      - TOTAL_SEIZED_CALL_COUNT
      - TOTAL_ANSWERED_CALL_COUNT
      - TOTAL_RECEIVED_CALL_COUNT
      - AMD_PROCESSED_CALL_COUNT
      - ANSWERED_BY_PERSON_CALL_COUNT
      - ANSWERED_BY_VOICE_DETECTION_CALL_COUNT
      - NOT_ANSWERED_CALL_COUNT
      - BUSY_CALL_COUNT
      - CANCELED_CALL_COUNT
      - FAILED_CALL_COUNT
      - TOTAL_CALL_DURATION
      - ANSWER_SEIZURE_RATIO
      - ANSWER_RATE
      - BUSY_RATE
      - HUNG_UP_COUNT
      - NORMAL_HUNG_UP_COUNT
      - ERROR_HUNG_UP_COUNT
      title: MetricType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.RejectionReason:
      type: object
      description: Rejection reasons details.
      properties:
        errorCode:
          type: string
          description: Predefined code.
        description:
          type: string
          description: Rejection reason.
        recommendedAction:
          type: string
          description: Recommended action.
      title: RejectionReason
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - DELIVERY
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents:
      type: string
      enum:
      - DELIVERY
      title: Event
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignNetworkStatus:
      type: string
      description: The new campaign registration status for a given network.
      enum:
      - ACTIVE
      example: ACTIVE
      title: WebhookCampaignNetworkStatus
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKeyResponse:
      type: object
      properties:
        key:
          type: string
          description: Unique key specifying this api key.
        publicApiKey:
          type: string
          description: Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.
        accountKey:
          type: string
          description: Unique identifier for account this API key belongs to.
        name:
          type: string
          description: Name of this API Key.
        allowedIPs:
          type: array
          description: List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.
          items:
            type: string
            description: List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.
        validFrom:
          type: string
          format: date-time
          description: Date from which this API key is/will be valid. Time is in UTC.
        validTo:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC.
        enabled:
          type: boolean
          description: Is API key enabled.
        permissions:
          type: array
          description: List of permissions this API key has granted.
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission'
      required:
      - name
      title: ApiKeyResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType:
      type: string
      description: The type of number.
      enum:
      - VIRTUAL_LONG_NUMBER
      - SHORT_CODE
      - SIM_HOSTING
      - VIRTUAL_SIM_HOSTING
      - VIRTUAL_LONG_NUMBER_CALL_TRIGGER
      - SHORT_CODE_USSD
      - WHATSAPP
      - VIBER
      - VIBER_VOICE
      - FACEBOOK
      - RCS
      - TELEGRAM
      - KAKAO_SANGDAM
      - OPEN_CHANNEL
      title: NumberType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest'
      description: Request to start building Toll free campaign using AI assistant.
      required:
      - brandId
      - campaignIntent
      - campaignType
      - contactEmail
      - optInMethods
      title: TollFreeCampaignBuilderRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceInfo:
      type: object
      description: Information about the numeric type of resource.
      properties:
        number:
          type: string
          description: Phone number.
          example: '447860041117'
        numberKey:
          type: string
          description: Number key.
          example: 58B3840032C7774BAC840EEEA2C23A44
        platform:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs'
        numberType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberTypeResourceMoDocs'
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          description: Capabilities of the number.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Number
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.DocumentMetadata:
      type: object
      description: Preview of the screenshot document. This property is read-only and ignored in POST/PUT calls.
      properties:
        documentId:
          type: string
          format: uuid
          description: Unique identifier for the document.
        documentName:
          type: string
          description: Name of the document file.
        contentType:
          type: string
          description: MIME type of the document content (e.g., application/pdf, image/png).
        contentLength:
          type: integer
          format: int32
          description: Size of the document content in bytes.
      title: DocumentMetadata
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents:
      type: string
      enum:
      - AI_CAMPAIGN_BUILDER
      - AI_CAMPAIGN_FEEDBACK
      - BRAND_AUTH_UPDATE
      - BRAND_STATUS_UPDATE
      - BRAND_VET_UPDATE
      - CAMPAIGN_NETWORK_STATUS_UPDATE
      - CAMPAIGN_STATUS_UPDATE
      - RESOURCE_REQUEST_FOC_DATE_CHANGE
      - RESOURCE_REQUEST_REMINDER
      - RESOURCE_REQUEST_STATUS_UPDATE
      title: Event
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceInfo:
      type: object
      description: Information about RCS type of resource.
      properties:
        senderName:
          type: string
          description: Sender name.
          example: MySender
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          description: Capabilities of the sender.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: RCS
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogValueDto:
      type: object
      description: A list of item field values. Maximum <code>1000</code> values.
      properties:
        fieldName:
          type: string
          description: Field name.
          example: Custom field name
        fieldId:
          type: string
          description: Field ID.
          example: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
        value:
          type: string
          description: Field value.
          example: Custom field value
      required:
      - value
      title: CreateCatalogValueDto
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVetStatus:
      type: string
      description: The new brand vet status.
      enum:
      - SUCCESS
      - FAILURE
      example: SUCCESS
      title: WebhookBrandVetStatus
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Web Push
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiPageResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiResponse'
        paging:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo'
      title: NumberPoolUsageApiPageResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultData:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData'
      - type: object
        properties:
          useCase:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcUseCase'
          messageFlow:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultMessageFlow'
          termsConditions:
            type: string
            writeOnly: true
          privacyPolicy:
            type: string
            writeOnly: true
      description: Campaign builder result for 10DLC campaigns.
      title: TenDlcCampaignBuilderResultData
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundSeenChannel:
      type: string
      description: Messaging channel used for sending an event.
      enum:
      - RCS
      - VIBER_BM
      - VIBER_BOT
      - WHATSAPP
      title: InboundSeenChannel
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CreatableChannel:
      type: string
      description: Channel used for sending for which blocklist happened.
      enum:
      - SMS
      - EMAIL
      - VIBER
      - RCS
      - MMS
      - WHATSAPP
      title: CreatableChannel
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions:
      type: object
      properties:
        indiaDlt:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.IndiaDltOptions'
          description: Distributed Ledger Technology (DLT) specific parameters required for sending SMS to phone numbers registered in India.
          readOnly: false
          writeOnly: false
      title: RegionalOptions
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFailover:
      type: object
      description: Configuration of a single failover step
      properties:
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel'
        sender:
          type: string
          description: Sender for channel specified above.
        template:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate'
        content:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent'
        validityPeriod:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod'
      required:
      - channel
      - template
      title: Template message failover
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseMessageResponseDetails:
      type: object
      description: An array of message objects of a single message or multiple messages sent under one bulk ID.
      properties:
        messageId:
          type: string
          description: Unique message ID. If not provided, it will be auto-generated and returned in the API response.
        status:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageStatus'
        destination:
          type: string
          description: The destination address of the message, i.e., its recipient.
        details:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseDetails'
      title: MessageResponseMessageResponseDetails
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageResourceAssociation:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationResponse'
        paging:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageInfo'
      title: PageResourceAssociation
    b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.GrantType:
      type: string
      description: Grant type as defined by the OAuth framework.
      enum:
      - client_credentials
      - 'authorization_code '
      title: GrantType
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBodyType:
      type: string
      enum:
      - TEXT
      - IMAGE
      - VIDEO
      - DOCUMENT
      - RICH_LINK
      - AUTHENTICATION_REQUEST
      - LIST
      - CAROUSEL
      - LOCATION
      - CONTACT
      - STICKER
      - PRODUCT
      - MIXED
      - FLOW
      - TIME_PICKER
      - ORDER_REQUEST
      - ORDER_STATUS
      - FORM
      title: MessagesApiMessageBodyType
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsAction:
      type: object
      description: Forward action configuration.
      discriminator:
        propertyName: type
        mapping:
          HTTP_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsHttpForwardAction'
          PULL: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsPullAction'
          NO_ACTION: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsNoAction'
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType'
        description:
          type: string
          description: Additional action description.
      title: MmsAction
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.UploadDocumentApiDoc:
      type: object
      properties:
        document:
          type: string
          format: binary
          description: 'The document file you want to upload. Supported file formats: .doc, .docx, .jpg, .jpeg, .png, .pdf, .xls, .xlsx, .mp4, .avi, .mov, .webm'
      required:
      - document
      title: UploadDocumentApiDoc
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ResponseEnvelopeMessageResponseMessageResponseDetails:
      type: object
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response. Typically used for fetching delivery reports and message logs.
        messages:
          type: array
          description: An array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageResponseMessageResponseDetails'
      required:
      - messages
      title: ResponseEnvelopeMessageResponseMessageResponseDetails
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandStatus:
      type: object
      properties:
        registrar:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrar'
        state:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationStatusPublic'
        brandIdentityStatus:
          type: string
          description: The status of the brand as determined by the registrar.
          enum:
          - SELF_DECLARED
          - UNVERIFIED
          - VERIFIED
          - VETTED_VERIFIED
          example: UNVERIFIED
        brandAuthenticationStatus:
          type: string
          description: The status of brand authentication applicable for TENDLC_PUBLIC_COMPANY brand type.
          enum:
          - PENDING
          - ACTIVE
          - FAILED
          - EXPIRED
          example: PENDING
        rejectionReason:
          type: string
          description: The reason for brand registration rejection.
          example: Invalid country code.
      title: BrandStatus
    ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityRequest:
      type: object
      description: Security settings object holding authentication settings necessary to access your webhook.
      properties:
        authId:
          type: string
          description: Unique security setting ID. You can provide this ID if you want to associate your subscription with a different notification profile.
          maxLength: 255
          minLength: 1
      required:
      - authId
      title: Security
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus:
      type: string
      description: Current status of the resource request.
      enum:
      - PENDING
      - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
      - CANCELED
      - AUTOMATIC_VALIDATION
      - UPDATE_REQUESTED
      - REJECTED
      - COMPLETED
      - PENDING_REVIEW
      - IN_REVIEW
      - IN_PROGRESS
      - CANCEL_REQUESTED
      title: ResourceOrderStatus
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload:
      type: object
      description: HMAC credentials.
      properties:
        secretKey:
          type: string
          description: Secret key.
          maxLength: 255
          minLength: 1
        algorithm:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm'
      required:
      - algorithm
      - secretKey
      title: HmacCredentials
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.CreateSessionRequest:
      type: object
      properties:
        username:
          type: string
          description: Username of the user.
        password:
          type: string
          description: Password of the user.
        unsafe:
          type: boolean
          description: Create session which is not bound to IP.
      required:
      - password
      - username
      title: CreateSessionRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType:
      type: string
      description: Resource type.
      enum:
      - ALPHANUMERIC
      - NUMBER
      - RCS_RESOURCE
      - VIBER_RESOURCE
      - APPLE_RESOURCE
      - OPEN_CHANNEL_RESOURCE
      - KAKAO_RESOURCE
      - FACEBOOK_RESOURCE
      example: FACEBOOK_RESOURCE
      title: IbResourceType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents:
      type: string
      enum:
      - NUMBER_LOOKUP
      title: Event
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamDeliveryStatus:
      type: object
      description: Current status of CNAM Delivery configuration.
      properties:
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status'
        reason:
          type: string
          description: Description of the status.
      title: PublicCnamDeliveryStatus
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogDto:
      type: object
      properties:
        id:
          type: integer
          format: int64
          description: Catalog ID.
          example: 10000
        name:
          type: string
          description: Catalog name.
          example: Catalog Name
        description:
          type: string
          description: Catalog description.
          example: Catalog description
        type:
          $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogTypes'
      required:
      - description
      - id
      - name
      - type
      title: CatalogDto
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.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
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UploadDocumentApiDoc:
      type: object
      properties:
        document:
          type: string
          format: binary
          description: The document file to be uploaded.
      required:
      - document
      title: UploadDocumentApiDoc
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundMessageChannel:
      type: string
      description: Messaging channel used for sending a message.
      enum:
      - APPLE_MB
      - INSTAGRAM_DM
      - LINE_ON
      - MESSENGER
      - MMS
      - RCS
      - SMS
      - VIBER_BM
      - VIBER_BOT
      - WHATSAPP
      title: OutboundMessageChannel
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StatusResponse:
      type: object
      description: Current status of Emergency Service configuration.
      properties:
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status'
        reason:
          type: string
          description: Description of the status.
      title: StatusResponse
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogValueDto:
      type: object
      description: A list of item field values. Maximum <code>1000</code> values.
      properties:
        fieldName:
          type: string
          description: Field name.
          example: Custom field name
        fieldId:
          type: string
          description: Field ID.
          example: 8b00a8c6-5302-4fd0-a0cc-bb090b28ac34
        value:
          type: string
          description: Field value.
          example: Custom field value
      required:
      - fieldId
      - fieldName
      - value
      title: CatalogValueDto
    7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddress:
      type: object
      properties:
        enabled:
          type: boolean
          default: false
          description: Indicates whether configuration is enabled or not.
        address:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address'
      required:
      - address
      - enabled
      title: EmergencyAddress
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobileIdentityEvents:
      type: string
      enum:
      - SILENT_VERIFICATION
      title: Event
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTimeWindow:
      type: object
      description: Sets specific message delivery window outside of which messages won't be delivered. Often, used when there are restrictions on when messages can be sent. The exact time of the day to start sending messages can be defined using the `from` property. The exact time of the day to end sending messages can be defined using the `to` property. Properties `from` and `to` should be both provided with the minimum 1 hour difference or omitted.
      properties:
        days:
          type: array
          description: Days of the week which are included in the delivery time window. At least one day must be provided. Separate multiple days with a comma.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryDay'
        from:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime'
        to:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime'
      required:
      - days
      title: DeliveryTimeWindow
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistResponse:
      type: object
      description: Blocklist response.
      properties:
        sender:
          type: string
          description: The sender ID for which blocklist happened.
        destination:
          type: string
          description: Blocklisted destination address.
        sourceType:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.SourceType'
        channel:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ViewableChannel'
        accountKey:
          type: string
          description: Account connected with a blocklist record. Main account has access to blocklist records of their subaccounts. Subaccounts can only access blocklist records specific to them. [API to retrieve account key](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).
        createdDate:
          type: string
          format: date-time
          description: Timestamp of created blocklist record.
        campaign:
          type: string
          format: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
      required:
      - accountKey
      - createdDate
      - destination
      - sourceType
      title: BlocklistResponse
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.EventSourceType:
      type: string
      description: 'Represents the way blocklist record was created:


        MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.


        URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.


        CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).'
      enum:
      - MO
      - URL_OPT_OUT
      - CAMPAIGN
      title: EventSourceType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookMessage'
      title: BrandVetStatusWebhookResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionChannel:
      type: string
      enum:
      - AGENT_OS
      - APPLE_MESSAGES_FOR_BUSINESS
      - BLOCKLIST
      - CUSTOMER_ENGAGEMENT
      - EMAIL
      - FACEBOOK
      - KAKAO_ALIM
      - KAKAO_BRAND_MESSAGE
      - LINE
      - MMS
      - MOBILE_IDENTITY
      - MOBILE_PUSH
      - NUMBER_LOOKUP
      - OPEN_CHANNEL
      - RCS
      - REGISTRATION
      - SMS
      - VIBER
      - VOICE_VIDEO
      - WEB_PUSH
      - WHATSAPP
      - ZALO
      title: SubscriptionChannel
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseMessage:
      type: object
      description: Array of message objects of a single message or multiple messages sent under one bulk ID.
      oneOf:
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessage'
      - $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessage'
      title: MessagesApiBaseMessage
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.ApiKey:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier specifying this api key.
        apiKeySecret:
          type: string
          description: Authentication key. Use this value for authentication on API. Keep this in secure storage and don't share it.
        accountId:
          type: string
          description: Unique identifier for account this API key belongs to.
        name:
          type: string
          description: Name of this API Key.
        allowedIPs:
          type: array
          description: List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.
          items:
            type: string
            description: List of allowed IP addresses from which this API key will be used. Authentication will fail from any other IP not specified in this list.
        validFrom:
          type: string
          format: date-time
          description: Date from which this API key is/will be valid. Time is in UTC.
        validTo:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC.
        enabled:
          type: boolean
          description: Is API key enabled.
        permissions:
          type: array
          description: List of permissions this API key has granted.
          items:
            type: string
            description: List of permissions this API key has granted.
          uniqueItems: true
        platform:
          type: array
          description: A collection of CPaaS X Applications and/or Entities associated with the API Key
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Platform'
        scopeGuids:
          type: array
          description: List of Scopes assigned to API Key
          items:
            type: string
            description: List of Scopes assigned to API Key
          uniqueItems: true
      required:
      - name
      title: ApiKey
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeUnit:
      type: string
      description: The  unit of time for the priority request.
      enum:
      - HOURS
      - DAYS
      title: PriorityTimeUnit
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageResourceOrderApiDoc:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            type: object
            description: The list of the results for this page.
            oneOf:
            - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc'
            - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc'
            - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc'
        paging:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.PageInfo'
      title: PageResourceOrderApiDoc
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateUploadRequest:
      type: object
      properties:
        certificateId:
          type: string
          description: Certificate's identifier. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.
          maxLength: 255
          minLength: 1
        certificateContent:
          type: string
          format: base64
          description: Content of a .pem file encoded in Base64 format.
        passphrase:
          type: string
          format: base64
          description: Certificate's passphrase encoded in Base64 format.
      required:
      - certificateContent
      - certificateId
      title: CertificateUploadRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents:
      type: string
      enum:
      - CLICK
      - DELIVERY
      - INBOUND_MESSAGE
      title: Event
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessage:
      type: object
      description: Represents a single template message.
      properties:
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel'
        sender:
          type: string
          description: The sender ID. It can be alphanumeric or numeric (e.g., `CompanyName`). Make sure you don't exceed [character limit](https://www.infobip.com/docs/sms/get-started#sender-names).
        destinations:
          type: array
          description: Array of destination objects for where messages are being sent. A valid destination is required. **`Channels Destination` is required when sending messages with defined failover.**
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageDestination'
        template:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplate'
        content:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent'
        options:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions'
        webhooks:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiWebhooks'
        failover:
          type: array
          description: Provides options for configuring a message failover. When message fails it will be sent over channels in order specified in an array. It has to contain unique entries per channel and it cannot contain entry with the same channel as original message. **Make sure to provide correct sender and destinations specified as `Channels Destination` for each channel**.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseFailover'
      required:
      - channel
      - destinations
      - template
      title: Messages API template message
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ConnectionTestResult:
      type: string
      description: Connection test result. Indicates whether the test to connection passed.
      enum:
      - SUCCESS
      - FAIL
      title: ConnectionTestResult
    96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiException:
      type: object
      properties:
        requestError:
          allOf:
          - $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiRequestError'
      title: ApiException
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - AI_CAMPAIGN_FEEDBACK
          example: AI_CAMPAIGN_FEEDBACK
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform'
      title: CampaignAiFeedbackWebhookMessage
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsRequirementSpecsRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - RCS_SENDER_LAUNCH
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        excludedCarriers:
          type: array
          description: List of carrier names excluded from the sender launch.
          items:
            type: string
            description: List of carrier names excluded from the sender launch.
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
      required:
      - countryCode
      - trafficOrigin
      - type
      title: RCS_SENDER_LAUNCH
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Web Push
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateSmsOrVoiceMessageRequest:
      type: object
      properties:
        language:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language'
          description: The language code which message is written in used when sending text-to-speech messages. If not defined, it will default to English (`en`).
          readOnly: false
          writeOnly: true
        messageText:
          type: string
          description: Content of the message being sent which contains at minimum one placeholder for a PIN code (`{{pin}}`). Placeholder format is `{{placeholderName}}`.
          readOnly: false
          writeOnly: true
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: true
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: Type of PIN code that will be generated and sent as part of 2FA message.
          readOnly: false
          writeOnly: true
        regional:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions'
          description: Region-specific parameters, often imposed by local laws. Use this, if country or region that you are sending a message to requires additional information.
          readOnly: false
          writeOnly: true
        repeatDTMF:
          type: string
          description: If the PIN is sent as a voice message, the DTMF code allows the recipient to replay the message.
          readOnly: false
          writeOnly: true
        senderId:
          type: string
          description: 'The name that will appear as the sender of the 2FA message (Example: CompanyName).'
          readOnly: false
          writeOnly: true
        speechRate:
          type: number
          format: double
          description: The speed of narration for messages sent as voice. Supported range is from `0.5` to `2`.
          readOnly: false
          writeOnly: true
        voiceName:
          type: string
          description: 'Defines the voice that will be used for the chosen language (example: Joanna). For each supported language, we may offer different voices (learn more [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages)). You can use this [method](https://www.infobip.com/docs/api/channels/voice/voice-message/get-voices) to retrieve all voices for the given language. If not defined, it will default to the standard voice for the selected language (if available). If the standard voice is not available, the request will fail. To avoid that, you can choose one of the neural voices (charges will apply).'
          readOnly: false
          writeOnly: true
      required:
      - messageText
      - pinType
      title: CreateSmsOrVoiceMessageRequest
    c477cb65646267e3f350bce7b433e9b56e5c28aa9ef21a75500a1337942923ba.Cnam:
      type: object
      properties:
        storage:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamStorage'
        delivery:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamDelivery'
      title: Cnam
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecs:
      type: object
      properties:
        requirements:
          type: array
          description: List of requirements needed for the resource request.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpec'
      title: RequirementSpecs
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelResponse:
      type: string
      description: The level of block configuration. If the value is <code>CUSTOM_NOT_EDITABLE</code>, then the value is not manageable by API.
      enum:
      - FROM_SENDER
      - FROM_ANY_SENDER
      - CUSTOM_NOT_EDITABLE
      title: BlockLevelResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - BRAND_STATUS_UPDATE
          example: BRAND_STATUS_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform'
      title: BrandRegistrationWebhookMessage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleZaloEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Zalo
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderApiDoc:
      type: object
      discriminator:
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderApiDoc'
      title: ResourceOrderApiDoc
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType:
      type: string
      description: Type of client. LOCAL resolves numbers preferring local options, falling back to international if none are available. INTERNATIONAL and null resolve international numbers only.
      enum:
      - LOCAL
      - INTERNATIONAL
      title: NumberOfferClientType
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent:
      type: object
      description: Array of event objects of a single event or multiple events sent
      discriminator:
        propertyName: event
        mapping:
          TYPING_STARTED: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStartedEvent'
          TYPING_STOPPED: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundTypingStoppedEvent'
          SEEN: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundSeenEvent'
      properties:
        event:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEventType'
      required:
      - event
      title: MessagesApiOutboundEvent
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType:
      type: string
      description: Call-to-action promotion method type
      enum:
      - OUTDOOR
      - POS
      - PRINT
      - RADIO
      - TV
      - WEB
      title: PromotionMethodType
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TimeBucket:
      type: string
      enum:
      - SECONDS_0
      - SECONDS_1
      - SECONDS_2
      - SECONDS_3
      - SECONDS_4
      - SECONDS_5
      - SECONDS_10
      - SECONDS_15
      - SECONDS_20
      - SECONDS_25
      - SECONDS_30
      - SECONDS_40
      - SECONDS_50
      - MINUTES_1
      - MINUTES_2
      - MINUTES_3
      - MINUTES_4
      - MINUTES_5
      - MINUTES_10
      - MINUTES_15
      - MINUTES_20
      - MINUTES_25
      - MINUTES_30
      - MINUTES_45
      - HOURS_1
      - HOURS_6
      - HOURS_12
      - HOURS_18
      - DAYS_1
      - DAYS_2
      - DAYS_3
      title: TimeBucket
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResponse:
      type: object
      description: Response containing the request UUID for tracking the started campaign builder
      properties:
        requestUuid:
          type: string
          format: uuid
          description: Unique identifier for this campaign builder.
      title: CampaignBuilderResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Apple Messages For Business
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.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
    66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.BalanceInfoResponse:
      type: object
      properties:
        balance:
          type: number
        allowedMinus:
          type: number
        monthlyLimit:
          type: number
        monthlyBalance:
          type: number
        currency:
          $ref: '#/components/schemas/66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.SimpleCurrencyInfo'
        freeMessages:
          type: object
          additionalProperties:
            type: integer
            format: int32
      title: BalanceInfoResponse
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.UpdateCatalogDto:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: Catalog name.
          example: CatalogName
        description:
          type:
          - string
          - 'null'
          description: Catalog description.
          example: Just a description
      title: UpdateCatalogDto
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnInfo:
      type: object
      description: Information about columns returned in response.
      properties:
        columnName:
          type: string
          description: Name of the column.
        columnDataType:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnDataType'
      required:
      - columnDataType
      - columnName
      title: ColumnInfo
    6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnCheckResponse:
      type: object
      description: Trusted MSISDN check response object.
      properties:
        exists:
          type: boolean
          description: Whether the provided phone number exists in the trusted MSISDN list.
      title: TrustedMsisdnCheckResponse
    17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationResponse:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service, e.g. 2FA for login, 2FA for changing the password, etc.
          readOnly: true
          writeOnly: false
        configuration:
          allOf:
          - $ref: '#/components/schemas/17363474057d152577564d8587b079aa7bdd070a3f49746aea3319eb57a5830c.ApplicationConfiguration'
          description: Created 2FA application configuration.
          readOnly: true
          writeOnly: false
        enabled:
          type: boolean
          description: Indicates whether the created application is enabled.
          readOnly: true
          writeOnly: false
        name:
          type: string
          description: 2FA application name.
          readOnly: true
          writeOnly: false
      title: ApplicationResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundMoGetEndpointChannel:
      type: string
      enum:
      - APPLE_MB
      - MESSENGER
      - MMS
      - SMS
      - VIBER_BM
      - WHATSAPP
      title: InboundMoGetEndpointChannel
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.KeywordOptIn:
      type: object
      description: The type of opt in that requires a user to type in a keyword.
      properties:
        callToAction:
          type: string
          description: "    The message sent to the user to tell them how to subscribe. Must include:\n    • Product description\n    • Message frequency disclosure\n    • Complete terms and conditions OR link to complete terms and conditions\n    • Privacy policy OR link to privacy policy\n    • STOP keyword\n    • The \"Message and data rates may apply\" disclosure\n"
          maxLength: 1024
          minLength: 20
        keywords:
          type: array
          description: The keyword(s) the user will text to subscribe. Keyword(s) must include only uppercase letters and numbers.
          items:
            type: string
            description: The keyword(s) the user will text to subscribe. Keyword(s) must include only uppercase letters and numbers.
            pattern: '[A-Z0-9]+'
      required:
      - callToAction
      - keywords
      title: KeywordOptIn
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventType:
      type: string
      description: Blocklist event type.
      enum:
      - BLOCK
      - UNBLOCK
      title: BlocklistEventType
    b1075107f5bba728f6a701eb8a72357dfcf0d9c4405dd06e85e56496153a8d2f.TokenResponse:
      type: object
      description: Successful response that indicates OAuth2 token was created.
      properties:
        access_token:
          type: string
          description: OAuth2 token.
        expires_in:
          type: integer
          format: int32
          description: OAuth2 token expiration in seconds.
        token_type:
          type: string
          description: OAuth2 token type.
      title: TokenResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyCertificateResponse:
      type: object
      properties:
        certificateId:
          type: string
          description: Certificate identifier.
      title: IdOnlyCertificateResponse
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Action:
      type: string
      description: An optional action performed for an API request authenticated by this specific API key. The `FILL` option is used when an API endpoint inserts linked Application and Entity IDs into a request, if missing. The `FORCE` option is used when an API endpoint overrides linked Application and Entity IDs with the ones from this platform. If the action is left blank, the API endpoint will only perform an authorization check without injecting values into the request.
      enum:
      - FILL
      - FORCE
      title: Action
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address:
      type: object
      description: Address of an Emergency Service.
      properties:
        name:
          type: string
          description: Emergency Service address name.
          maxLength: 100
          minLength: 0
        streetName:
          type: string
          description: Emergency Service address street.
          maxLength: 100
          minLength: 0
        streetNumber:
          type: string
          description: Emergency Service address street number.
          maxLength: 20
          minLength: 0
        city:
          type: string
          description: Emergency Service address city.
          maxLength: 50
          minLength: 0
        countryCode:
          type: string
          description: Emergency Service address country code.
          maxLength: 2
          minLength: 2
        stateCode:
          type: string
          description: Emergency Service address state code.
          maxLength: 2
          minLength: 2
        zipCode:
          type: string
          description: Emergency Service address zip code.
          maxLength: 10
          minLength: 5
        direction:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Direction'
        suite:
          type: string
          description: Emergency Service address suite.
      required:
      - city
      - countryCode
      - name
      - stateCode
      - streetName
      - streetNumber
      - zipCode
      title: Address
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeZoneResponse:
      type: string
      description: Sending time zone. If the value is <code>CUSTOM_NOT_EDITABLE</code>, then the value is not manageable by API.
      enum:
      - USER_TIME_ZONE
      - DESTINATION_TIME_ZONE
      - CUSTOM_NOT_EDITABLE
      title: DeliveryTimeZoneResponse
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealsResponse:
      type: object
      description: Response containing the list of all appeals submitted for a brand.
      properties:
        appeals:
          type: array
          description: List of appeals submitted for the brand, ordered from most recent to oldest.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealPreview'
      title: BrandAppealsResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMobilePushEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Mobile Push
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: AgentOS
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistDelete:
      type: object
      description: Blocklist.
      properties:
        destinations:
          type: array
          description: Destination addresses that need to be removed from blocklist.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.ToDelete'
        sender:
          type: string
          description: The sender ID that needs to be removed from blocklist. Sender can be alphanumeric or numeric.
          maxLength: 255
          minLength: 1
        channel:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.DeletableChannel'
        accountKey:
          type: string
          description: Account for which blocklist record/s will be removed. Main account can remove blocklist record/s for their subaccounts. Subaccounts can remove blocklist record/s specific to them. [API to retrieve account key](https://www.infobip.com/docs/api/platform/account-management/get-all-accounts).
        sourceType:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.SourceType'
      required:
      - destinations
      title: BlocklistDelete
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.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
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Priority:
      type: object
      properties:
        priorityId:
          type: string
          format: uuid
          description: The ID for the campaign priority.
        dailySubmitLimit:
          type: integer
          format: int32
          description: The limit on how many campaigns you can submit a day with this priority.
        reviewTime:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeData'
        priorityType:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityType'
      title: Priority
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.SmsOrVoiceMessage:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service (e.g. 2FA for login, 2FA for changing the password, etc.) for which the requested message has been created.
          readOnly: false
          writeOnly: false
        language:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language'
          description: The language code which message is written in used when sending text-to-speech messages. If not defined, it will default to English (`en`).
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
          readOnly: false
          writeOnly: false
        messageText:
          type: string
          description: Text of a message that will be sent. Message text must contain `pinPlaceholder`.
          readOnly: false
          writeOnly: false
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: false
        pinPlaceholder:
          type: string
          description: The PIN code placeholder that will be replaced with a generated PIN code.
          readOnly: false
          writeOnly: false
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: The type of PIN code that will be generated and sent as part of 2FA message. You can set PIN type to numeric, alpha, alphanumeric or hex.
          readOnly: false
          writeOnly: false
        regional:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions'
          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.
          readOnly: false
          writeOnly: false
        repeatDTMF:
          type: string
          description: In case PIN message is sent by Voice, DTMF code will enable replaying the message.
          readOnly: false
          writeOnly: false
        senderId:
          type: string
          description: 'The name that will appear as the sender of the 2FA message (Example: CompanyName).'
          readOnly: false
          writeOnly: false
        speechRate:
          type: number
          format: double
          description: In case PIN message is sent by Voice, the speed of speech can be set for the message. Supported range is from `0.5` to `2`.
          readOnly: false
          writeOnly: false
        voiceName:
          type: string
          description: 'Defines the voice that will be used for the chosen language (example: Joanna). For each supported language, we may offer different voices (learn more [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages)). You can use this [method](https://www.infobip.com/docs/api/channels/voice/voice-message/get-voices) to retrieve all voices for the given language. If not defined, it will default to the standard voice for the selected language (if available). If the standard voice is not available, the request will fail. To avoid that, you can choose one of the neural voices (charges will apply).'
          readOnly: false
          writeOnly: true
      title: SmsOrVoiceMessage
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfigurations:
      type: object
      properties:
        configurations:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsConfiguration'
        totalCount:
          type: integer
          format: int32
      title: MmsConfigurations
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody:
      type: object
      description: Body of a template message.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateTextBody'
          CAROUSEL: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCarouselBody'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBodyType'
      required:
      - type
      title: MessagesApiTemplateBody
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber:
      type: object
      description: List of numbers linked with the resource.
      properties:
        number:
          type: string
          description: Number.
        numberKey:
          type: string
          description: Unique ID of a number.
        status:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberStatus'
      required:
      - number
      - status
      title: ProcuredNumber
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.EmailMessage:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service (e.g. 2FA for login, 2FA for changing the password, etc.) for which the requested message has been created.
          readOnly: false
          writeOnly: false
        emailTemplateId:
          type: integer
          format: int64
          description: Email template ID that should reference a previously created Email template.
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: The sender of the 2FA message, an email address with an optional sender name (e.g. `company@example.com` or `Jane Smith <jane.smith@somecompany.com>`).
          readOnly: false
          writeOnly: false
        landingPageId:
          type: string
          description: Opt out landing page ID that should reference a previously created landing page template.
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
          readOnly: false
          writeOnly: false
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: false
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: The type of PIN code that will be generated and sent as part of 2FA message. You can set PIN type to numeric, alpha, alphanumeric or hex.
          readOnly: false
          writeOnly: false
      title: EmailMessage
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumbersResponse:
      type: object
      properties:
        numbers:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse'
        numberCount:
          type: integer
          format: int64
      title: NumbersResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriodTimeUnit:
      type: string
      default: MINUTES
      description: Message validity period time unit.
      enum:
      - SECONDS
      - MINUTES
      - HOURS
      title: ValidityPeriodTimeUnit
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FieldType:
      type: string
      description: Type of the requirement.
      enum:
      - TEXT
      - INTEGER
      - EMAIL
      - URL
      - GSM
      - DOCUMENT
      title: FieldType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: RCS
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleFacebookEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareFacebookEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Facebook
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AttachNumberPoolRequest:
      type: object
      properties:
        numberPoolId:
          type: string
          description: 'Unique identifier of the number pool to be used for this campaign. If not provided, a default number pool will be automatically assigned. '
          maxLength: 100
          minLength: 1
        reason:
          type: string
          description: A concise explanation of why this campaign requires a dedicated number pool. Include operational or regulatory justifications, such as high-volume messaging, the use of multiple sender identities, or throughput guarantees.
          maxLength: 1000
          minLength: 1
      title: AttachNumberPoolRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiSeenResult:
      type: object
      description: Collection of reports, one per every message.
      properties:
        event:
          type: string
          default: SEEN
          description: Event type (seen report in this case).
        channel:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundSeenChannel'
        sender:
          type: string
          description: The sender ID which can be alphanumeric or numeric (e.g., `CompanyName`).
        destination:
          type: string
          description: Message destination address.
        sentAt:
          type: string
          description: 'Tells when the message was sent. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        seenAt:
          type: string
          description: 'Tells when the message was seen. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`.'
        bulkId:
          type: string
          description: The ID that uniquely identifies the request.
        messageId:
          type: string
          description: The ID that uniquely identifies the received message.
        callbackData:
          type: string
          description: Value of the `callbackData` field from the MT message (if exists) or from the MO Action setup (if exists).
        platform:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform'
        campaignReferenceId:
          type: string
          description: ID of a campaign that was sent in the message.
      required:
      - bulkId
      - channel
      - destination
      - event
      - messageId
      - seenAt
      - sender
      - sentAt
      title: MessagesApiSeenResult
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.PageResponse:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssV2'
        paging:
          $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.PageInfo'
      required:
      - paging
      - results
      title: PageResponse
    6ac22f6f3346b6db1d4c8464d58b1329c30df516bb4206699a93fd8658df38c7.TrustedMsisdnRequest:
      type: object
      description: Trusted MSISDN request object.
      properties:
        phoneNumbers:
          type: array
          description: Phone numbers (in MSISDN or international format) to add to or remove from the trusted MSISDN list.
          items:
            type: string
            example: '3851235678'
      required:
      - phoneNumbers
      title: TrustedMsisdnRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse:
      type: object
      properties:
        certificateId:
          type: string
          description: Certificate's identifier.
        issuedBy:
          type: string
          description: Certificate's Issuer information.
        issuedTo:
          type: string
          description: Certificate's Subject information.
        validFrom:
          type: integer
          format: int64
          description: Date and time from which the certificate is valid (milliseconds since the UNIX epoch).
        validUntil:
          type: integer
          format: int64
          description: Date and time until which the certificate is valid (milliseconds since the UNIX epoch).
        certificateStatus:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus'
        serialNumber:
          type: string
          description: A certificate's serial number.
      title: CertificateDetailsResponse
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageQueryOptions:
      type: object
      description: "\nOptional settings that control data completeness, such as whether to include billing data where volumes have\nnot yet been finalized.\n        "
      properties:
        includeUnfinalizedData:
          type: boolean
          default: true
          description: "\nControls whether to include billing data where volumes have not yet been finalized. Set to `true` to include the\nlatest unfinalized data, or `false` to return only finalized billing data.\n        "
      title: BillingUsageQueryOptions
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents:
      type: string
      enum:
      - APPLICATION_TRANSFER_FAILED
      - APPLICATION_TRANSFER_FINISHED
      - APPLICATION_TRANSFER_REQUESTED
      - BULK_CALL_STATUS
      - CALL_DISCONNECTED
      - CALL_ESTABLISHED
      - CALL_FAILED
      - CALL_FINISHED
      - CALL_MEDIA_CHANGED
      - CALL_PRE_ESTABLISHED
      - CALL_RECEIVED
      - CALL_RECONNECTED
      - CALL_RECORDING_DELETED
      - CALL_RECORDING_FAILED
      - CALL_RECORDING_READY
      - CALL_RECORDING_STARTED
      - CALL_RECORDING_STOPPED
      - CALL_RINGING
      - CALL_STARTED
      - CONFERENCE_COMPOSITION_FAILED
      - CONFERENCE_COMPOSITION_FINISHED
      - CONFERENCE_CREATED
      - CONFERENCE_FINISHED
      - CONFERENCE_RECORDING_DELETED
      - CONFERENCE_RECORDING_FAILED
      - CONFERENCE_RECORDING_READY
      - CONFERENCE_RECORDING_STARTED
      - CONFERENCE_RECORDING_STOPPED
      - DELIVERY
      - DIALOG_COMPOSITION_FAILED
      - DIALOG_COMPOSITION_FINISHED
      - DIALOG_CREATED
      - DIALOG_ESTABLISHED
      - DIALOG_FAILED
      - DIALOG_FINISHED
      - DIALOG_RECORDING_DELETED
      - DIALOG_RECORDING_FAILED
      - DIALOG_RECORDING_READY
      - DIALOG_RECORDING_STARTED
      - DIALOG_RECORDING_STOPPED
      - DIALOG_TRANSFER_FAILED
      - DIALOG_TRANSFER_FINISHED
      - DIALOG_TRANSFER_REQUESTED
      - DTMF_CAPTURED
      - ERROR
      - MACHINE_DETECTION_FAILED
      - MACHINE_DETECTION_FINISHED
      - MACHINE_MESSAGE_DETECTION_FAILED
      - MACHINE_MESSAGE_DETECTION_FINISHED
      - MEDIA_STREAM_FAILED
      - MEDIA_STREAM_FINISHED
      - MEDIA_STREAM_STARTED
      - MISSED_CALL
      - NUMBER_MASKING
      - PARTICIPANT_JOINED
      - PARTICIPANT_JOINING
      - PARTICIPANT_JOIN_FAILED
      - PARTICIPANT_MEDIA_CHANGED
      - PARTICIPANT_RECORDING_FAILED
      - PARTICIPANT_REMOVED
      - PARTICIPANT_ROLE_CHANGED
      - PARTICIPANT_ROLE_CHANGE_FAILED
      - PARTICIPANT_STARTED_TALKING
      - PARTICIPANT_STOPPED_TALKING
      - PLAY_FINISHED
      - SAY_FINISHED
      - SILENT_VERIFICATION_DELIVERY
      - SPEECH_CAPTURED
      - TRANSCRIPTION
      title: Event
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.Direction:
      type: string
      description: "\nSpecifies the direction of traffic, indicating whether the message was sent to the user (OUTBOUND) or received from the user (INBOUND).\n    "
      enum:
      - OUTBOUND
      - INBOUND
      title: Direction
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        displayName:
          type: string
          description: Display name.
          example: MyDisplayName
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Apple
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo:
      type: object
      description: Priority information used in latest campaign review.
      properties:
        priorityId:
          type: string
          format: uuid
          description: Id of a priority
        submittedDate:
          type: string
          format: date-time
          description: Date submitted for review
      title: PriorityInfo
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageResult:
      type: object
      properties:
        requestId:
          type: string
          description: Identifier of the original request, returned by [Query billing usage data](#platform/billing-usage/query-billing-usage) endpoint.
        status:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataStatus'
        response:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataResponse'
        failureMessage:
          type: string
          description: Message describing the failure. Returned only if the request failed.
        metadata:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadata'
      required:
      - requestId
      - status
      title: BillingUsageResult
    66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.FreeMessagesResponse:
      type: object
      properties:
        remainingCount:
          type: integer
          format: int32
      title: FreeMessagesResponse
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Priority:
      type: object
      description: Priorities of the senders that can be defined in case there is more than one sender for a destination country.
      properties:
        senderType:
          $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SenderType'
        priority:
          type: integer
          format: int32
          description: Priority of sender type, from 1 to a maximum of 4. Lower number means higher priority.
          example: 1
          maximum: 4
          minimum: 1
      required:
      - priority
      - senderType
      title: Priority
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignNetworkStatusWebhookContent:
      type: object
      description: Event content.
      properties:
        campaignId:
          type: string
          format: uuid
          description: The ID of campaign.
          example: 38a1c2c6-55f2-11ee-a061-325096b39f47
        campaignNetwork:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignRegistrar'
        campaignNetworkStatus:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookCampaignNetworkStatus'
      title: CampaignNetworkStatusWebhookContent
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestResponse:
      type: object
      properties:
        certificateId:
          type: string
          description: Existing certificate identifier.
        webhookUrl:
          type: string
          description: A webhook URL over which a connectivity test will be performed.
        result:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ConnectionTestResult'
        failReasons:
          type: array
          description: Contains reasons why the connection test was failed.
          items:
            type: string
            description: Contains reasons why the connection test was failed.
        hint:
          type: string
          description: Contains a hint how the client can fix the errors.
      title: CertificateConnectionTestResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationResponse:
      type: object
      description: Response for configuring MO resource.
      properties:
        configurationKey:
          type: string
          description: The key of a stored configuration.
          example: E9FCDCA496035F08EEA5933702EDF745
        channel:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType'
        keyword:
          type: string
          description: Configuration keyword.
          example: STARTKW
        username:
          type: string
          description: Configuration username.
          example: myusername
        platform:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PlatformDocs'
        forwarding:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs'
        conversations:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversations'
        answers:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers'
        autoResponse:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Response'
        blockListConfiguration:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationResponse'
      required:
      - configurationKey
      title: MoConfigurationResponse
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.BillingUsageMetadataPeriod:
      type: object
      description: Metadata for each covered calendar month.
      properties:
        month:
          type: string
          description: Calendar month in yyyy-MM format.
          example: 2026-03
        volumeFinalized:
          type: boolean
          description: Indicates whether the billing data for this month has been fully processed and no further volume changes are expected.
      required:
      - month
      - volumeFinalized
      title: BillingUsageMetadataPeriod
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAuthUpdateWebhookContent:
      type: object
      description: Event content.
      properties:
        brandId:
          type: string
          format: uuid
          description: The ID of the brand.
          example: 0579c038-55f2-11ee-9458-325096b39f47
        brandAuthUpdate:
          type: string
          description: The new brand auth 2FA update.
          enum:
          - BRAND_EMAIL_2FA_SEND
          - BRAND_EMAIL_2FA_COMPLETE
          example: BRAND_EMAIL_2FA_SEND
      title: BrandAuthUpdateWebhookContent
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderRequestApiDoc:
      type: object
      discriminator:
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaResourceOrderRequestApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderRequestApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderRequestApiDoc'
      title: ResourceOrderRequestApiDoc
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareSmsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: SMS
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOptions:
      type: object
      description: Message options.
      properties:
        platform:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform'
        validityPeriod:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod'
        deliveryTimeWindow:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTimeWindow'
        adaptationMode:
          type: boolean
          default: true
          description: If channel does not fully support message to be sent, we will try to map it as best effort. This is default behavior, even if this option is not specified.
        regional:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RegionalOptions'
        campaignReferenceId:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        transliteration:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TransliterationCode'
        correlationData:
          type: string
          description: Correlation data included in the outbound message. If provided, it will be returned in the inbound message. Auto-generated if not set explicitly.
          maxLength: 100
          minLength: 1
        trafficType:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTrafficType'
        sessionRate:
          type: boolean
          description: Defines if the message should be charged using session rate. Supported by Viber for content with text/image/document only (without buttons, extra text etc.) body type. For text/image only body types `sessionRate` won't be applied if parameter `primaryDevice` is set to true.
        primaryDevice:
          type: boolean
          description: Defines if the message should be sent only to the end user's primary device (phone or tablet). Supported by Viber for message with content with text/image/document only (without buttons, extra text etc.) body type or template message.
      title: MessagesApiMessageOptions
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalAutomaticReviewError:
      type: object
      description: List of compliance errors found during the AI campaign review. Empty when the review is still processing or the campaign is compliant.
      properties:
        code:
          type: string
          description: The error code identifying the type of compliance issue.
        justification:
          type: string
          description: The justification for why this was flagged as a compliance issue.
        description:
          type: string
          description: Description of the compliance issue.
        recommendation:
          type: string
          description: The recommended action to resolve the compliance issue.
      title: ExternalAutomaticReviewError
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealRequest:
      type: object
      description: Request body for submitting a brand appeal.
      properties:
        explanation:
          type: string
          description: Optional explanation supporting the appeal. Maximum 1024 characters.
          maxLength: 1024
          minLength: 0
        documents:
          type: array
          description: List of supporting documents attached to the appeal.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealDocument'
          maxItems: 10
          minItems: 1
      required:
      - documents
      title: BrandAppealRequest
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SssV2:
      type: object
      description: The list of the results for this page.
      properties:
        sendingStrategyId:
          type: string
          description: Id of the Sending strategy.
          example: 78D8394AC3EG0460B4CF0E723FC31B49
        platform:
          $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Platform'
        channel:
          type: string
          description: 'Channel for which the Sending Strategy is created. Supported channels: SMS, MMS, RCS. If left empty, Sending Strategy will be applied to all supported channels.'
          example: SMS
        destinationCountryCode:
          type: string
          description: Country code, in two-letter ISO standard, of the country the messages are terminating to for which the Sending Strategy will be used. If left empty, Sending Strategy will attempt to be used for all the countries where you have senders provisioned.
          example: US
        useStickySender:
          type: boolean
          description: If true, the same sender will be used for any subsequent interactions with the end user (inside one country).
          example: false
        useGeolocatedSender:
          type: boolean
          description: If true, the sender will be selected from the list of senders based on the nearest local area code. Supported for US and CA for now.
          example: false
        priorities:
          type: array
          description: Priorities of the senders that can be defined in case there is more than one sender for a destination country.
          items:
            $ref: '#/components/schemas/5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.Priority'
      required:
      - sendingStrategyId
      - useGeolocatedSender
      - useStickySender
      title: SssV2
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoBrandMessageEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Kakao Brand Message
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeader:
      type: object
      description: Header of the message.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextHeader'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageHeaderType'
      required:
      - type
      title: MessagesApiMessageHeader
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriod:
      type: object
      description: Message validity period. Once expired, the message won't be sent. Validity period longer than 48h is not supported. If exceeded, it will be automatically set to 48h. Minimal value is 10 seconds.
      properties:
        amount:
          type: integer
          format: int32
          description: Message validity period's value. If `timeUnit` is not set, it will default to `MINUTES`.
        timeUnit:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidityPeriodTimeUnit'
      required:
      - amount
      title: ValidityPeriod
    5929f45c31f06c29ab1bc6e26caa01575484225e5ef99a2512bee829b646f1c1.SendingStrategyId:
      type: object
      properties:
        sendingStrategyId:
          type: string
          description: Id of the sending strategy.
          example: 78D8394AC3EG0460B4CF0E723FC31B49
      required:
      - sendingStrategyId
      title: SendingStrategyId
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberTypeResourceMoDocs:
      type: string
      description: Number type.
      enum:
      - VIRTUAL_LONG_NUMBER
      - SHORT_CODE
      example: VIRTUAL_LONG_NUMBER
      title: NumberTypeResourceMoDocs
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsSenderResourceOrderRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - RCS_SENDER_LAUNCH
        senderName:
          type: string
          description: Sender name.
          maxLength: 255
          minLength: 1
        additionalContactEmails:
          type: array
          description: Email addresses that would be contacted by Infobip support team for any request related matter.
          items:
            type: string
            description: Email addresses that would be contacted by Infobip support team for any request related matter.
          maxItems: 3
          minItems: 0
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        excludedCarriers:
          type: array
          description: List of carrier names excluded from the sender launch.
          items:
            type: string
            description: List of carrier names excluded from the sender launch.
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      required:
      - countryCode
      - requirements
      - senderName
      - trafficOrigin
      - type
      title: RCS_SENDER_LAUNCH
    40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.SearchResult:
      type: object
      additionalProperties: false
      properties:
        action:
          type:
          - string
          - 'null'
          description: User's action.
        description:
          type:
          - string
          - 'null'
          description: Description of an action.
        id:
          type:
          - string
          - 'null'
          description: Unique ID of an action.
        ipAddress:
          type:
          - string
          - 'null'
          description: User's IP Address.
        item:
          type:
          - string
          - 'null'
          description: Entity on which action is executed.
        timestamp:
          type: string
          format: date-time
          description: Exact time when user executed an action.
        username:
          type:
          - string
          - 'null'
          description: Username of the user who executed the action.
      title: SearchResult
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessageResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming messages
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent'
        messageCount:
          type: integer
          format: int32
          description: The number of messages returned in the `results` array.
        pendingMessageCount:
          type: integer
          format: int32
          description: The number of messages that have not been pulled in.
      required:
      - results
      title: MessagesApiIncomingMessageResponse
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageRequest:
      type: object
      properties:
        callbackUrl:
          type: string
          description: "\nTarget URL to receive the query processing results. For schema details, see:\n[Receive billing usage result](#platform/billing-usage/receive-billing-usage-result).\n        "
        request:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryBillingUsageApiRequest'
      required:
      - callbackUrl
      - request
      title: QueryBillingUsageRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiIncomingMessage:
      type: object
      properties:
        results:
          type: array
          description: Incoming messages
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiInboundEvent'
      required:
      - results
      title: MessagesApiIncomingMessage
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseAnswers:
      type: object
      description: Used for forwarding messages to Answers service.
      externalDocs:
        description: Find out more about Answers
        url: https://www.infobip.com/docs/answers
      properties:
        enabled:
          type: boolean
          description: Flag which indicates if this action should be enabled. If set to false, the effect will be the same as adding the answers to unset which will remove the object.
          example: true
      required:
      - enabled
      title: UseAnswers
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandWebhookPlatform:
      type: object
      description: Platform properties.
      properties:
        applicationId:
          type: string
          description: Brand application id.
          example: application-id
        entityId:
          type: string
          description: Brand entity id.
          example: entity-id
      title: BrandWebhookPlatform
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.TurkeyIysOptions:
      type: object
      description: IYS regulations specific parameters required for sending promotional SMS to phone numbers registered in Turkey.
      properties:
        brandCode:
          type: integer
          format: int32
          description: Brand code is an ID of the company based on a company VAT number. If not provided in request, default value is used from your Infobip account.
        recipientType:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RecipientType'
      required:
      - recipientType
      title: TurkeyIysOptions
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability:
      type: string
      description: Capabilities of the numbers.
      enum:
      - SMS
      - VOICE
      - MMS
      title: ResourceNumberCapability
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDoc:
      type: object
      description: Object containing event data.
      properties:
        id:
          type: string
          description: ID of the resource request.
        status:
          type: string
          description: Status of the resource request.
          enum:
          - UPDATE_REQUESTED
          - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
        type:
          type: string
          description: Type of resource.
          enum:
          - ALPHANUMERIC_REGISTRATION
          - NUMBER_PURCHASE
          - RCS_SENDER_LAUNCH
        daysUntilRejection:
          type: integer
          format: int32
          description: Number of days remaining before the resource request is automatically rejected due to inactivity.
      required:
      - daysUntilRejection
      - id
      - status
      - type
      title: WebhookReminderNotifApiDoc
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo:
      type: object
      description: Contains information about the page.
      properties:
        page:
          type: integer
          format: int32
        size:
          type: integer
          format: int32
        totalPages:
          type: integer
          format: int32
        totalResults:
          type: integer
          format: int64
      title: PageInfo
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.FacebookCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        displayName:
          type: string
          description: Display name.
          example: MyDisplayName
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Facebook
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDocResult:
      type: object
      description: List of events provided in a single request.
      properties:
        event:
          type: string
          description: Name of event that is received.
          enum:
          - RESOURCE_REQUEST_REMINDER
        content:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookReminderNotifApiDoc'
      required:
      - content
      - event
      title: WebhookReminderNotifApiDocResult
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfiguration:
      type: object
      properties:
        keyword:
          type: string
          description: Configuration keyword.
          maxLength: 50
          minLength: 0
        action:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction'
        useConversation:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation'
        otherActionsDetails:
          type: array
          description: List of other configured actions on this keyword. Ignored in POST/PUT calls.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction'
          readOnly: true
        otherActions:
          type: array
          description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
          items:
            type: string
            description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
            readOnly: true
          readOnly: true
        applicationId:
          type: string
          description: ID of the Application that would be associated with the configuration.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the configuration.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
      required:
      - action
      title: MoConfiguration
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeData:
      type: object
      properties:
        timeUnit:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityTimeUnit'
        amount:
          type: integer
          format: int32
          description: The amount of time unit.
      title: PriorityTimeData
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrationWebhookMessage'
      title: BrandRegistrationWebhookResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceActionDetails:
      type: object
      description: Voice action configuration.
      discriminator:
        propertyName: type
        mapping:
          VOICE_NUMBER_MASKING: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceNumberMaskingActionDetails'
          FORWARD_TO_IVR: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToIvrActionDetails'
          VOICE_FORWARD_TO_CONVERSATIONS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToConversationsDetails'
          FORWARD_TO_SUBSCRIPTION: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToSubscriptionDetails'
          FORWARD_TO_CALL_ROUTING: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToCallRoutingDetails'
          FORWARD_TO_PSTN: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToPstnActionDetails'
          VOICE_FORWARD_TO_ANSWERS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceForwardToAnswersDetails'
          FORWARD_TO_MARKUP_LANGUAGE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ForwardToMarkupLanguageDetails'
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType'
        description:
          type: string
          description: Additional action description.
      title: VoiceActionDetails
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AutoResponseActionV2Response:
      type: object
      description: Auto-response action configuration.
      example:
        message: Thank you for your message.
        sender: MyAutoResponseSender
        deliveryTimeWindow:
          from: 08:35
          to: '16:35'
          days:
          - MONDAY
          - TUESDAY
          - WEDNESDAY
          - THURSDAY
          - FRIDAY
          deliveryTimeZone: USER_TIME_ZONE
      properties:
        message:
          type: string
          description: Text that will be sent as a response message.
        sender:
          type: string
          description: If set, it will override the sender of the message in autoresponse sent to the user.
        deliveryTimeWindow:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DeliveryTimeWindowResponse'
      required:
      - message
      title: AutoResponseActionV2Response
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ReviewSubmissionResponse:
      type: object
      description: Response containing the request UUID for tracking the AI review submission
      properties:
        requestUuid:
          type: string
          format: uuid
          description: Unique identifier for this AI review request.
      title: ReviewSubmissionResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Number Lookup
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateTimeInterval:
      type: object
      properties:
        sentSince:
          type: string
          format: date-time
          description: Start of the sent traffic date-time period (inclusive).
          example: '2023-04-01T00:00:00Z'
        sentUntil:
          type: string
          format: date-time
          description: End of the sent traffic date-time period (exclusive).
          example: '2023-04-01T00:00:00Z'
      required:
      - sentSince
      - sentUntil
      title: DateTimeInterval
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatusResponse'
        paging:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo'
      title: CertificateStatusPage
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResult:
      type: object
      description: Response containing the campaign builder job status and result.
      properties:
        status:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultStatus'
        result:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData'
        error:
          type: string
          description: Error message. Present only when status is FAILED.
      title: CampaignBuilderResult
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateDetailsResponse'
        paging:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo'
      title: CertificateDetailsPage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRcsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: RCS
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceInfo:
      type: object
      description: Information about Open Channel type of resource.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        capabilities:
          type: array
          description: Capabilities of the sender.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Open Channel
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.JsonNode:
      type: object
      description: The value of the requirement. Can be a string, integer, or a list of strings and integers.
      title: JsonNode
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.Platform:
      type: object
      description: Platform options. For more details, see [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
      properties:
        entityId:
          type: string
          description: Used when specifying an entity in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
        applicationId:
          type: string
          description: Used when specifying an application in outbound send requests. It is also returned in notification events. For detailed usage, refer to the [documentation](https://www.infobip.com/docs/cpaas-x/application-and-entity-management).
          maxLength: 255
          minLength: 0
      title: Platform
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest'
      - type: object
        properties:
          campaignAttributes:
            type: array
            description: Campaign attributes indicating special content characteristics.
            items:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes'
            uniqueItems: true
      description: Request to start building 10DLC campaign using AI assistant.
      required:
      - brandId
      - campaignIntent
      - campaignType
      - contactEmail
      - optInMethods
      title: TenDlcCampaignBuilderRequest
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType:
      type: string
      description: The type of resource to be used.
      enum:
      - NUMBER
      - DOMAIN
      - ALPHA
      - RCS_RESOURCE
      - APPLE_RESOURCE
      title: ResourceType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleOpenChannelEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareOpenChannelEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Open Channel
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AppealRequest:
      type: object
      properties:
        reason:
          type: string
          description: The reason for the appeal.
          maxLength: 2048
          minLength: 10
      required:
      - reason
      title: AppealRequest
    96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiRequestError:
      type: object
      properties:
        serviceException:
          allOf:
          - $ref: '#/components/schemas/96ea7b6cea267e43daadde063d93b8799cdb795baa0e9344573e0f63283595e0.ApiRequestErrorDetails'
      title: ApiRequestError
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleEmailEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Email
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Viber
    66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.AccountBalance:
      type: object
      properties:
        balance:
          type: number
        currency:
          type: string
      title: AccountBalance
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesResponse:
      type: object
      description: Response containing information about IB resources.
      properties:
        results:
          type: array
          description: List of resources.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceInfo'
        paging:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PageInfo'
      title: IbResourcesResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionDocs:
      type: object
      description: Forwarding MO action.
      discriminator:
        propertyName: type
        mapping:
          HTTP_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.HttpForwardActionDocs'
          MAIL_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MailForwardActionDocs'
          SMPP_FORWARD: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmppForwardActionDocs'
          PULL: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.PullActionDocs'
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoActionType'
      required:
      - type
      title: MoActionDocs
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.CreateEmailMessageRequest:
      type: object
      properties:
        emailTemplateId:
          type: integer
          format: int64
          description: Email template ID that should reference a previously created [Broadcast template](https://www.infobip.com/docs/email/templates).
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: The sender of the 2FA message, an email address with an optional sender name (e.g. `company@example.com` or `Jane Smith <jane.smith@somecompany.com>`).
          readOnly: false
          writeOnly: false
        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`.
          readOnly: false
          writeOnly: false
        pinLength:
          type: integer
          format: int32
          default: 4
          description: PIN code length.
          readOnly: false
          writeOnly: false
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          default: NUMERIC
          description: Type of PIN code that will be generated and sent as part of 2FA message.
          readOnly: false
          writeOnly: false
      required:
      - emailTemplateId
      title: CreateEmailMessageRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.DeliveryTime:
      type: object
      description: The exact time of the day. The time is expressed in the UTC time zone.
      properties:
        hour:
          type: integer
          format: int32
          description: Hour when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 23
          minimum: 0
        minute:
          type: integer
          format: int32
          description: Minute when the time window opens when used in the `from` property or closes when used in the `to` property.
          maximum: 59
          minimum: 0
      required:
      - hour
      - minute
      title: DeliveryTime
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEventType:
      type: string
      description: Event type.
      enum:
      - TYPING_STARTED
      - TYPING_STOPPED
      - SEEN
      title: MessagesApiOutboundEventType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrandVet:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet'
        paging:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo'
      title: PageResponseBrandVet
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleViberEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Viber
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Account:
      type: object
      properties:
        key:
          type: string
        ownerKey:
          type: string
        name:
          type: string
        enabled:
          type: boolean
      title: Account
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EditPermissions:
      type: object
      description: The editPermissions object to indicate editing permissions for the number.
      properties:
        canEditNumber:
          type: boolean
          description: Indicates whether the permissions allow for editing a number.
        canEditConfiguration:
          type: boolean
          description: Indicates whether the  the permissions allow for editing number configuration.
      title: EditPermissions
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageApplication:
      type: object
      properties:
        results:
          type: array
          items:
            $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.Application'
        paging:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.PageInfo'
      title: PageApplication
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RequirementSpecsRequestApiDoc:
      type: object
      discriminator:
        propertyName: type
      oneOf:
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaRequirementSpecsRequestApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberRequirementSpecsRequestApiDoc'
      - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsRequirementSpecsRequestApiDoc'
      title: RequirementSpecsRequestApiDoc
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBody:
      type: object
      description: Body of the message.
      discriminator:
        propertyName: type
        mapping:
          TEXT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTextBody'
          IMAGE: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageImageBody'
          VIDEO: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageVideoBody'
          DOCUMENT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageDocumentBody'
          RICH_LINK: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageRichLinkBody'
          AUTHENTICATION_REQUEST: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageAuthenticationRequestBody'
          LIST: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageListBody'
          CAROUSEL: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageCarouselBody'
          LOCATION: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageLocationBody'
          CONTACT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageContactBody'
          STICKER: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageStickerBody'
          PRODUCT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageProductBody'
          MIXED: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageMixedBody'
          FLOW: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFlowBody'
          TIME_PICKER: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageTimePickerBody'
          ORDER_REQUEST: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderRequestBody'
          ORDER_STATUS: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageOrderStatusBody'
          FORM: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFormBody'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageBodyType'
      required:
      - type
      title: MessagesApiMessageBody
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType:
      type: string
      description: The type of block configuration. Defines whether you are configuring blocking (blacklisting) or unblocking (whitelisting) configuration.
      enum:
      - BLOCK
      - UNBLOCK
      example: UNBLOCK
      title: BlockListConfigurationType
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderApiDoc:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: The ID of the resource.
        type:
          type: string
          description: Type of resource.
          enum:
          - NUMBER_PURCHASE
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        requestedByEmailAddress:
          type: string
          description: Email address of the requester.
        additionalContactEmailAddresses:
          type: array
          description: Additional email addresses.
          items:
            type: string
            description: Additional email addresses.
        requestedDate:
          type: string
          format: date-time
          description: Date and time the resource was requested.
        status:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceOrderStatus'
        numberType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType'
        capabilities:
          type: array
          description: Capabilities of the numbers.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability'
        quantity:
          type: integer
          format: int32
          description: Amount of numbers.
        note:
          type: string
          description: A note containing extra data about the request.
        numbers:
          type: array
          description: List of numbers linked with the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ProcuredNumber'
        requirementsFeedback:
          type: array
          description: List of feedback for requirements.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedback'
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      title: NUMBER_PURCHASE
    bc185b494ef7059aff9d68589cd5338df2245f21add51cf1a96e9927af6e30d7.PublicCnamStatus:
      type: object
      properties:
        storage:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamStorageStatus'
        delivery:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamDeliveryStatus'
      title: PublicCnamStatus
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocResult:
      type: object
      description: List of events provided in a single request.
      properties:
        event:
          type: string
          description: Name of event that is received.
          enum:
          - RESOURCE_REQUEST_STATUS_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when the request status was updated.
        content:
          type: object
          description: Object containing event data.
          oneOf:
          - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaWebhookStatusNotifApiDoc'
          - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberWebhookStatusNotifApiDoc'
          - $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsWebhookStatusNotifApiDoc'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      required:
      - content
      - event
      - receivedAt
      title: WebhookStatusNotifApiDocResult
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RecipientType:
      type: string
      description: Recipient Type must be `TACIR` or `BIREYSEL`.
      enum:
      - BIREYSEL
      - TACIR
      title: RecipientType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookMessage:
      type: object
      description: Incoming events
      properties:
        event:
          type: string
          description: The name of the event.
          enum:
          - CAMPAIGN_STATUS_UPDATE
          example: CAMPAIGN_STATUS_UPDATE
        receivedAt:
          type: string
          format: date-time
          description: Date and time when Infobip received the event.
        content:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookContent'
        platform:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignWebhookPlatform'
      title: CampaignStatusWebhookMessage
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventRequest:
      type: object
      description: Blocklist event request.
      properties:
        results:
          type: array
          description: Incoming blocklist events.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEvent'
      required:
      - results
      title: BlocklistEventRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SortDirection:
      type: string
      enum:
      - ASC
      - DESC
      title: SortDirection
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageResponseBrand:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Brand'
        paging:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PageInfo'
      title: PageResponseBrand
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberPrice:
      type: object
      description: The price object indicating pricing details for the number.
      properties:
        pricePerMonth:
          type: number
          description: Price of the monthly fee.
        setupPrice:
          type: number
          description: Price of the setup fee.
        initialMonthPrice:
          type: number
          description: Price for the initial month.
        currency:
          type: string
          description: Currency of the number's fees.
      title: NumberPrice
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.UpdateApiKeyRequestV1:
      type: object
      properties:
        name:
          type: string
          description: Api key name
        enabled:
          type: boolean
          description: Enable or disable api key.
        allowedIPs:
          type: array
          description: List of allowed IP addresses from which this API key can be used
          items:
            type: string
            description: List of allowed IP addresses from which this API key can be used
        validFrom:
          type: string
          format: date-time
          description: Date from which this API key is/will be valid. Time is in UTC.
        validTo:
          type: string
          format: date-time
          description: Date until this API key will be valid. Time is in UTC.
        permissions:
          type: array
          description: List of permissions this API key has granted. This data may be inaccurate. Migrate to new API key management endpoints and use API scopes for fine grained control.
          items:
            $ref: '#/components/schemas/bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Permission'
      title: UpdateApiKeyRequestV1
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiEventRequest:
      type: object
      properties:
        events:
          type: array
          description: Array of event objects of a single event or multiple events sent
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiOutboundEvent'
      required:
      - events
      title: MessagesApiEventRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourcesFilter:
      type: object
      description: Filter for resources.
      discriminator:
        propertyName: resourceType
        mapping:
          NUMBER: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResourceFilter'
          ALPHANUMERIC: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaResourceFilter'
          RCS_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsResourceFilter'
          VIBER_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceFilter'
          APPLE_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleResourceFilter'
          OPEN_CHANNEL_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelResourceFilter'
      properties:
        resourceType:
          type: string
      required:
      - resourceType
      title: IbResourcesFilter
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultOptIn:
      type: object
      description: Opt-in suggestion generated by the campaign builder.
      properties:
        optInMethod:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod'
        description:
          type: string
          description: Description of the opt-in suggestion.
        disclaimer:
          type: string
          description: Disclaimer text for the opt-in method.
        rules:
          type: array
          description: Opt-in rules for the opt-in method.
          items:
            type: string
            description: Opt-in rules for the opt-in method.
        restrictions:
          type: array
          description: Opt-in restrictions for the opt-in method. Only present for VERBAL opt-in method.
          items:
            type: string
            description: Opt-in restrictions for the opt-in method. Only present for VERBAL opt-in method.
      title: CampaignBuilderResultOptIn
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.PageResponseDto:
      type: object
      properties:
        results:
          type: array
          description: Results on a current page.
          items:
            type: object
            description: Results on a current page.
        paging:
          $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.Paging'
      required:
      - paging
      - results
      title: PageResponseDto
    d20db567f3e57223af6c81b075b50f0bc0d564bb5690e0ef2603138160aca7f3.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageFooter:
      type: object
      description: Footer of the message.
      properties:
        text:
          type: string
          description: Text of the footer.
      required:
      - text
      title: MessagesApiMessageFooter
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest'
      - type: object
        properties:
          contactPhone:
            type: string
            description: Campaign contact phone for use in call-to-action method
          ctaMethods:
            type: array
            description: Call-to-action (CTA) methods indicating how the short code will be promoted to consumers (e.g. web, TV, radio, print).
            items:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType'
            uniqueItems: true
          campaignAttributes:
            type: array
            description: Campaign attributes indicating special content characteristics.
            items:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderCampaignAttributes'
            uniqueItems: true
      description: Request to start building Short code campaign using AI assistant.
      required:
      - brandId
      - campaignIntent
      - campaignType
      - contactEmail
      - ctaMethods
      - optInMethods
      title: ShortCodeCampaignBuilderRequest
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberResourceInfo:
      type: object
      description: Information about Viber type of resource.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        shared:
          type: boolean
          description: Indicates whether a resource is shared.
        originalResourceName:
          type: string
          description: Original resource name.
          example: MyOriginalResource
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          description: Capabilities of the sender.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Viber
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration:
      type: object
      properties:
        keyword:
          type: string
          description: Configuration keyword.
          maxLength: 50
          minLength: 0
        action:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoAction'
        useConversation:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UseConversation'
        otherActionsDetails:
          type: array
          description: List of other configured actions on this keyword. Ignored in POST/PUT calls.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoNonForwardAction'
          readOnly: true
        otherActions:
          type: array
          description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
          items:
            type: string
            description: List of other configured action types/names on this keyword. Ignored in POST/PUT calls.
            readOnly: true
          readOnly: true
        applicationId:
          type: string
          description: ID of the Application that would be associated with the configuration.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the configuration.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        key:
          type: string
          description: Unique ID of configuration.
          minLength: 1
      required:
      - action
      - key
      title: StoredMoConfiguration
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin:
      type: string
      description: 'The location from which outbound messages are sent, relative to the country associated with the sender.

        - LOCAL: Indicates that the business sending the messages is headquartered in the same country as the sender being launched.

        - INTERNATIONAL: Indicates that the business is headquartered outside the country associated with the sender being launched.

        '
      enum:
      - LOCAL
      - INTERNATIONAL
      title: TrafficOrigin
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultStatus:
      type: string
      description: Current status of the campaign builder job.
      enum:
      - PROCESSING
      - COMPLETED
      - FAILED
      title: CampaignBuilderResultStatus
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.RequestInfo:
      type: object
      properties:
        requestId:
          type: string
          description: Request ID.
          example: B61D150B0F6596F68D88D253886432B5
        status:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ClientRequestStatus'
        failureMessage:
          type: string
          description: Additional explanation in case of FAILED status.
      required:
      - requestId
      - status
      title: RequestInfo
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.UpdateCampaignRegistrationRequest:
      type: object
      properties:
        numberKeys:
          type: array
          description: The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns.
          externalDocs:
            description: Find out more about numbers.
            url: '#platform-&-connectivity/numbers'
          items:
            type: string
            description: The numberKey(s) of the numbers to use with the campaign. Alternatively, you can use the 'numbers' property to specify the numbers directly, but note that 'numberKeys' property takes precedence if both are specified.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns.
            externalDocs:
              description: Find out more about numbers.
              url: '#platform-&-connectivity/numbers'
          maxItems: 5000
          minItems: 0
          uniqueItems: true
        numbers:
          type: array
          description: 'US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of ''numberKeys'' to specify the campaign numbers; it is not returned in the API response.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns. '
          externalDocs:
            description: Find out more about numbers.
            url: '#platform-&-connectivity/numbers'
          items:
            type: string
            description: 'US 10DLC numbers to use with the campaign. You may only use numbers that are associated with your account inside the Infobip platform. Numbers must be provided in international format including the country prefix, e.g. 14232180111. This property can be used instead of ''numberKeys'' to specify the campaign numbers; it is not returned in the API response.  Total limit for Number pooling campaigns is 35000 instead of 49. You can add or remove up to 5000 numbers at a time for Number pooling campaigns. '
            externalDocs:
              description: Find out more about numbers.
              url: '#platform-&-connectivity/numbers'
          maxItems: 5000
          minItems: 0
          uniqueItems: true
          writeOnly: true
      title: UpdateCampaignRegistrationRequest
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.RequestSchedulingSettings:
      type: object
      description: Options for scheduling a message.
      properties:
        bulkId:
          type: string
          description: Unique ID assigned to the request if messaging multiple recipients or sending multiple messages via a single API request. If not provided, it will be auto-generated and returned in the API response.
          maxLength: 100
          minLength: 0
        sendAt:
          type: string
          format: date-time
          description: 'Date and time when the message is to be sent. Used for scheduled messages. Has the following format: `yyyy-MM-dd''T''HH:mm:ss.SSSZ`, and can only be scheduled for no later than 180 days in advance.'
        sendingSpeedLimit:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SendingSpeedLimit'
      title: RequestSchedulingSettings
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.TrafficAggregate:
      type: string
      enum:
      - HOUR
      - DAY
      - WEEK_SATURDAY_START
      - WEEK_SUNDAY_START
      - WEEK_MONDAY_START
      - MONTH
      - QUARTER
      - YEAR
      - ACCOUNT_KEY
      - ACCOUNT_NAME
      - STATUS_GROUP
      - STATUS
      - ERROR_GROUP
      - ERROR_CODE
      - TIME_TO_DELIVER
      - TIME_TO_ANSWER
      - TIME_TO_CLICK_FROM_SEEN
      - TIME_TO_CLICK_FROM_DELIVERED
      - TIME_TO_SEEN_FROM_DELIVERED
      - TIME_TO_OPEN_FROM_DELIVERED
      - DIRECTION
      - SENDER
      - SENDER_TYPE
      - COMMUNICATION
      - CAMPAIGN_REFERENCE
      - NETWORK_ID
      - NETWORK_NAME
      - COUNTRY_ID
      - COUNTRY_NAME
      - COUNTRY_CODE
      - APPLICATION_ID
      - ENTITY_ID
      - CHANNEL_CODE
      - CHANNEL_NAME
      - CAPABILITY
      - TRAFFIC_TYPE
      - URL
      title: TrafficAggregate
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType:
      type: string
      description: Credentials type.
      enum:
      - BASIC
      - HMAC
      - OAUTH
      - CUSTOM
      title: CredentialsType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityPage:
      type: object
      properties:
        results:
          type: array
          description: The list of the results for this page.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityResponse'
        paging:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.PageInfo'
      title: SecurityPage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload:
      type: object
      description: Basic credentials.
      properties:
        username:
          type: string
          description: Username.
          maxLength: 255
          minLength: 1
        password:
          type: string
          description: Password.
          maxLength: 255
          minLength: 1
      required:
      - password
      - username
      title: BasicCredentials
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderRequest:
      type: object
      description: Request to start building campaign using AI assistant.
      discriminator:
        propertyName: campaignType
        mapping:
          TEN_DIGIT_LONG_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest'
          SHORT_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest'
          TOLL_FREE_NUMBER: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest'
      oneOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderRequest'
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderRequest'
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderRequest'
      properties:
        brandId:
          type: string
          format: uuid
          description: Brand ID.
        campaignType:
          type: string
          description: Campaign type.
          enum:
          - TEN_DIGIT_LONG_CODE
          - SHORT_CODE
          - TOLL_FREE_NUMBER
        campaignIntent:
          type: string
          description: Description of the campaign's purpose and messaging use case. This is the primary input that drives the generated campaign configuration, so it should be specific enough to convey the type of messages being sent and target audience, but concise (1-2 sentences).
        contactEmail:
          type: string
          format: email
          description: Campaign contact email.
        optInMethods:
          type: array
          description: Campaign opt-in methods.
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderOptInMethod'
          uniqueItems: true
      required:
      - brandId
      - campaignIntent
      - campaignType
      - contactEmail
      - optInMethods
      title: CampaignBuilderRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVet:
      type: object
      description: The list of the results for this page.
      properties:
        vetId:
          type: string
          format: uuid
          description: The ID of the vet record.
          readOnly: true
        brandId:
          type: string
          format: uuid
          description: The ID of the brand the vet belongs to.
          readOnly: true
        score:
          type: integer
          format: int32
          description: The score the brand received after being vetted.
          readOnly: true
        vettedDate:
          type: string
          format: date-time
          description: The date the vet was completed.
          readOnly: true
        enhancedVettedDate:
          type: string
          format: date-time
          description: The date the vet was completed if it was an enhanced vet or if it was converted to enhanced from a standard vet.
          readOnly: true
        status:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatus'
        type:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingType'
        imported:
          type: boolean
          description: Showing is brand vet imported.
          readOnly: true
        importedVetProvider:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider'
      required:
      - type
      title: BrandVet
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPoolUsageApiResponse:
      type: object
      description: The list of the results for this page.
      properties:
        numberPoolId:
          type: string
          description: Unique identifier of the number pool.
        campaignId:
          type: string
          description: Unique identifier of the campaign currently associated with this number pool. If the number pool is unassigned, this field will be empty.
        campaignName:
          type: string
          description: Name of the associated campaign. Will be empty if no campaign is associated.
      title: NumberPoolUsageApiResponse
    c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Message:
      type: object
      properties:
        applicationId:
          type: string
          description: The ID of the application that represents your service (e.g. 2FA for login, 2FA for changing the password, etc.) for which the requested message has been created.
          readOnly: false
          writeOnly: false
        emailTemplateId:
          type: integer
          format: int64
          description: Email template ID that should reference a previously created Email template. This field is present only for [Email message templates](#channels/sms/create-2fa-email-message-template).
          readOnly: false
          writeOnly: false
        from:
          type: string
          description: The sender of the 2FA message, an email address with an optional sender name (e.g. `company@example.com` or `Jane Smith <jane.smith@somecompany.com>`). This field is present only for [Email message templates](#channels/sms/create-2fa-email-message-template).
          readOnly: false
          writeOnly: false
        landingPageId:
          type: string
          description: Opt out landing page ID that should reference a previously created landing page template. This field is present only for [Email message templates](#channels/sms/create-2fa-email-message-template).
          readOnly: false
          writeOnly: false
        language:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.Language'
          description: The language code which message is written in used when sending text-to-speech messages. If not defined, it will default to English (`en`).
          readOnly: false
          writeOnly: false
        messageId:
          type: string
          description: The ID of the message template (message body with the PIN placeholder) that is sent to the recipient.
          readOnly: false
          writeOnly: false
        messageText:
          type: string
          description: Text of a message that will be sent. Message text must contain `pinPlaceholder`.
          readOnly: false
          writeOnly: false
        pinLength:
          type: integer
          format: int32
          description: PIN code length.
          readOnly: false
          writeOnly: false
        pinPlaceholder:
          type: string
          description: The PIN code placeholder that will be replaced with a generated PIN code.
          readOnly: false
          writeOnly: false
        pinType:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.PinType'
          description: The type of PIN code that will be generated and sent as part of 2FA message. You can set PIN type to numeric, alpha, alphanumeric or hex.
          readOnly: false
          writeOnly: false
        regional:
          allOf:
          - $ref: '#/components/schemas/c3b21d2ffef2552e10577daa67c904ac80618665b001ef386a4faefc515e78f3.RegionalOptions'
          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.
          readOnly: false
          writeOnly: false
        repeatDTMF:
          type: string
          description: In case PIN message is sent by Voice, DTMF code will enable replaying the message.
          readOnly: false
          writeOnly: false
        senderId:
          type: string
          description: 'The sender of the 2FA message (Example: CompanyName).'
          readOnly: false
          writeOnly: false
        speechRate:
          type: number
          format: double
          description: In case PIN message is sent by Voice, the speed of speech can be set for the message. Supported range is from `0.5` to `2`.
          readOnly: false
          writeOnly: false
        voiceName:
          type: string
          description: 'Defines the voice that will be used for the chosen language (example: Joanna). For each supported language, we may offer different voices (learn more [here](https://www.infobip.com/docs/voice-and-video/reference#text-to-speech-languages)). You can use this [method](https://www.infobip.com/docs/api/channels/voice/voice-message/get-voices) to retrieve all voices for the given language. If not defined, it will default to the standard voice for the selected language (if available). If the standard voice is not available, the request will fail. To avoid that, you can choose one of the neural voices (charges will apply).'
          readOnly: false
          writeOnly: false
      title: Message
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiMessageButtonType:
      type: string
      enum:
      - REPLY
      - OPEN_URL
      - DIAL_PHONE
      - SHOW_LOCATION
      - REQUEST_LOCATION
      - ADD_CALENDAR_EVENT
      title: MessagesApiMessageButtonType
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType:
      type: string
      description: Type of numbers.
      enum:
      - SHORT_CODE
      - VIRTUAL_LONG_NUMBER
      - TEN_DIGIT_LONG_CODE
      - TOLL_FREE_NUMBER
      title: ResourceNumberType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NoIdSubscriptionRequest:
      oneOf:
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BlocklistNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CustomerEngagementNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.EmailNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FacebookNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoBrandMessageNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.LineNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobileIdentityNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MobilePushNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OpenChannelNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RcsNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SmsNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ViberNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WebPushNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappNoIdSubscriptionRequest'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ZaloNoIdSubscriptionRequest'
      title: NoIdSubscriptionRequest
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.PagingResponse:
      type: object
      description: Paging response.
      properties:
        page:
          type: integer
          format: int32
          description: Requested page number.
        size:
          type: integer
          format: int32
          description: Requested page size.
        totalPages:
          type: integer
          format: int32
          description: Total pages.
        totalResults:
          type: integer
          format: int32
          description: Total results.
      required:
      - page
      - size
      - totalPages
      - totalResults
      title: PagingResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationBadResponse:
      type: object
      properties:
        description:
          type: string
          description: A detailed description of an error.
        action:
          type: string
          description: An action that should be taken to recover from the error.
        violations:
          type: array
          description: List of violations that caused the error.
          items:
            $ref: '#/components/schemas/ApiErrorViolation'
        skippableViolations:
          type: array
          description: List of violations that may be omitted, but is recommended to address.
          items:
            $ref: '#/components/schemas/ApiErrorViolation'
      required:
      - action
      - description
      - violations
      title: ValidationBadResponse
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType:
      type: string
      description: 'Type of SMS messages you will send.

        - TRANSACTIONAL: Messages triggered by user actions or system events, such as one-time passwords (OTP/PIN), transaction alerts, password resets, or service notifications.

        - PROMOTIONAL: Messages sent for marketing or advertising purposes, such as promotions, offers, campaigns, or announcements.

        '
      enum:
      - PROMOTIONAL
      - TRANSACTIONAL
      title: TrafficType
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.CnamStorage:
      type: object
      description: CNAM Storage is an up to 15-character name that will identify you to the person that you are calling if they subscribe to caller ID.
      properties:
        enabled:
          type: boolean
          default: false
          description: Indicates whether configuration is enabled or not.
        name:
          type: string
          description: Name that will identify you to the person that you are calling.
          maxLength: 15
          minLength: 0
      required:
      - name
      title: CnamStorage
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.RegistrationNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleRegistrationEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Registration
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurationRequest:
      type: object
      discriminator:
        propertyName: channel
        mapping:
          SMS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.SmsMoConfigurationRequest'
          MMS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MmsMoConfigurationRequest'
          WHATSAPP: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.WhatsAppMoConfigurationRequest'
          RCS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsMoConfigurationRequest'
          VIBER_BM: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBmMoConfigurationRequest'
          APPLE_MB: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleMbMoConfigurationRequest'
          LINE_OA: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.LineOaMoConfigurationRequest'
          KAKAO_SANGDAM: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoSangdamMoConfigurationRequest'
          MESSENGER: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MessengerMoConfigurationRequest'
          INSTAGRAM_DM: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.InstagramDmMoConfigurationRequest'
          ZALO_ZNS: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloZnsMoConfigurationRequest'
          TELEGRAM: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TelegramMoConfigurationRequest'
          VIBER_BOT: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberBotMoConfigurationRequest'
          EMAIL: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EmailDomainMoConfigurationRequest'
          ZALO_FOLLOWER: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ZaloFollowerMoConfigurationRequest'
          OPEN_CHANNEL: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelMoConfigurationRequest'
          TIKTOK_BM: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.TikTokBmMoConfigurationRequest'
      properties:
        keyword:
          type: string
          description: Omitting this value or sending <code>NULL</code> will set keyword to <code>NULL</code> because it is a valid keyword which will match all values.
          example: STARTKW
          maxLength: 50
          minLength: 0
        username:
          type: string
          description: Sets username that will be applied in appropriate actions.
          example: myusername
          maxLength: 255
          minLength: 0
          pattern: ^(?!\s*$).+
        unset:
          type: array
          description: Used for unsetting configuration options. <br /> <b>If a property appears both in unset, and in the body of the request, it will <u>FIRST</u> be removed, and then <u>UPDATED</u> with the value from the request body!</b>
          example: FORWARDING
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.UnsetOption'
          uniqueItems: true
        channel:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType'
      required:
      - channel
      title: MoConfigurationRequest
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceAssociationRequest:
      type: object
      properties:
        resourceType:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ResourceType'
        channel:
          $ref: '#/components/schemas/2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType'
        applicationId:
          type: string
          description: The unique identifier of the application. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints.
          example: test-application
          maxLength: 255
        entityId:
          type: string
          description: The unique identifier of the entity. This ID will be a URL path parameter. We recommend using values that do not need URL encoding for easier interaction with other API endpoints. If no entity is associated with this resource, set the entityId to `null`.
          example: test-entity
          maxLength: 255
        resourceId:
          type: string
          description: The unique identifier of the resource. It depends on both the `resourceType` and `channel`.<br/>Use [numberKey](https://www.infobip.com/docs/api/platform-connectivity/numbers/phone-numbers/list-purchased-numbers) for the NUMBER `resourceType`.<br/>Use [domainName](https://www.infobip.com/docs/api/channels/email/get-all-domains) for the DOMAIN `resourceType`, which is available only for the Email channel.
          example: test-resource
          maxLength: 255
      required:
      - applicationId
      - channel
      - entityId
      - resourceId
      - resourceType
      title: ResourceAssociationRequest
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.PublicCnamStorageStatus:
      type: object
      description: Current status of CNAM Storage configuration.
      properties:
        status:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Status'
        reason:
          type: string
          description: Description of the status.
      title: PublicCnamStorageStatus
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandAppealStatus:
      type: string
      description: Current status of the appeal.
      enum:
      - PENDING
      - COMPLETED
      - REJECTED
      title: BrandAppealStatus
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Whatsapp
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaignBuilderResultMessageFlow:
      type: object
      description: Campaign message flow for 10DLC campaigns
      properties:
        optInMessage:
          type: string
          description: Opt-in confirmation message
        exampleMessage1:
          type: string
          description: First example message
        exampleMessage2:
          type: string
          description: Second example message
        helpMessage:
          type: string
          description: Help response message
        optOutMessage:
          type: string
          description: Opt-out response message
      title: TenDlcCampaignBuilderResultMessageFlow
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.KakaoCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        displayName:
          type: string
          description: Display name.
          example: MyDisplayName
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Kakao
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SubscriptionEvent:
      description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
      oneOf:
      - type: string
        title: Event name
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareEvent'
      title: SubscriptionEvent
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload:
      type: object
      description: OAuth credentials.
      properties:
        tokenUrl:
          type: string
          description: Token URL.
          maxLength: 255
          minLength: 1
        clientId:
          type: string
          description: Client ID.
          maxLength: 255
          minLength: 0
        clientSecret:
          type: string
          description: Client secret.
          maxLength: 255
          minLength: 0
        grantType:
          type: string
          description: Grant type.
          maxLength: 255
          minLength: 1
        scope:
          type: string
          description: Scope.
          maxLength: 255
          minLength: 0
        username:
          type: string
          description: Username.
          maxLength: 255
          minLength: 0
        password:
          type: string
          description: Password.
          maxLength: 255
          minLength: 0
        resource:
          type: string
          description: Resource.
          maxLength: 255
          minLength: 0
        refreshToken:
          type: string
          description: Refresh token.
          maxLength: 255
          minLength: 0
        headers:
          type: object
          additionalProperties:
            type: string
          description: Set of key:value pairs that will be sent in a HTTP request as headers.
      required:
      - grantType
      - tokenUrl
      title: OauthCredentials
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileResponse:
      type: object
      description: Notification profile.
      properties:
        profileId:
          type: string
          description: Unique profile ID.
        webhook:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook'
        security:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlySecurityResponse'
        clientCertificateId:
          type: string
          description: Client certificate ID.
        maxBucketSize:
          type: integer
          format: int32
          description: Specifies a maximum number of messages to be sent within a single request.
        windowSize:
          type: integer
          format: int32
          description: A maximum number of concurrent connections (active requests) per client.
        connectTimeout:
          type: integer
          format: int32
          description: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.
        readTimeout:
          type: integer
          format: int32
          description: A maximum period of inactivity in milliseconds between two consecutive data packets.
        enabledSSLProtocols:
          type: array
          description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
          enum:
          - TLSv1.2
          - TLSv1.3
          items:
            type: string
            description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
            enum:
            - TLSv1.2
            - TLSv1.3
          uniqueItems: true
        headers:
          type: object
          additionalProperties:
            type: string
          description: Set of key:value pairs that will be sent in a HTTP request as headers.
        responseRegex:
          type: string
          description: Response regex.
        responseBodyRegex:
          type: string
          description: Response body regex.
        rateLimit:
          type: integer
          format: int32
          description: Limits the number of requests per second.
      title: Profile
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWebPushEvents:
      type: string
      enum:
      - DELIVERY
      title: Event
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - DELIVERY
          - INBOUND_MESSAGE
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVettingType:
      type: string
      description: The type of brand vet.
      enum:
      - STANDARD
      - ENHANCED
      example: STANDARD
      title: WebhookBrandVettingType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignInfoReviewRequest:
      type: object
      description: Request to submit a new campaign for AI compliance review
      discriminator:
        propertyName: reviewType
        mapping:
          TEN_DIGIT_LONG_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest'
      oneOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcAiReviewRequest'
      properties:
        reviewType:
          type: string
          description: Type of review submission
          enum:
          - TEN_DIGIT_LONG_CODE
        brandName:
          type: string
          description: Brand name
        brandWebsite:
          type: string
          description: Brand website URL
        brandSupportEmail:
          type: string
          description: Brand support email
        programDescription:
          type: string
          description: A brief description of the purpose of the campaign.
        messageExamples:
          type: array
          description: The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.
          items:
            type: string
            description: The example message(s) a user may receive from this campaign. Each example message must be at least 20 characters long.
        customerCareEmail:
          type: string
          description: The email address the user may contact to get customer care.
        termsAndConditionsUrl:
          type: string
          description: URL where the terms and conditions of the campaign are located.
        privacyPolicyUrl:
          type: string
          description: Privacy policy URL
      required:
      - brandName
      - brandSupportEmail
      - brandWebsite
      - customerCareEmail
      - messageExamples
      - programDescription
      - reviewType
      title: CampaignInfoReviewRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreviews:
      type: object
      properties:
        numberPreviews:
          type: array
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.NumberPreview'
          uniqueItems: true
      title: NumberPreviews
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacAlgorithm:
      type: string
      description: HMAC algorithm.
      enum:
      - HMAC_MD5
      - HMAC_SHA_1
      - HMAC_SHA_224
      - HMAC_SHA_256
      - HMAC_SHA_384
      - HMAC_SHA_512
      title: HmacAlgorithm
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocRequestBody:
      type: object
      properties:
        results:
          type: array
          description: List of events provided in a single request.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.WebhookStatusNotifApiDocResult'
      title: WebhookStatusNotifApiDocRequestBody
    8b2121dcd8344af6f8ffd883d0b652fbff554e4dff3cace0de1953d2985a5758.ApiException:
      type: object
      properties:
        requestError:
          $ref: '#/components/schemas/ApiRequestError'
      title: ApiException
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberResourceOrderRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - NUMBER_PURCHASE
        quantity:
          type: integer
          format: int32
          description: Amount of numbers.
          maximum: 49
          minimum: 1
        numberType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberType'
        capabilities:
          type: array
          description: Capabilities of the numbers.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.ResourceNumberCapability'
        clientType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberOfferClientType'
        additionalContactEmails:
          type: array
          description: Email addresses that would be contacted by Infobip support team for any request related matter.
          items:
            type: string
            description: Email addresses that would be contacted by Infobip support team for any request related matter.
          maxItems: 3
          minItems: 0
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        requirements:
          type: array
          description: List of requirements for the resource.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirement'
        platform:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform'
      required:
      - capabilities
      - countryCode
      - numberType
      - type
      title: NUMBER_PURCHASE
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.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
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateStatus:
      type: string
      description: 'Certificate status. Represents a certificate state and indicates whether the certificate can be used.

        PROCESSING means certificate is being synced on Infobip Platform and cannot be use for notification events.

        READY means certificate is synced and notification events can be sent to webhook using the certificate.

        EXPIRED means certificate cannot be used because validity date is in the past.'
      enum:
      - PROCESSING
      - READY
      - EXPIRED
      title: CertificateStatus
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        senderName:
          type: string
          description: Alphanumeric sender name.
          example: MySender
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      required:
      - countryCode
      title: Alphanumeric
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VetImportRequest:
      type: object
      discriminator:
        propertyName: type
        mapping:
          AEGIS_MOBILE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.AegisVetImportRequest'
          CAMPAIGN_VERIFY: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CvVetImportRequest'
          WMC_GLOBAL: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WmcVetImportRequest'
      properties:
        type:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingProvider'
      required:
      - type
      title: VetImportRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignRegistrar:
      type: string
      description: The network a campaign is submitted to.
      enum:
      - CAMPAIGN_REGISTRY
      - T_MOBILE
      - ATT
      - VERIZON
      - CLEARSKY
      - US_CELLULAR_SMS
      - INTEROP
      - GOOGLE_VOICE
      - US_CELLULAR_MMS
      - ZIPWHIP
      - LIBERTY
      - DISH
      - CHARTER_SPECTRUM
      - C_SPIRE
      - GOOGLE_FI
      - TRACFONE
      example: VERIZON
      title: CampaignRegistrar
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistGetResponse:
      type: object
      description: Blocklist get response.
      properties:
        results:
          type: array
          description: Blocklists for requested paging information.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistResponse'
        paging:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.PagingResponse'
      required:
      - paging
      - results
      title: BlocklistGetResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.DayOfWeek:
      type: string
      description: Days which are included in the delivery time window.
      enum:
      - MONDAY
      - TUESDAY
      - WEDNESDAY
      - THURSDAY
      - FRIDAY
      - SATURDAY
      - SUNDAY
      title: DayOfWeek
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberResponse:
      type: object
      properties:
        numberKey:
          type: string
          description: Unique ID of a number.
        number:
          type: string
          description: The number.
        country:
          type: string
          description: Number's country code.
        countryName:
          type: string
          description: Number's country.
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberType'
        capabilities:
          type: array
          description: An array of communication channels the number can support.
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCapabilityType'
        shared:
          type: boolean
          description: Indicates whether a number is shared.
        price:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberPrice'
        network:
          type: string
          description: Indicates the network that owns the number.
        keywords:
          type: array
          description: Keywords defined for the number.
          items:
            type: string
            description: Keywords defined for the number.
        voiceSetup:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.VoiceSetup'
        reservationStatus:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ReservationStatus'
        additionalSetupRequired:
          type: boolean
          description: Indicates whether the number requires additional setup before being used.
        editPermissions:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.EditPermissions'
        note:
          type: string
          description: Additional information attached to the number. Available only for SHORT_CODE and VIRTUAL_LONG_NUMBER number types.
        applicationId:
          type: string
          description: ID of the Application that would be associated with the number.
          externalDocs:
            description: Find out more about Application and Application Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the number.
          externalDocs:
            description: Find out more about Entity and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
      title: NumberResponse
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest:
      type: object
      description: Notification profile object holding the settings for your webhook URL and a reference to security settings. You can provide full definition of a notification profile and security settings if you want to create new items, or provide an ID of an existing profile to reuse it. If you want to reuse an existing profile, do not provide any other notification profile and security settings properties.
      properties:
        profileId:
          type: string
          description: ID of a notification profile. This identifier will be used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.
          maxLength: 255
          minLength: 1
        webhook:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.Webhook'
        security:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest'
        clientCertificateId:
          type: string
          description: Client certificate ID.
          maxLength: 255
          minLength: 0
        maxBucketSize:
          type: integer
          format: int32
          description: Specifies a maximum number of messages to be sent within a single request.
          maximum: 2000
          minimum: 1
        windowSize:
          type: integer
          format: int32
          description: A maximum number of concurrent connections (active requests) per client.
          maximum: 10000
          minimum: 20
        connectTimeout:
          type: integer
          format: int32
          description: Time in milliseconds sender system waits for connection acknowledgement until the connection is closed.
          maximum: 30000
          minimum: 300
        readTimeout:
          type: integer
          format: int32
          description: A maximum period of inactivity in milliseconds between two consecutive data packets.
          maximum: 90000
          minimum: 1000
        enabledSSLProtocols:
          type: array
          description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
          enum:
          - TLSv1.2
          - TLSv1.3
          items:
            type: string
            description: Specifies which security protocols should be used to send a HTTP request. Multiple options can be used.
            enum:
            - TLSv1.2
            - TLSv1.3
          uniqueItems: true
        headers:
          type: object
          additionalProperties:
            type: string
          description: 'Set of key:value pairs that will be sent in a HTTP request as headers.Note: ''Authorization'' header (if configured here for any reason) can be overridden with one from security config.'
        responseRegex:
          type: string
          description: Response regex.
        responseBodyRegex:
          type: string
          description: Response body regex.
        rateLimit:
          type: integer
          format: int32
          description: Limits the number of requests per second.
          maximum: 5000
          minimum: 1
      required:
      - profileId
      title: Profile
    66067ae938b1b756af79ad29184e7a22de98929ca991ca01a0c74d258f22a0b6.SimpleCurrencyInfo:
      type: object
      properties:
        id:
          type: integer
          format: int32
        code:
          type: string
        currencyName:
          type: string
        symbol:
          type: string
      title: SimpleCurrencyInfo
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.MmsSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleMmsEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMmsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: MMS
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreateRequest:
      type: object
      description: Blocklist request.
      properties:
        blocklist:
          type: array
          description: Blocklist elements that need to be blocklisted. Number of destinations cannot exceed 50 000.
          items:
            $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistCreate'
      required:
      - blocklist
      title: BlocklistCreateRequest
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatusWebhookContent:
      type: object
      description: Event content.
      properties:
        vetId:
          type: string
          format: uuid
          description: The ID of the brand vet.
          example: 20ef4b12-55f2-11ee-bfc2-325096b39f47
        brandId:
          type: string
          format: uuid
          description: The ID of the brand.
          example: 0579c038-55f2-11ee-9458-325096b39f47
        vettingScore:
          type: integer
          format: int32
          description: The vetting score of a brand vet. This can be empty if score isn't present.
          example: 80
        brandVettingStatus:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVetStatus'
        vetType:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.WebhookBrandVettingType'
      title: BrandVetStatusWebhookContent
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareMobileIdentityEvents:
      type: object
      properties:
        event:
          type: string
          enum:
          - SILENT_VERIFICATION
        format:
          type: string
          description: Format which you want to assign to the event. For more information about available formats and their payload, check our [Event Formats](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-formats) page.
      required:
      - event
      - format
      title: Event with format
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.WhatsappSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleWhatsappEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Whatsapp
    40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Item:
      type: string
      enum:
      - TFA
      - Account
      - ApiKey
      - AutomaticPayment
      - BillingAddress
      - Blacklist
      - Campaign
      - Communication
      - Company
      - CustomField
      - Domain
      - ExportConfiguration
      - Forms
      - Keyword
      - MobileApplication
      - MobileDemoApplication
      - Number
      - OneTimePayment
      - Password
      - Person
      - Price
      - Report
      - Segment
      - Search
      - Tag
      - Team
      - Template
      - URL
      - User
      - Website
      title: Item
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability:
      type: object
      description: Coverage by capability.
      properties:
        channel:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel'
        coverage:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverage'
      title: IbResourceCapability
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ReservationStatus:
      type: string
      description: Status of the number reservation.
      enum:
      - PENDING
      - BILLING_FAILED
      - ERROR
      - RESERVATION_FAILED
      title: ReservationStatus
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FeedbackCode:
      type: string
      description: Code of the feedback.
      enum:
      - RES_REQ_FEED_REQUIRED
      - RES_REQ_FEED_FORMAT
      - RES_REQ_FEED_LENGTH_OOR
      - RES_REQ_FEED_VALUE_OOR
      - RES_REQ_FEED_OTHER
      - RES_REQ_FEED_USER_ACTION_REQUIRED
      title: FeedbackCode
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.VettingType:
      type: string
      description: The type of vet.
      enum:
      - STANDARD
      - ENHANCED
      - POLITICAL
      title: VettingType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.NumberLookupNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleNumberLookupEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Number Lookup
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeMessageVolume:
      type: string
      enum:
      - TEN
      - HUNDRED
      - THOUSAND
      - TEN_THOUSAND
      - HUNDRED_THOUSAND
      - TWO_HUNDRED_FIFTY_THOUSAND
      - FIVE_HUNDRED_THOUSAND
      - SEVEN_HUNDRED_FIFTY_THOUSAND
      - ONE_MILLION
      - FIVE_MILLION
      - TEN_MILLION_PLUS
      title: TollFreeMessageVolume
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ConfigurationType:
      type: string
      description: Channel type.
      enum:
      - SMS
      - MMS
      - WHATSAPP
      - RCS
      - VIBER_BM
      - APPLE_MB
      - LINE_OA
      - KAKAO_SANGDAM
      - MESSENGER
      - INSTAGRAM_DM
      - ZALO_ZNS
      - TELEGRAM
      - VIBER_BOT
      - EMAIL
      - ZALO_FOLLOWER
      - OPEN_CHANNEL
      - TIKTOK_BM
      example: SMS
      title: ConfigurationType
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.MoConfigurations:
      type: object
      properties:
        configurations:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.StoredMoConfiguration'
        totalCount:
          type: integer
          format: int32
      title: MoConfigurations
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandVetStatus:
      type: string
      description: The status of vet.
      enum:
      - PENDING
      - SUCCESS
      - FAILURE
      title: BrandVetStatus
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequest:
      type: object
      properties:
        messages:
          type: array
          description: Array of message objects of a single message or multiple messages sent under one bulk ID.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiBaseMessage'
        options:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiRequestOptions'
      required:
      - messages
      title: MessagesApiRequest
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ErrorCodeGroup:
      type: string
      description: "\nSpecifies the general error code groups.\n\nFor the list of possible values, refer to\n[error codes groups](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
      enum:
      - OK
      - HANDSET_ERRORS
      - USER_ERRORS
      - OPERATOR_ERRORS
      title: ErrorCodeGroup
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.AlphaRequirementSpecsRequestApiDoc:
      type: object
      properties:
        type:
          type: string
          description: Type of resource.
          enum:
          - ALPHANUMERIC_REGISTRATION
        countryCode:
          type: string
          description: Country code in two-letter ISO standard.
        trafficOrigin:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficOrigin'
        trafficType:
          $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.TrafficType'
      required:
      - countryCode
      - type
      title: ALPHANUMERIC_REGISTRATION
    40143f8c1273929a779db5eeca48aaeec6583ec5c7f80b29e546fbb75ba02e1d.Action:
      type: string
      enum:
      - Accept
      - Activation
      - Add
      - Assign
      - Buy
      - Cancel
      - Change
      - Clone
      - Create
      - CreateGenerate
      - CreateVersion
      - Delete
      - DeleteVersion
      - Disable
      - Download
      - Duplicate
      - Enable
      - Export
      - Finish
      - Import
      - InviteToMobileDemoApplication
      - Launch
      - LaunchVersion
      - Lock
      - Login
      - Logout
      - Merge
      - Pause
      - Remove
      - Request
      - Restore
      - Schedule
      - Sent
      - StopVersion
      - Successful
      - Unlock
      - Update
      - Updated
      - Unsuccessful
      - Verify
      title: Action
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.OutboundTemplateChannel:
      type: string
      description: Messaging channel used for sending a template message.
      enum:
      - APPLE_MB
      - RCS
      - VIBER_BM
      - WHATSAPP
      title: OutboundTemplateChannel
    7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.ValidateAddressResponse:
      type: object
      properties:
        validAddresses:
          type: array
          description: List of physical valid addresses that matches your input.
          items:
            $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Address'
      title: ValidateAddressResponse
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataRequest:
      type: object
      properties:
        callbackUrl:
          type: string
          description: "\nThe target URL that will receive the query processing results.The schema for this endpoint is documented at\n[Receive Aggregated Data Result](#platform/metrics-api/receive-aggregate-data-result).\n        "
        request:
          $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataRequest'
      required:
      - callbackUrl
      - request
      title: QueryAggregateDataRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.KakaoAlimNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleKakaoAlimEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Kakao Alim
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton:
      type: object
      description: List of buttons of a template message.
      discriminator:
        propertyName: type
        mapping:
          QUICK_REPLY: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateQuickReplyButton'
          OPEN_URL: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateOpenUrlButton'
          PHONE_NUMBER: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplatePhoneNumberButton'
          FLOW: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateFlowButton'
          COPY_CODE: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCopyCodeButton'
          CATALOG: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateCatalogButton'
          MULTI_PRODUCT: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMultiProductButton'
      properties:
        type:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButtonType'
      required:
      - type
      title: MessagesApiTemplateButton
    2be764ef53499e28cc8da8dff3890f0787860aba10984e520352c73612c0342b.ChannelType:
      type: string
      description: The channel for which the resource will be used.
      enum:
      - SMS
      - MMS
      - EMAIL
      - WHATSAPP
      - RCS
      - APPLE
      title: ChannelType
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AgentOsSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAgentOsEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: AgentOS
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ResourceCapabilityChannel:
      type: string
      description: Indicates the channel supported by the resource.
      enum:
      - SMS
      - MMS
      - RCS
      - VIBER_BM
      - VIBER_BOT
      - APPLE_MB
      - OPEN_CHANNEL
      - KAKAO_CHINGU
      - KAKAO_ALIM
      - KAKAO_SANGDAM
      - FACEBOOK_POSTS
      - MESSENGER
      example: SMS
      title: ResourceCapabilityChannel
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEvent:
      type: object
      description: Blocklist event.
      properties:
        event:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.BlocklistEventType'
        receivedAt:
          type: string
          format: date-time
          description: Date and time when the event was received.
        messageId:
          type: string
          description: The ID that uniquely identifies the event sent.
        content:
          $ref: '#/components/schemas/2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.Content'
      required:
      - content
      - event
      - messageId
      - receivedAt
      title: BlocklistEvent
    7635fa9e013ed171bbe9743a6ca322c3b2b29e7574931e38f0de0bda9687aadf.EmergencyAddressStatus:
      type: object
      properties:
        emergencyService:
          $ref: '#/components/schemas/4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.StatusResponse'
      title: EmergencyAddressStatus
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.ValidationOkResponse:
      type: object
      properties:
        description:
          type: string
          description: A detailed description.
        action:
          type: string
          description: An action that should be taken.
        skippableViolations:
          type: array
          description: List of violations that may be omitted, but is recommended to address.
          items:
            $ref: '#/components/schemas/ApiErrorViolation'
      required:
      - action
      - description
      title: ValidationOkResponse
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CountResponse:
      type: object
      properties:
        count:
          type: integer
          format: int64
          description: Number of affected items.
          example: 100
      required:
      - count
      title: CountResponse
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        senderName:
          type: string
          description: Sender name.
          example: MySender
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: RCS
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.InboundDlrChannel:
      type: string
      description: Messaging channel used for sending an event. `KAKAO, ZALO, VOICE or TELEGRAM` can be received with Smart Messaging.
      enum:
      - APPLE_MB
      - INSTAGRAM_DM
      - LINE_ON
      - MESSENGER
      - MMS
      - RCS
      - SMS
      - VIBER_BM
      - VIBER_BOT
      - WHATSAPP
      - KAKAO
      - ZALO
      - VOICE
      - TELEGRAM
      title: InboundDlrChannel
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ChannelCode:
      type: string
      description: '

        Specifies communication channels and/or services. This is a list of available channels/services and their codes:


        * `SMS` - SMS

        * `EMAIL` - Email

        * `FACEBOOK` - Facebook Messenger

        * `INSTAGRAM` - Instagram Messaging

        * `KAKAO` - Kakao

        * `LINE` - Line

        * `MMS` - MMS

        * `RCS` - RCS

        * `TELEGRAM` - Telegram

        * `VIBER` - Viber

        * `VOICE_VIDEO` - Voice and Video

        * `WHATSAPP` - WhatsApp

        * `ZALO` - Zalo

        * `APPLE_MB` - Apple Messages for Business

        '
      enum:
      - SMS
      - EMAIL
      - FACEBOOK
      - INSTAGRAM
      - KAKAO
      - LINE
      - MMS
      - RCS
      - TELEGRAM
      - VIBER
      - VOICE_VIDEO
      - WHATSAPP
      - ZALO
      - APPLE_MB
      minLength: 1
      title: ChannelCode
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.NumberStatus:
      type: string
      description: Status of the number.
      enum:
      - SUCCESS
      title: NumberStatus
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.VoiceVideoSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        subscriptionId:
          type: string
          description: Subscription ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once a subscription is created.
          maxLength: 255
          minLength: 1
        name:
          type: string
          description: A human-readable description for your subscription, can be changed at a later point.
          maxLength: 255
          minLength: 1
        events:
          type: array
          description: List of events available for a subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](https://www.infobip.com/docs/cpaas-x/subscriptions-management/event-subscriptions). If configuring inbound Subscription, check [inbound message configuration docs](https://www.infobip.com/docs/cpaas-x/subscriptions-management/inbound-message-configuration).
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleVoiceVideoEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could only be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ProfileRequest'
      required:
      - events
      - profile
      - subscriptionId
      title: Voice and Video
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageInfo:
      type: object
      description: Information about the sender coverage.
      properties:
        resource:
          type: string
          description: Resource name.
          example: MyResource
        shared:
          type: boolean
          description: Indicates whether a resource is shared.
        originalResourceName:
          type: string
          description: Original resource name.
          example: MyOriginalResource
        countryCode:
          type: string
          description: Country code in two-letter ISO standard. Required for identifying country specific resources (for instance, short code number types).
          example: GB
          pattern: ^[A-Z]{2}$
        countryName:
          type: string
          description: Country name.
          example: United Kingdom
        capabilities:
          type: array
          items:
            $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCapability'
          uniqueItems: true
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      title: Viber
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.GeneralStatus:
      type: string
      description: "\nSpecifies the general status code groups.\n\nFor the list of possible values, refer to\n[general status codes](https://www.infobip.com/docs/essentials/response-status-and-error-codes#general-error-codes).\n        "
      enum:
      - PENDING
      - UNDELIVERABLE
      - DELIVERED
      - EXPIRED
      - REJECTED
      title: GeneralStatus
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataResponse:
      type: object
      properties:
        requestId:
          type: string
          description: The identifier of the submitted request.
      required:
      - requestId
      title: QueryAggregateDataResponse
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.AggregateDataResponse:
      type: object
      properties:
        requestedPeriod:
          allOf:
          - $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.DateTimeInterval'
          description: The actual time period used for data filtering, expressed as a date range. May differ from the requested range because the requested range may be aligned to the aggregation granularity, and, where applicable, trimmed to finalized periods only.
        totalRows:
          type: integer
          format: int32
          description: Total number of data rows.
        columns:
          type: array
          description: List of columns available in the response data rows.
          items:
            $ref: '#/components/schemas/99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.ColumnInfo'
          uniqueItems: true
        rows:
          type: array
          description: Array of data rows, where each row shows the aggregated data for one combination of the requested dimensions. Values map to the columns array by index. If a metric is not available for a given channel, the corresponding value is "N/A".
          items:
            type: array
            description: Values of a row, ordered as specified by columns property.
            items:
              type: object
              description: Values of a row, ordered as specified by columns property.
      required:
      - columns
      - requestedPeriod
      - rows
      - totalRows
      title: AggregateDataResponse
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.RcsWebhookStatusNotifApiDoc:
      type: object
      properties:
        id:
          type: string
          description: ID of the resource request.
        status:
          type: string
          description: Status of the resource request.
          enum:
          - UPDATE_REQUESTED
          - UPDATE_REQUESTED_BY_INTERNAL_REVIEWER
          - REJECTED
          - COMPLETED
        type:
          type: string
          description: Type of resource.
          enum:
          - RCS_SENDER_LAUNCH
        requirementsFeedback:
          type: array
          description: Feedback for requirements. Present only for UPDATE_REQUESTED and UPDATE_REQUESTED_BY_INTERNAL_REVIEWER statuses.
          items:
            $ref: '#/components/schemas/c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.FilledRequirementFeedbackApiDoc'
        note:
          type: string
          description: A note containing extra data about the request.
      required:
      - id
      - status
      title: RCS_SENDER_LAUNCH
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceCoverageKey:
      type: object
      discriminator:
        propertyName: resourceType
        mapping:
          ALPHANUMERIC: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AlphaCoverageKey'
          NUMBER: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.NumberCoverageKey'
          RCS_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.RcsCoverageKey'
          VIBER_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.ViberCoverageKey'
          APPLE_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.AppleCoverageKey'
          OPEN_CHANNEL_RESOURCE: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.OpenChannelCoverageKey'
      properties:
        resourceType:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.IbResourceType'
      required:
      - resourceType
      title: IbResourceCoverageKey
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.BrandRegistrar:
      type: string
      description: The name of the registrar with which the brand has been registered.
      enum:
      - CAMPAIGN_REGISTRY
      title: BrandRegistrar
    ApiRequestError:
      type: object
      properties:
        serviceException:
          $ref: '#/components/schemas/ApiRequestErrorDetails'
      title: ApiRequestError
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultCta:
      type: object
      description: Call-to-action suggestion generated by the campaign builder
      properties:
        promotionMethod:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PromotionMethodType'
        description:
          type: string
          description: Description of the call-to-action
      title: CampaignBuilderResultCta
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.CampaignReference:
      type: object
      description: Campaign reference, if matched by the Infobip platform.
      properties:
        campaignId:
          type: integer
          format: int32
          description: ID of the campaign or flow.
        campaign:
          type: string
          description: ID that allows you to track, analyze, and show an aggregated overview and the performance of individual campaigns per sending channel.
        versionId:
          type: integer
          format: int32
          description: ID of the version of the campaign created over Infobip Portal.
      title: CampaignReference
    aa47d40354ee197e21ffad52d2c543bd4f729e250360a844e476aa80deff7b6e.Verification:
      type: object
      properties:
        msisdn:
          type: string
          description: Phone number (MSISDN) for which verification status is checked.
          readOnly: true
          writeOnly: false
        sentAt:
          type: integer
          format: int64
          description: Sent UNIX timestamp (in millis), if the phone number (MSISDN) is verified.
          readOnly: true
          writeOnly: false
        verified:
          type: boolean
          description: Indicates if the phone number (MSISDN) is already verified for 2FA application with given ID.
          readOnly: true
          writeOnly: false
        verifiedAt:
          type: integer
          format: int64
          description: Verification UNIX timestamp (in millis), if the phone number (MSISDN) is verified.
          readOnly: true
          writeOnly: false
      title: Verification
    bb8af9c2d2d4d677e25555100e31662e23d86ede8b5d73bbf4974b4decdd08d7.Session:
      type: object
      properties:
        token:
          type: string
          description: Session with Token
      title: Session
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStatusWebhookMessage'
      title: CampaignStatusWebhookResponse
    2c1d05f3dc2f46851efe83e0fa7d26e3f8a2e8ee522f9adaaba58b0a33a2be33.SourceType:
      type: string
      description: 'Represents the way blocklist record was created:


        CUSTOM - blocklist record that was created manually


        MO - blocklist record automatically created once an end user unsubscribes by replying with a specific keyword (e.g.: STOP). This is applicable for the following channels: SMS, MMS.


        URL_OPT_OUT - blocklist record automatically created once an end user clicks an opt-out link included in the message.


        CAMPAIGN - blocklist record automatically created through a triggered event in the Flow (e.g., if the message was not opened in 24h, add to blocklist).


        If source type is omitted while deleting, all blocklists that match delete request will be deleted regardless of the source type.'
      enum:
      - CUSTOM
      - MO
      - URL_OPT_OUT
      - CAMPAIGN
      title: SourceType
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookResponse:
      type: object
      properties:
        results:
          type: array
          description: Incoming events
          items:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignAiFeedbackWebhookMessage'
      title: CampaignAiFeedbackWebhookResponse
    e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CreateCatalogDto:
      type: object
      properties:
        name:
          type: string
          description: Catalog name.
          example: Catalog Name
        description:
          type: string
          description: Catalog description.
          example: Catalog description
        type:
          $ref: '#/components/schemas/e6e93dd514df725f71bff0da51b4f6588e807f5cb84f3d1063a226fc7a7537eb.CatalogTypes'
      required:
      - description
      - name
      - type
      title: CreateCatalogDto
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleSmsEvents:
      type: string
      enum:
      - CLICK
      - DELIVERY
      - INBOUND_MESSAGE
      title: Event
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.AppleMessagesForBusinessNoIdSubscriptionRequest:
      type: object
      description: Subscription group.
      properties:
        name:
          type: string
          description: Subscription group name.
          maxLength: 255
          minLength: 1
        profile:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.IdOnlyProfileRequest'
        events:
          type: array
          description: List of events available for subscription. Note that a set of events available for each channel is different; subscription to events that are unavailable for a certain channel will be ignored. For more details, see the [availability table](/docs/cpaas-x/subscriptions-management#availability). In case you are configuring inbound Subscription please check all the details [available here](/docs/cpaas-x/subscriptions-management#inbound-message-configuration).
          items:
            oneOf:
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SimpleAppleMessagesForBusinessEvents'
            - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.FormatAwareAppleMessagesForBusinessEvents'
          maxItems: 255
          minItems: 0
        criteria:
          type: array
          description: Application and Entity pair to match. You can set the rule to match only Application or only Entity if necessary, omitting the other item.
          items:
            $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.ApplicationEntityPair'
          maxItems: 255
          minItems: 0
        resources:
          type: array
          description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
          items:
            type: string
            description: List of resources to match. At the moment, this could be a sender name (whether numeric or alpha) used on message submit.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
        users:
          type: array
          description: List of users to match. You can provide usernames from your account.
          items:
            type: string
            description: List of users to match. You can provide usernames from your account.
            maxLength: 255
            minLength: 0
            x-is-early-access: 'true'
          maxItems: 255
          minItems: 0
          x-is-early-access: 'true'
      required:
      - events
      - profile
      title: Apple Messages For Business
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateMessageContent:
      type: object
      description: Content of the message.
      properties:
        header:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateHeader'
        body:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateBody'
        buttons:
          type: array
          description: List of buttons of a template message.
          items:
            $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiTemplateButton'
        expirationTime:
          type: string
          description: 'Expiration time of a limited-time offer template message. Has the following format: yyyy-MM-dd''T''HH:mm:ss.SSSZ.'
      title: MessagesApiTemplateMessageContent
    c8df889022018062dfcb44e930a391e7e1c8e669bd11a10a717da508b9ae3dcf.Platform:
      type: object
      description: CPaaS X properties.
      properties:
        applicationId:
          type: string
          description: ID of the Application that would be associated with the resource request.
          example: application-id
          externalDocs:
            description: Find out more about Application and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
        entityId:
          type: string
          description: ID of the Entity that would be associated with the resource request.
          example: entity-id
          externalDocs:
            description: Find out more about Application and Entity Management
            url: https://www.infobip.com/docs/api/platform/application-entity
          maxLength: 255
          minLength: 0
      title: Platform
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CertificateConnectionTestRequest:
      type: object
      properties:
        certificateId:
          type: string
          description: Existing certificate identifier.
          maxLength: 255
          minLength: 1
        webhookUrl:
          type: string
          description: A webhook URL over which a connectivity test will be performed.
      required:
      - certificateId
      - webhookUrl
      title: CertificateConnectionTestRequest
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload:
      type: object
      description: Webhook security credentials.
      oneOf:
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.BasicCredentialsPayload'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.HmacCredentialsPayload'
      - $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.OauthCredentialsPayload'
      title: Credentials
    99c561addf74bb07fd67942658f68818323ce564cc5eef645d487517ca1425f2.QueryAggregateDataStatus:
      type: string
      description: Status of the request. If successful, the response will contain aggregated data. If failed, it will contain failure message.
      enum:
      - SUCCESS
      - FAILED
      title: QueryAggregateDataStatus
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageStatus:
      type: object
      description: Indicates the [status](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) of the message and how to recover from an error should there be any.
      properties:
        groupId:
          type: integer
          format: int32
          description: Status group ID.
        groupName:
          $ref: '#/components/schemas/899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessageGeneralStatus'
        id:
          type: integer
          format: int32
          description: Status code ID.
        name:
          type: string
          description: '[Status code](https://www.infobip.com/docs/essentials/response-status-and-error-codes#api-status-codes) name.'
        description:
          type: string
          description: Human-readable description of the status.
        action:
          type: string
          description: Action to take to recover from the error.
      title: MessageStatus
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaignBuilderResultMessageFlow:
      type: object
      description: Campaign message flow for Toll Free Number campaigns
      properties:
        exampleMessage:
          type: string
          description: Example message
      title: TollFreeCampaignBuilderResultMessageFlow
    4527871876f1b326359cd9e5dcf777f0ecc3c5fde89b1e88f0c154b298b67611.Direction:
      type: string
      description: Emergency Service address direction.
      enum:
      - NORTH
      - EAST
      - SOUTH
      - WEST
      title: Direction
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultData:
      type: object
      allOf:
      - $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultData'
      - type: object
        properties:
          useCase:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeUseCase'
          messageFlow:
            $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ShortCodeCampaignBuilderResultMessageFlow'
          cta:
            type: array
            description: Call-to-action suggestions.
            items:
              $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignBuilderResultCta'
          termsConditions:
            type: string
            writeOnly: true
          privacyPolicy:
            type: string
            writeOnly: true
      description: Campaign builder result for Short Code campaigns.
      title: ShortCodeCampaignBuilderResultData
    2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.Campaign:
      type: object
      discriminator:
        propertyName: type
        mapping:
          TEN_DIGIT_LONG_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TenDlcCampaign'
          EXTERNAL_TEN_DIGIT_LONG_CODE: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.ExternalTenDlcCampaign'
          TOLL_FREE_NUMBER: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.TollFreeCampaign'
      properties:
        id:
          type: string
          format: uuid
          description: The identifier for the campaign.
          readOnly: true
        referenceId:
          type: string
          description: Unique user defined ID for the campaign. While not required, it is recommended to supply a referenceId as the uniqueness constraint will help ensure a campaign is not accidentally created multiple times. Subsequent create requests with the same referenceId will be rejected with an error.
          maxLength: 50
          minLength: 0
        applicationId:
          type: string
          description: CPaaS X property identifying an application, a use case or an environment on your system. It should only be set if you are using CPaaS X Applications with your traffic.
        entityId:
          type: string
          description: CPaaS X property identifying an unique actor on your system. Should only be set if you are using CPaaS X Applications with your traffic.
        name:
          type: string
          description: The name of the campaign.
          maxLength: 30
          minLength: 1
          pattern: '[A-Za-z0-9_ ]*'
        createdDate:
          type: string
          format: date-time
          description: The date and time when the campaign was created.
          readOnly: true
        lastModifiedDate:
          type: string
          format: date-time
          description: The date and time when the campaign was last modified.
          readOnly: true
        stage:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignStage'
        priority:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.PriorityInfo'
        campaignFeedback:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignFeedback'
        type:
          $ref: '#/components/schemas/2700ea5ecfd0574f21019319e90eb63416ede8263eab67e466c718c51cd1a77a.CampaignType'
      required:
      - name
      title: Campaign
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.SpeedLimitTimeUnit:
      type: string
      default: MINUTE
      description: The time unit to define when setting a messaging speed limit. Defaults to `MINUTE`.
      enum:
      - MINUTE
      - HOUR
      - DAY
      title: SpeedLimitTimeUnit
    7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationResponse:
      type: object
      description: Whitelist or blacklist the traffic of MT messages.
      properties:
        type:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockListConfigurationType'
        level:
          $ref: '#/components/schemas/7c77a2c703ce12a601f120565936de62cf48d1baf9232d5411f82fc339353553.BlockLevelResponse'
      required:
      - level
      - type
      title: BlockListConfigurationResponse
    899caf445aab842b03fe1d74e4afd7097f0161dae66538ffa05bba2f153d708f.MessagesApiDelivery:
      type: object
      description: Provides options for configuring the delivery report behavior.
      properties:
        url:
          type: string
          description: 'The URL on your call back server where a delivery report will be sent. If your URL becomes unavailable then the [retry cycle](https://www.infobip.com/docs/sms/api#notify-url) uses the following formula: `1min + (1min * retryNumber * retryNumber)`.'
        intermediateReport:
          type: boolean
          description: The real-time intermediate delivery report containing GSM error codes, messages status, pricing, network and country codes, etc., which will be sent on your callback server. The default setting is `false`.
        receiveTriggeredFailoverReports:
          type: boolean
          description: Allows you to receive delivery reports for all triggered failover steps, not just the final one (either the first successful or the last failed step). The default setting is `false`.
      title: MessagesApiDelivery
    6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.SecurityRequest:
      type: object
      description: Security settings object holding the authentication settings necessary to access your webhook. Should only be provided if you are creating a new profile and settings; otherwise it will be ignored.
      properties:
        authId:
          type: string
          description: Unique security setting ID. Used as part of a URL path and must not include any characters that require URL encoding. You cannot change the ID once an item is created.
          maxLength: 255
          minLength: 1
        type:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsType'
        credentials:
          $ref: '#/components/schemas/6e71a232d29cf86cbe8cd24bd719c2050de4613347854f985c920dd3d0d3e33f.CredentialsPayload'
      required:
      - authId
      title: Security
  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"
    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"
    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"
    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"
    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"
    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"
    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"
    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: {}