swagger: "2.0"
info:
  description: Synivere Communication Gateway API
  version: 1.0.0
  title: SCG API
host: api.syniverse.com
basePath: /scg-external-api/api/v1
schemes:
- https
produces:
- application/json
paths:
  /messaging/sender_ids:
    get:
      tags:
      - Sender ID
      summary: Retrieve the list of matching sender addresses
      description: '  Retrieve the list of matching sender addresses'
      parameters:
      - name: id
        in: query
        description: |
          unique id of the sender address
        required: false
        type: string
      - name: name
        in: query
        description: |
          name of the sender address
        required: false
        type: string
      - name: state
        in: query
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
        required: false
        type: string
      - name: country
        in: query
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_2'
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect  \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource \n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state   <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Sender ID
      summary: Creates a Sender ID
      description: '  Creates a Sender ID'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Sender ID
        required: false
        schema:
          $ref: '#/definitions/Sender_ID'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit  \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect  \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource \n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state \n    <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter> \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Sender ID
      summary: Delete the list of matching sender addresses
      description: '  Delete the list of matching sender addresses'
      parameters:
      - name: id
        in: query
        description: |
          unique id of the sender address
        required: false
        type: string
      - name: parent_id
        in: query
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
        required: false
        type: string
      - name: name
        in: query
        description: |
          name of the sender address
        required: false
        type: string
      - name: ownership
        in: query
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
        required: false
        type: string
      - name: class_id
        in: query
        description: |
          reference to the sender address class that determines the priority and throughput of the configured sender id
        required: false
        type: string
      - name: type_id
        in: query
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
        required: false
        type: string
      - name: state
        in: query
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
        required: false
        type: string
      - name: country
        in: query
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
        required: false
        type: string
      - name: consent_managed_by
        in: query
        description: |
          Possible values: USER, SCG or SCG_UNSOLICITED_OPT_OUT. Default is USER
        required: false
        type: string
      - name: capabilities
        in: query
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, VOICE, WhatsApp etc.
        required: false
        type: string
      - name: check_white_list
        in: query
        description: |
          If set, sending via this sender ID is limited to recipients present in the customer's white list.
        required: false
        type: boolean
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was us
        required: false
        type: string
      - name: register_number
        in: query
        description: |
          When the 'register_number' can be set to 'true' or 'false'. When set to 'true', this instructs SCG to register a Telephone number with the appropriate Operator or Registration entity.
        required: false
        type: string
      responses:
        "204":
          description: "Successful operation. \n"
          schema:
            properties:
              del_qty:
                type: string
                description: The quantity of deleted items.
              err_qty:
                type: string
                description: The quantity of errors.
              err_msg:
                type: string
                description: A human readable description of the error.
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state   <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/sender_ids/purchase':
    post:
      tags:
      - Sender ID
      summary: Purchase a Sender Address
      description: '  Purchase a Sender Address'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Sender ID Purchase
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_Purchase'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/sender_ids/{Sender_ID}':
    get:
      tags:
      - Sender ID
      summary: Retrieve a specified Sender ID
      description: '  Retrieve a specified Sender ID'
      parameters:
      - name: Sender_ID
        in: path
        description: The Sender ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_2_list'
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state \n    <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter> \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter> n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Sender ID
      summary: Update a Sender ID
      description: '  Update a Sender ID'
      consumes:
      - application/json
      parameters:
      - name: Sender_ID
        in: path
        description: The Sender ID for this resource.
        required: true
        type: string
      - in: body
        name: Sender ID
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state \n    <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Sender ID
      summary: Delete a Sender ID
      description: '  Delete a Sender ID '
      parameters:
      - name: Sender_ID
        in: path
        description: The Sender ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: "Successful operation. \n"
          schema:
            properties:
              del_qty:
                type: string
                description: The quantity of deleted items.
              err_qty:
                type: string
                description: The quantity of errors.
              err_msg:
                type: string
                description: A human readable description of the error.
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **4030** - Forbidden          \n  * **4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **4032** - Attachment <parameter> is in incorrect state \n    <parameter>                       \n  * **4033** - SenderId start date in the future: <parameter>           \n  * **4034** - SenderId end date in the past: <parameter>          \n  * **4035** - Invalid sender ID state: <parameter>         \n  * **4036** - Invalid sender ID ownership: <parameter>           \n  * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n* **404** - Error message contains details about the missing resource - Requested resource not found  \n* **4040** - Resource you are trying to fetch not found for <parameter>          \n* **4041** - Resource you are trying to update cannot be found for <parameter>        \n* **4042** - No mdn is found       \n* **4043** - The language code <language> is not found among the languages supported by Google Translate        \n* **4044** - Non-shortcode senderId is found.                 \n* **4045** - No sender id matches with recipient country.        \n* **4046** - Access token expired n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n* **500** - Server Error - Internal server error. Please report\n* **5000** - Unexpected Server Error\n* **5001** - Unexpected Non Retriable Server Error          \n* **5002** - Message type restriction not implemented for: <messageType>            \n* **5003** - Error redirecting to proxy: <parameter>                      \n* **5004** - Error downloading attachment from storage: <parameter> \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/sender_ids/list:
    get:
      tags:
      - Sender ID
      summary: Retrieve the list of matching Sender addresses with the filter
      description: 'Retrieve the list of sender addresses which matches the name'
      parameters:   
      - name: name
        in: query
        description: |
          Name to search for, can include partial matches of the sender name.
        required: false
        type: string
        
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_2_list_limited'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/channels:
    get:
      tags:
      - Channel
      summary: List available Private Channels
      description: '  List available Private Channels'
      parameters:
      - name: id
        in: query
        description: |
          The channel identifier, allocated by SCG when channel is created
        required: false
        type: string
      - name: name
        in: query
        description: |
          User Specified Name of the Channel
        required: false
        type: string
      - name: priority
        in: query
        description: |
          Determines the channel priority: high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
        required: false
        type: string
      - name: description
        in: query
        description: |
          Description of the Channel
        required: false
        type: string
      - name: ownership
        in: query
        description: |
          SHARED/PRIVATE/PUBLIC
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_4'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Channel
      summary: Create a Private Channel
      description: '  Create a Private Channel'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Channel
        required: false
        schema:
          $ref: '#/definitions/Channel'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/channels/{Channel_ID}':
    get:
      tags:
      - Channel
      summary: Retrieve a specified Channel
      description: '  Retrieve a specified Channel'
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_4_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Channel
      summary: Update a channel ID with attributes
      description: '  Update a channel ID with attributes'
      consumes:
      - application/json
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      - in: body
        name: Channel
        required: false
        schema:
          $ref: '#/definitions/Channel_2'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Channel
      summary: Replaces the specific Channel ID. All mandatory fields must be present.
      description: '  Replaces the specific Channel ID. All mandatory fields must be present.'
      consumes:
      - application/json
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      - in: body
        name: Channel
        required: false
        schema:
          $ref: '#/definitions/Channel_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Channel
      summary: Delete a specified Private Channel
      description: '  Delete a specified Private Channel'
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/channels/{Channel_ID}/sender_ids':
    get:
      tags:
      - Channel
      summary: List Sender IDs associated with a Channel
      description: '  List Sender IDs associated with a Channel'
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          unique id of the sender address
        required: false
        type: string
      - name: parent_id
        in: query
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
        required: false
        type: string
      - name: name
        in: query
        description: |
          name of the sender address
        required: false
        type: string
      - name: ownership
        in: query
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
        required: false
        type: string
      - name: class_id
        in: query
        description: |
          reference to the sender address class that determines the priority and throughput of the configured sender id
        required: false
        type: string
      - name: type_id
        in: query
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
        required: false
        type: string
      - name: state
        in: query
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
        required: false
        type: string
      - name: country
        in: query
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
        required: false
        type: string
      - name: consent_managed_by
        in: query
        description: |
          Possible values: USER, SCG or SCG_UNSOLICITED_OPT_OUT. Default is USER
        required: false
        type: string
      - name: capabilities
        in: query
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, VOICE, WhatsApp etc.
        required: false
        type: string
      - name: check_white_list
        in: query
        description: |
          If set, sending via this sender ID is limited to recipients present in the customer's white list.
        required: false
        type: boolean
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was us
        required: false
        type: string
      - name: register_number
        in: query
        description: |
          When the 'register_number' can be set to 'true' or 'false'. When set to 'true', this instructs SCG to register a Telephone number with the appropriate Operator or Registration entity.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_2'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Channel
      summary: Add sender_id(s) to a channel
      description: '  Add sender_id(s) to a channel'
      consumes:
      - application/json
      parameters:
      - name: Channel_ID
        in: path
        description: The Channel ID for this resource.
        required: true
        type: string
      - in: body
        name: Sender ID
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_2'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/channels/{channel_ID}/sender_ids/{sender_ID}':
    delete:
      tags:
      - Channel
      summary: Removes the senderId from channel
      description: '  Removes the senderId from channel'
      parameters:
      - name: channel_ID
        in: path
        description: The channel ID for this resource.
        required: true
        type: string
      - name: sender_ID
        in: path
        description: The sender ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/message_requests/:
    get:
      tags:
      - Message Request
      summary: Retrieve all message requests
      description: '  Retrieve all message requests'
      parameters:
      - name: id
        in: query
        description: |
          The unique identifier for the message request
        required: false
        type: string
      - name: from
        in: query
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To= send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n example: channel:1KJPMkuHQkair_o15etpmg"
        required: false
        type: string
      - name: to
        in: query
        description: |
          For MT messages this will be a list of one or more recipient addresses, contact ids, contact group ids
          example
        required: false
        type: string
      - name: state
        in: query
        description: |
          The status of the message request:
          - SUBMITTED
          - ACCEPTED
          - REJECTED
          - PREPARING (while in the preparing state, the recipient cont may increase with time i.e. SCG will keep track of the preparing step to allow polling on the resource to have user see progress)
          - TRANSMITTING (while in the transmission state, the sent count will be updates as the messages are being sent)
          - COMPLETED
          - PAUSED (SCG will go into this state after preparing if pause flag is set)
          - CANCELED  (cancel can be requested at any time)
          NOTE: to resume paused messages, the status should be updated by customer from PAUSED to TRANSMITTING
        required: false
        type: string
      - name: test_message_flag
        in: query
        description: |
          This is a test mode flag for performing basic functional tests. If this flag is set to 'true' then this will be processed and Out bound messages will be created but the messages will not be delivered to a handset.
        required: false
        type: boolean
      - name: pause_before_transmit
        in: query
        description: |
          This is a flag that tells SCG to generate the messages but not to deliver them.
        required: false
        type: boolean
      - name: pause_expiry_time
        in: query
        description: |
          This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integer pause expiry time, the message request will fail
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          For a MT sent via this API, this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediate channel.
        required: false
        type: string
      - name: sent_date
        in: query
        description: "The timestamp when the message was submitted to downstream system for delivery.\nExample: \"2023-05-24T23:24:37.464Z\"  \n"
        required: false
        type: string
        pattern: yyyy-mm-dd'T'HH:mm:ss.SSS'Z'
      - name: delivered_date
        in: query
        description: |
          The timestamp when the message has been delivered, corresponds to DR date.
          Example: "2023-05-24T23:24:37.464Z"
        required: false
        type: string
        pattern: yyyy-mm-dd'T'HH:mm:ss.SSS'Z'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_5'
        "400":
          description: "Bad Request.  The request could not be understood by the server. \n  * **400** - Bad Request - Error Message provides information about what's wrong with the request \n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit \n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length   \n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **4001** - Required parameter<parameter> missing or is null \n  * **4002** - Required parameter <parameter> data type/format is incorrect \n  * **4003** - Optional parameter <parameter> data type/format is incorrect\n  * **4004** - Invalid parameter <parameter> defined \n  * **4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **4006** - Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length\n  * **4007** - Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid\n  * **4008** - Message scheduled time exceeds max allowed days: <parameter>\n  * **4009** - Cannot exceed more than <parameter> media URLs\n  * **40010** - Cannot include media URLs with attachment\n  * **40011** - Group message only supported for US Phone numbers\n  * **40012** - No sender addresses capable of sending requested message type\n  * **40013** - No sender addresses capable of sending requested verifiedSms message\n  * **40014** - Cannot failover to SMS on a message with attachments\n  * **40015** - Cannot exceed more than <parameter> recipients\n  * **40016** - Sender id is not capable of sending MMS\n  * **40017** - Only sender id with type id LONGCODE is supported for group MMS\n  * **40018** - Invalid senderId/address: <parameter>\n  * **40019** - Multiple sender id with address: <parameter>. Use sender id to send message.\n  * **40020** - Unrecognized option(s): <parameter>\n  * **40021** - Failover to SMS requires a SenderId for SMS (use a channel)\n  * **40022** - Failover TO SMS requires a SenderId for <parameter> (use a channel)\n  * **40023** - Delivery Window Restriction Violation\n  * **40024** - Invalid Recipient \n  * **40025** - Invalid payload\n  * **40026** - Missing form-data part: <part>\n  * **40027** - Content size in Content-Disposition is mandatory\n  * **40028** - Content length is mandatory\n  * **40029** - Attachment size <parameter> exceeds max allowed attachment size <parameter>\n  * **40030** - Only UPLOADED attachments can be downloaded.\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource. \n * **403** - Forbidden - Access to this resource is not allowed with the current application token \n * **4030** - Forbidden \n * **4031** - Attachment <parameter> was not found neither in cache nor in database \n * **4032** - Attachment <parameter> is in incorrect state <parameter> \n * **4033** - SenderId start date in the future: <parameter> \n * **4034** - SenderId end date in the past: <parameter> \n * **4035** - Invalid sender ID state: <parameter> \n * **4036** - Invalid sender ID ownership: <parameter> \n * **4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found. \n * **404** - Error message contains details about the missing resource - Requested resource not found \n * **4040** - Resource you are trying to fetch not found for <parameter> \n * **4041** - Resource you are trying to update cannot be found for <parameter> \n * **4042** - No mdn is found \n * **4043** - The language code <language> is not found among the languages supported by Google Translate \n * **4044** - Non-shortcode senderId is found. \n * **4045** - No sender id matches with recipient country. \n * **4046** - Access token expired \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request. \n * **500** - Server Error - Internal server error. Please report \n * **5000** - Unexpected Server Error \n * **5001** - Unexpected Non Retriable Server Error \n * **5002** - Message type restriction not implemented for: <messageType> \n * **5003** - Error redirecting to proxy: <parameter> \n * **5004** - Error downloading attachment from storage: <parameter>"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Message Request
      summary: Send a Message
      description: '  Send a Message'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Message Request
        required: false
        schema:
          $ref: '#/definitions/Message_Request'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid \n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.              \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n  * **500** - Server Error - Internal server error. Please report \n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/message_requests/{MessageRequest_ID}':
    get:
      tags:
      - Message Request
      summary: Retrieve message requests using a message request Id
      description: '  Retrieve message requests using a message request Id'
      parameters:
      - name: MessageRequest_ID
        in: path
        description: The MessageRequest ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_5_list'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.              \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Message Request
      summary: Delete a message request
      description: '  Delete a message request'
      parameters:
      - name: MessageRequest_ID
        in: path
        description: The MessageRequest ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/message_requests/{MessageRequest_ID}/messages':
    get:
      tags:
      - Message Request
      summary: Retrieve messages using a Message request Id
      description: '  Retrieve messages using a Message request Id'
      parameters:
      - name: MessageRequest_ID
        in: path
        description: The MessageRequest ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          Unique identifier
        required: false
        type: string
      - name: message_request_id
        in: query
        description: |
          The unique id of the associated message request resource.
        required: false
        type: string
      - name: external_transaction_ids
        in: query
        description: |
          This is list of id-s (one for every fragment) issued for this message by the downstream messaging system.
        required: false
        type: string
      - name: direction
        in: query
        description: |
          Message direction: MO for received messages and MT sent messages
        required: false
        type: string
      - name: from_address
        in: query
        description: |
          The sender address.
        required: false
        type: string
      - name: to_address
        in: query
        description: |
          The recipient address.
        required: false
        type: string
      - name: state
        in: query
        description: "The status of the message to this recipient.  \nValid values for MT messages are:\n- CREATED (message was created and is in the queue of SCG)\n- SENT (message was sent to the outbound delivery system)\n- DELIVERED (message was delivered to end-device of the user)\n- READ (message was read by the user)\n- CONVERTED (message was converted i.e. end user took action upon message)\n- FAILED (message delivery failed)\n- EXPIRED (message was too old to be sent)\n- SCHEDULED (message is created but not submitted for sending)\n- TEST (message was created but the request was a test request)\n- PAUSED (message was created but the request was to pause before delivery)\n- DELETED \nSCG will automatically set the status of the message to converted when the message contains a 'tracked' URL and the link was clicked by the recipient.\nAlternatively the customer also externally can track conversion and could update the message status put applying the PUT method and specifying status = CONVERTED and the conversion timestamp\nValid values for MO Messages are:\n- RECEIVED (received at SCG)\n- PROCESSED (when the customer has accessed the message and updated the status)\n- DELETED (when the message was deleted by the customer)\n"
        required: false
        type: string
      - name: sent_date
        in: query
        description: |
          The timestamp when the message was submitted to downstream system for delivery
        required: false
        type: string
      - name: delivered_date
        in: query
        description: |
          The timestamp when the message has been delivered, corresponds to DR date.
        required: false
        type: string
      - name: type
        in: query
        description: |
          The message type (SMS, MMS, PSH, FB)
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The timestamp when the message was created, which corresponds to the time when the bulk message POST was done by the client.
        required: false
        type: string
      - name: from
        in: query
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
        required: false
        type: string
      - name: pause_before_transmit
        in: query
        description: |
          This is a flag that tells SCG to generate the messages but not to deliver them.
        required: false
        type: boolean
      - name: pause_expiry_time
        in: query
        description: |
          This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integer pause expiry time, the message request will fail
        required: false
        type: string
      - name: to
        in: query
        description: |
          Recipient address or contact id.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_6'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.              \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token \n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state    <parameter>                      \n * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/message_requests/scheduled/{MessageRequest_Scheduled_ID}':
    delete:
      tags:
      - Scheduled Message Request
      summary: Delete a scheduled message request
      description: '  Delete a scheduled message request'
      parameters:
      - name: MessageRequest_Scheduled_ID
        in: path
        description: The Scheduled MessageRequest ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1012** - Error message contains details about the limit being exceeded - Message size exceeds system limit\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **1020** - Invalid Tracking URL - The tracking URL that was provided is invalid\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.              \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/messages:
    get:
      tags:
      - Message
      summary: Retrieve messages
      description: '  Retrieve messages  '
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier
        required: false
        type: string
      - name: message_request_id
        in: query
        description: |
          The unique id of the associated message request resource.
        required: false
        type: string
      - name: direction
        in: query
        description: |
          Message direction: MO for received messages and MT sent messages
        required: false
        type: string
      - name: from_address
        in: query
        description: |
          The sender address.
        required: false
        type: string
      - name: to_address
        in: query
        description: |
          The recipient address.
        required: false
        type: string
      - name: state
        in: query
        description: "The status of the message to this recipient.  \nValid values for MT messages are:\n- CREATED (message was created and is in the queue of SCG)\n- SENT (message was sent to the outbound delivery system)\n- DELIVERED (message was delivered to end-device of the user)\n- READ (message was read by the user)\n- CONVERTED (message was converted i.e. end user took action upon message)\n- FAILED (message delivery failed)\n- EXPIRED (message was too old to be sent)\n- SCHEDULED (message is created but not submitted for sending)\n- TEST (message was created but the request was a test request)\n- PAUSED (message was created but the request was to pause before delivery)\n- DELETED \nSCG will automatically set the status of the message to converted when the message contains a 'tracked' URL and the link was clicked by the recipient.\nAlternatively the customer also externally can track conversion and could update the message status put applying the PUT method and specifying status = CONVERTED and the conversion timestamp\nValid values for MO Messages are:\n- RECEIVED (received at SCG)\n- PROCESSED (when the customer has accessed the message and updated the status)\n- DELETED (when the message was deleted by the customer)\n"
        required: false
        type: string
      - name: sent_date
        in: query
        description: "The timestamp when the message was submitted to downstream system for delivery.\nExample: \"2023-05-24T23:24:37.464Z\"  \n"
        required: false
        type: string
        pattern: yyyy-mm-dd'T'HH:mm:ss.SSS'Z'
      - name: delivered_date
        in: query
        description: |
          The timestamp when the message has been delivered, corresponds to DR date.
          Example: "2023-05-24T23:24:37.464Z"
        required: false
        type: string
        pattern: yyyy-mm-dd'T'HH:mm:ss.SSS'Z'
      - name: type
        in: query
        description: |
          The message type (SMS, MMS, PSH, FB)
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The timestamp when the message was created, which corresponds to the time when the bulk message POST was done by the client.
          Example: 2023-03-20T14:14:14.672Z
        required: false
        type: string
        pattern: yyyy-mm-dd'T'HH:mm:ss.SSS'Z'
      - name: from
        in: query
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n  example: channel:1KJPMkuHQkair_o15etpmg"
        required: false
        type: string
      - name: pause_before_transmit
        in: query
        description: |
          This is a flag that tells SCG to generate the messages but not to deliver them.
        required: false
        type: boolean
      - name: pause_expiry_time
        in: query
        description: |
          This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integer pause expiry time, the message request will fail
        required: false
        type: string
      - name: to
        in: query
        description: |
          Recipient address or contact id.
          example: fyX3rO7eL48xj2HNXNWIu4
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_6'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_400**5 - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.\n  \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Message
      summary: Send a Message
      description: '  Send a Message'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Message
        required: false
        schema:
          $ref: '#/definitions/Message'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.\n  \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/messages/{Message_ID}':
    get:
      tags:
      - Message
      summary: Returns current version of the specified message
      description: '  Returns current version of the specified message'
      parameters:
      - name: Message_ID
        in: path
        description: The Message ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_6_list'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients**          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.\n  \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Message
      summary: Update Message Status to DELETED
      description: '  Update Message Status to DELETED'
      parameters:
      - name: Message_ID
        in: path
        description: The Message ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/messages/{Message_ID}/attachments':
    get:
      tags:
      - Message
      summary: Returns a list of matching attachments
      description: '  Returns a list of matching attachments'
      parameters:
      - name: Message_ID
        in: path
        description: The Message ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          Unique identifier
        required: false
        type: string
      - name: name
        in: query
        description: |
          The name of the attachment (e.g. it's filename or other non-generated identifier)  The value of this field should be unique for a given message.
        required: false
        type: string
      - name: type
        in: query
        description: |
          The MIME type of the attachment (if known)
        required: false
        type: string
      - name: size
        in: query
        description: |
          The size, in bytes, of the attachment body
        required: false
        type: integer
      - name: filename
        in: query
        description: |
          Original file name of the attachment
        required: false
        type: string
      - name: state
        in: query
        description: |
          CREATED, UPLOADED
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediation channel.
          example:2023-03-20T14:14:14.672Z
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_7'
        "400":
          description: "Bad Request.  The request could not be understood by the server.\n\n  * **400** - Bad Request - Error Message provides information about what's wrong with the request\n  * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length\n  * **SCG_ERROR_4001** - Required parameter<parameter> missing or is null\n  * **SCG_ERROR_4002** - Required parameter <parameter> data type/format is incorrect\n  * **SCG_ERROR_4003** - Optional parameter <parameter> data type/format is incorrect            \n  * **SCG_ERROR_4004** - Invalid parameter <parameter> defined            \n  * **SCG_ERROR_4005** - Error message contains details about the limit being exceeded - Message size exceeds system limit            \n  * **SCG_ERROR_4006** -  Indexed parameter <parameter> too long - Value of <parameter> in the request exceeded the maximum allowed length          \n  * **SCG_ERROR_4007** -  Invalid Tracking URL - The tracking URL <parameter> that was provided is invalid          \n  * **SCG_ERROR_4008** -  Message scheduled time exceeds max allowed days: <parameter>          \n  * **SCG_ERROR_4009** -  Cannot exceed more than <parameter> media URLs                    \n  * **SCG_ERROR_40010**  -  Cannot include media URLs with attachment        \n  * **SCG_ERROR_40011**  -  Group message only supported for US Phone numbers        \n  * **SCG_ERROR_40012**  -  No sender addresses capable of sending requested message type        \n  * **SCG_ERROR_40013**  -  No sender addresses capable of sending requested verifiedSms message      \n  * **SCG_ERROR_40014**  -  Cannot failover to SMS on a message with attachments        \n  * **SCG_ERROR_40015**  - Cannot exceed more than <parameter> recipients          \n  * **SCG_ERROR_40016**  -  Sender id is not capable of sending MMS        \n  * **SCG_ERROR_40017**  -  Only sender id with type id LONGCODE is supported for group MMS        \n  * **SCG_ERROR_40018**  -  Invalid senderId/address: <parameter>        \n  * **SCG_ERROR_40019**  -  Multiple sender id with address: <parameter>. Use sender id to send message.        \n  * **SCG_ERROR_40020**  -  Unrecognized option(s): <parameter>        \n  * **SCG_ERROR_40021**  -  Failover to SMS requires a SenderId for SMS (use a channel)        \n  * **SCG_ERROR_40022**  -  Failover TO SMS requires a SenderId for <parameter> (use a channel)        \n  * **SCG_ERROR_40023**  -  Delivery Window Restriction Violation        \n  * **SCG_ERROR_40024**  -  Invalid Recipient        \n  * **SCG_ERROR_40025**  -  Invalid payload        \n  * **SCG_ERROR_40026**  -  Missing form-data part: <part>        \n  * **SCG_ERROR_40027**  -  Content size in Content-Disposition is mandatory        \n  * **SCG_ERROR_40028**  -  Content length is mandatory        \n  * **SCG_ERROR_40029**  -  Attachment size <parameter> exceeds max allowed attachment size <parameter>        \n  * **SCG_ERROR_40030**  - Only UPLOADED attachments can be downloaded.\n  \n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
              * **SCG_ERROR_4010** - Token unauthorized for this resource
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
              * **SCG_ERROR_4021** - Quota exceeded
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: "Forbidden. The user does not have permission to access the specified resource.\n\n  * **403** - Forbidden - Access to this resource is not allowed with the current application token\n  * **SCG_ERROR_4030** - Forbidden          \n  * **SCG_ERROR_4031** - Attachment <parameter> was not found neither in cache nor in database            \n  * **SCG_ERROR_4032** - Attachment <parameter> is in incorrect state\n    <parameter>                       \n  * **SCG_ERROR_4033** - SenderId start date in the future: <parameter>           \n  * **SCG_ERROR_4034** - SenderId end date in the past: <parameter>           \n  * **SCG_ERROR_4035** - Invalid sender ID state: <parameter>          \n  * **SCG_ERROR_4036** - Invalid sender ID ownership: <parameter>           \n  * **SCG_ERROR_4037** - <parameter> forbidden for attachment in state: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: "Not found. The requested resource could not be found.\n\n  * **404** - Error message contains details about the missing resource - Requested resource not found\n  * **SCG_ERROR_4040**  - Resource you are trying to fetch not found for <parameter>          \n  * **SCG_ERROR_4041**  -  Resource you are trying to update cannot be found for <parameter>        \n  * **SCG_ERROR_4043**  -  The language code <language> is not found among the languages supported by Google Translate        \n  * **SCG_ERROR_4045**  -  No sender id matches with recipient country.        \n  * **SCG_ERROR_4046**  - Access token expired\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
              * **SCG_ERROR_4090** - The access token could not be updated because resource is being updated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "422":
          description: |
            Unprocessable Entity
              * **SCG_ERROR_4220** - Attachment content could not be downloaded from the provided URL. The error message is <error message>
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: "Server Error. An error has been encountered while processing this request.\n\n  * **500** - Server Error - Internal server error. Please report\n  * **SCG_ERROR_5000** - Unexpected Server Error\n  * **SCG_ERROR_5002** - Message type restriction not implemented for: <messageType>            \n  * **SCG_ERROR_5003** - Error redirecting to proxy: <parameter>                      \n  * **SCG_ERROR_5004** - Error downloading attachment from storage: <parameter>\n"
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/messages/scheduled/{Message_Scheduled_ID}':
    delete:
      tags:
      - Scheduled Message
      summary: Delete a scheduled message
      description: '  Delete a scheduled message'
      parameters:
      - name: Message_Scheduled_ID
        in: path
        description: The Scheduled Message ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/attachments:
    get:
      tags:
      - Attachment
      summary: Creates a new attachment resource
      description: '  Creates a new attachment resource'
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier
        required: false
        type: string
      - name: name
        in: query
        description: |
          The name of the attachment (e.g. it's filename or other non-generated identifier)  The value of this field should be unique for a given message.
        required: false
        type: string
      - name: type
        in: query
        description: |
          The MIME type of the attachment (if known)
        required: false
        type: string
      - name: size
        in: query
        description: |
          The size, in bytes, of the attachment body
        required: false
        type: integer
      - name: filename
        in: query
        description: |
          Original file name of the attachment
        required: false
        type: string
      - name: state
        in: query
        description: |
          CREATED, UPLOADED
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediation channel.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_7'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Attachment
      summary: Creates a new attachment resource
      description: '  Creates a new attachment resource'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Attachment
        required: false
        schema:
          $ref: '#/definitions/Attachment'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/attachments/{Attachment_ID}':
    get:
      tags:
      - Attachment
      summary: Returns the current version of the specified Attachment
      description: '  Returns the current version of the specified Attachment'
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_7_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Attachment
      summary: Update a specific attachment id
      description: '  Update a specific attachment id '
      consumes:
      - application/json
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      - in: body
        name: Attachment
        required: false
        schema:
          $ref: '#/definitions/Attachment_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Attachment
      summary: Delete an attachment
      description: '  Delete an attachment'
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/attachments/{Attachment_ID}/access_tokens':
    post:
      tags:
      - Attachment
      summary: Create a new access token for an attachment
      description: '  Create a new access token for an attachment'
      consumes:
      - application/json
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      - in: body
        name: Access Token
        required: false
        schema:
          $ref: '#/definitions/Access_Token'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/attachments/{Attachment_ID}/content':
    get:
      tags:
      - Attachment
      summary: Returns the current version of the specified Attachment
      description: '  Returns the current version of the specified Attachment'
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_8'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Attachment
      summary: Uploads data to an attachment
      description: '  Uploads data to an attachment'
      consumes:
      - application/json
      parameters:
      - name: Attachment_ID
        in: path
        description: The Attachment ID for this resource.
        required: true
        type: string
      - in: body
        name: Attachment Data
        required: false
        schema:
          $ref: '#/definitions/Attachment_Data'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/message_templates:
    get:
      tags:
      - Message Template
      summary: Retrieve all Templates
      description: '  Retrieve all Templates'
      parameters:
      - name: id
        in: query
        description: |
          The identifier
        required: false
        type: string
      - name: designation
        in: query
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
        required: false
        type: string
      - name: name
        in: query
        description: |
          The name of the template.
        required: false
        type: string
      - name: pattern
        in: query
        description: |
          template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_9'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Message Template
      summary: Create a Template
      description: '  Create a Template'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Sender ID Message Template
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_Message_Template'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/message_templates/{Template_ID}':
    get:
      tags:
      - Message Template
      summary: Returns the current version of the specified Template
      description: '  Returns the current version of the specified Template'
      parameters:
      - name: Template_ID
        in: path
        description: The Template ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_9_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Message Template
      summary: Update a Template
      description: '  Update a Template'
      consumes:
      - application/json
      parameters:
      - name: Template_ID
        in: path
        description: The Template ID for this resource.
        required: true
        type: string
      - in: body
        name: Sender ID Message Template
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_Message_Template_2'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Message Template
      summary: Replaces the specific template ID. All mandatory fields must be present.
      description: '  Replaces the specific template ID. All mandatory fields must be present.'
      consumes:
      - application/json
      parameters:
      - name: Template_ID
        in: path
        description: The Template ID for this resource.
        required: true
        type: string
      - in: body
        name: Sender ID Message Template
        required: false
        schema:
          $ref: '#/definitions/Sender_ID_Message_Template_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Message Template
      summary: Delete a Template
      description: '  Delete a Template'
      parameters:
      - name: Template_ID
        in: path
        description: The Template ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /messaging/keywords:
    get:
      tags:
      - Keywords
      summary: Returns the list of all keywords
      description: '  Returns the list of all keywords '
      parameters:
      - name: id
        in: query
        description: |
          unique keyword id
        required: false
        type: string
      - name: name
        in: query
        description: |
          name of the keyword
        required: false
        type: string
      - name: value
        in: query
        description: |
          the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
        required: false
        type: string
      - name: case
        in: query
        description: |
          SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
        required: false
        type: string
      - name: sender_id
        in: query
        description: |
          The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
        required: false
        type: string
      - name: valid_from
        in: query
        description: |
          the date range for which the keyword is valid
        required: false
        type: string
      - name: valid_to
        in: query
        description: |
          the date range for which the keyword is valid
        required: false
        type: string
      - name: campaign_id
        in: query
        description: |
          The campaign id
        required: false
        type: string
      - name: type
        in: query
        description: |
          the type of the keyword:
          - RESERVED: those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them
          - COMPANY: company specific keywords
        required: false
        type: string
      - name: actions
        in: query
        description: |
          actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space:
          - OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)
          - OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)
          - STORE -> no action, just record in user profile
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The creation date of the object.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_10'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Keywords
      summary: Create a new keyword
      description: '  Create a new keyword'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Keywords
        required: false
        schema:
          $ref: '#/definitions/Keywords'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'messaging/keywords/{Keyword_ID}':
    get:
      tags:
      - Keywords
      summary: Retrieve a specific keyword
      description: '  Retrieve a specific keyword'
      parameters:
      - name: Keyword_ID
        in: path
        description: The Keyword ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_10_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Keywords
      summary: Update a keyword
      description: '  Update a keyword'
      consumes:
      - application/json
      parameters:
      - name: Keyword_ID
        in: path
        description: The Keyword ID for this resource.
        required: true
        type: string
      - in: body
        name: Keywords
        required: false
        schema:
          $ref: '#/definitions/Keywords_2'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Keywords
      summary: Replace the keyword
      description: '  Replace the keyword'
      consumes:
      - application/json
      parameters:
      - name: Keyword_ID
        in: path
        description: The Keyword ID for this resource.
        required: true
        type: string
      - in: body
        name: Keywords
        required: false
        schema:
          $ref: '#/definitions/Keywords_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Keywords
      summary: Deletes specified keyword
      description: '  Deletes specified keyword'
      parameters:
      - name: Keyword_ID
        in: path
        description: The Keyword ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /calling/calls:
    get:
      tags:
      - Call
      summary: Returns the list of Calls
      description: '  Returns the list of Calls'
      parameters:
      - name: id
        in: query
        description: |
          The unique identifier for this resource.
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          The unique Id assigned by the application.
        required: false
        type: string
      - name: from
        in: query
        description: |
          The Sender ID associated with this call.
        required: false
        type: string
      - name: from_address
        in: query
        description: |
          The address associated with the Sender Id.
        required: false
        type: string
      - name: to
        in: query
        description: |
          The called party's address.
        required: false
        type: string
      - name: to_address
        in: query
        description: |
          The address that was used by the system for the called party.  When the 'to' field specifies something other than the address (e.g. contact ID) then this field will contain the actual address that was used.
        required: false
        type: string
      - name: answer_timeout
        in: query
        description: |
          The number of miliseconds that the service will wait for an answer.
        required: false
        type: integer
      - name: state
        in: query
        description: |
          The call's state:
          - STARTED - The call is being setup.
          - ACTIVE - The call is in progress.
          - REJECTED - The called party did not answer.
          - COMPLETED - The call is complete.
        required: false
        type: string
      - name: direction
        in: query
        description: |
          The direction of the call:
          - IN - This was an incoming call.
          - OUT - This was an outgoing call.
        required: false
        type: string
      - name: start_time
        in: query
        description: |
          The time the call was started.
        required: false
        type: string
      - name: answer_time
        in: query
        description: |
          The time the call was answered.
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_11'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Call
      summary: Make a Call
      description: '  Make a Call'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Call
        required: false
        schema:
          $ref: '#/definitions/Call'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/calls/{Call_ID}':
    get:
      tags:
      - Call
      summary: Returns the current version of the specified Call
      description: '  Returns the current version of the specified Call'
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_11_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Call
      summary: Update a Call
      description: '  Update a Call'
      consumes:
      - application/json
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      - in: body
        name: Call
        required: false
        schema:
          $ref: '#/definitions/Call_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Call
      summary: Deletes the Call resource with the specified ID
      description: '  Deletes the Call resource with the specified ID'
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/calls/{call_id}/play_dtmf':
    post:
      tags:
      - Call
      summary: Play DTMF tones
      description: '  Play DTMF tones'
      consumes:
      - application/json
      parameters:
      - name: call_id
        in: path
        description: The call_id for this resource.
        required: true
        type: string
      - in: body
        name: TTS Text
        required: false
        schema:
          $ref: '#/definitions/TTS_Text'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/calls/{call_id}/play_tts':
    post:
      tags:
      - Call
      summary: Play Text to Speech
      description: "  Play Text to Speech. When voice parameter is present, no language or gender parameters are accepted."
      consumes:
      - application/json
      parameters:
      - name: call_id
        in: path
        description: The call_id for this resource.
        required: true
        type: string
      - in: body
        name: AudioFile
        required: false
        schema:
          $ref: '#/definitions/AudioFile'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/calls/{call_id}/play_audio':
    post:
      tags:
      - Call
      summary: Play an audio file.
      description: '  Play an audio file.'
      consumes:
      - application/json
      parameters:
      - name: call_id
        in: path
        description: The call_id for this resource.
        required: true
        type: string
      - in: body
        name: AudioFile
        required: false
        schema:
          $ref: '#/definitions/AudioFile_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /calling/bridges:
    get:
      tags:
      - Bridge
      summary: Returns the list of Bridges
      description: '  Returns the list of Bridges'
      parameters:
      - name: id
        in: query
        description: |
          The unique identifier for this resource.
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          The unique Id assigned by the application.
        required: false
        type: string
      - name: state
        in: query
        description: |
          The bridge state:
          - CREATED - The Bridge has been created.
          - ACTIVE - The Bridge is active.
          - HOLD - The Bridge in on hold.
          - COMPLETED - The Bridge has been completed and is no longer active.
          - ERROR - The bridge failed to be created or was ended due to an error.
        required: false
        type: string
      - name: completed_time - date
        in: query
        description: |
          The time that the Bridge was completed.
        required: false
        type: string
      - name: activated_time - date
        in: query
        description: |
          The time that the bridge was activated.
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_12'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Bridge
      summary: Create a new Bridge Resource
      description: '  Create a new Bridge Resource'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Message
        required: false
        schema:
          $ref: '#/definitions/Message_2'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/bridges/{Bridge_ID}':
    get:
      tags:
      - Bridge
      summary: Returns the current version of the specified Bridge
      description: '  Returns the current version of the specified Bridge'
      parameters:
      - name: Bridge_ID
        in: path
        description: The Bridge ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_12_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Bridge
      summary: Update a Bridge
      description: '  Update a Bridge'
      consumes:
      - application/json
      parameters:
      - name: Bridge_ID
        in: path
        description: The Bridge ID for this resource.
        required: true
        type: string
      - in: body
        name: Message
        required: false
        schema:
          $ref: '#/definitions/Message_3'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Bridge
      summary: Deletes the Bridge resource with the specified ID
      description: '  Deletes the Bridge resource with the specified ID'
      parameters:
      - name: Bridge_ID
        in: path
        description: The Bridge ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/bridges/{Bridge_ID}/calls':
    get:
      tags:
      - Bridge
      summary: Returns a list of Voice Call resources.
      description: '  Returns a list of Voice Call resources.'
      parameters:
      - name: Bridge_ID
        in: path
        description: The Bridge ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          The unique identifier for this resource.
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          The unique Id assigned by the application.
        required: false
        type: string
      - name: from
        in: query
        description: |
          The Sender ID associated with this call.
        required: false
        type: string
      - name: from_address
        in: query
        description: |
          The address associated with the Sender Id.
        required: false
        type: string
      - name: to
        in: query
        description: |
          The called party's address.
        required: false
        type: string
      - name: to_address
        in: query
        description: |
          The address that was used by the system for the called party.  When the 'to' field specifies something other than the address (e.g. contact ID) then this field will contain the actual address that was used.
        required: false
        type: string
      - name: answer_timeout
        in: query
        description: |
          The number of miliseconds that the service will wait for an answer.
        required: false
        type: integer
      - name: state
        in: query
        description: |
          The call's state:
          - STARTED - The call is being setup.
          - ACTIVE - The call is in progress.
          - REJECTED - The called party did not answer.
          - COMPLETED - The call is complete.
        required: false
        type: string
      - name: direction
        in: query
        description: |
          The direction of the call:
          - IN - This was an incoming call.
          - OUT - This was an outgoing call.
        required: false
        type: string
      - name: start_time
        in: query
        description: |
          The time the call was started.
        required: false
        type: string
      - name: answer_time
        in: query
        description: |
          The time the call was answered.
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_11'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /calling/conferences:
    get:
      tags:
      - Conference
      summary: Retrieve a  list of Conferences
      description: '  Retrieve a  list of Conferences'
      parameters:
      - name: id
        in: query
        description: |
          The unique identifier for this resource.
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          The unique Id assigned by the application.
        required: false
        type: string
      - name: from
        in: query
        description: |
          The calling party's address.
        required: false
        type: string
      - name: state
        in: query
        description: |
          The conference's state:
           - created (the conference is created but has no members)
           - active (the conference is active and has members)
           - completed (the conference is completed and has no members)
        required: false
        type: string
      - name: created_time
        in: query
        description: |
          The date the conference was created.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_13'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Conference
      summary: Create a Conference
      description: '  Create a Conference'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Conference
        required: false
        schema:
          $ref: '#/definitions/Conference'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/conferences/{Conference_ID}':
    get:
      tags:
      - Conference
      summary: Retrieve a specified Conference
      description: '  Retrieve a specified Conference'
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_13_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Conference
      summary: Update conference state
      description: '  Update conference state'
      consumes:
      - application/json
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - in: body
        name: Conference
        required: false
        schema:
          $ref: '#/definitions/Conference_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Conference
      summary: Deletes the Conference resource with the specified ID
      description: '  Deletes the Conference resource with the specified ID'
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/conferences/{Conference_ID}/play_tts':
    post:
      tags:
      - Conference
      summary: Play the specified text using text to speech.
      description: '  Play the specified text using text to speech.'
      consumes:
      - application/json
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - in: body
        name: AudioFile
        required: false
        schema:
          $ref: '#/definitions/AudioFile_4'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/conferences/{Conference_ID}/play_audio':
    post:
      tags:
      - Conference
      summary: Play a specified audio file.
      description: '  Play a specified audio file.'
      consumes:
      - application/json
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - in: body
        name: AudioFile
        required: false
        schema:
          $ref: '#/definitions/AudioFile_5'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /calling/conferences/{Conference_ID}/members:
    get:
      tags:
      - ConferenceMember
      summary: Retrieve ConferenceMembers for the specified Conference
      description: '  Retrieve ConferenceMembers for the specified Conference'
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          The unique identifier for this resource.
        required: false
        type: string
      - name: state
        in: query
        description: |
          The conference member's state:
           - active (the member is active)
           - completed (the member is completed)
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_14'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - ConferenceMember
      summary: Create a new ConferenceMember
      description: '  Create a new ConferenceMember '
      consumes:
      - application/json
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - in: body
        name: ConferenceMember
        required: false
        schema:
          $ref: '#/definitions/ConferenceMember'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/conferences/{Conference_ID}/members/{Member_ID}':
    get:
      tags:
      - ConferenceMember
      summary: Retrieve a  specified ConferenceMember
      description: '  Retrieve a  specified ConferenceMember'
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - name: Member_ID
        in: path
        description: The Conference Memeber ID
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_14_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - ConferenceMember
      summary: Update member info
      description: '  Update member info'
      consumes:
      - application/json
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - name: Member_ID
        in: path
        description: The Member ID for this resource.
        required: true
        type: string
      - in: body
        name: ConferenceMember
        required: false
        schema:
          $ref: '#/definitions/ConferenceMember_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - ConferenceMember
      summary: Delete the ConferenceMember resource with a specified ID
      description: '  Delete the ConferenceMember resource with a specified ID'
      parameters:
      - name: Conference_ID
        in: path
        description: The Conference ID for this resource.
        required: true
        type: string
      - name: Member_ID
        in: path
        description: The Member ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /calling/calls/{Call_ID}/digits_collector:
    get:
      tags:
      - Digits Collector
      summary: List all digit collectors
      description: '  List all digit collectors'
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          Unique id of the digits collector
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_15'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Digits Collector
      summary: Create digits collector
      description: "  Create digits collector. When voice parameter is present, no gender or locale parameters are accepted."
      consumes:
      - application/json
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      - in: body
        name: Digits Collector
        required: false
        schema:
          $ref: '#/definitions/Digits_Collector'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'calling/calls/{Call_ID}/digits_collector/{Collector_ID}':
    get:
      tags:
      - Digits Collector
      summary: Retrieve a specific digits collector
      description: '  Retrieve a specific digits collector'
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      - name: Collector_ID
        in: path
        description: The Collector ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_15_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Digits Collector
      summary: Delete a specified resource
      description: '  Delete a specified resource'
      parameters:
      - name: Call_ID
        in: path
        description: The Call ID for this resource.
        required: true
        type: string
      - name: Collector_ID
        in: path
        description: The Collector ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /contacts:
    get:
      tags:
      - Contact
      summary: List all matching Contacts
      description: '  List all matching Contacts'
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of contact creation
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
        required: false
        type: string
      - name: first_name
        in: query
        description: |
          First name of customer
        required: false
        type: string
      - name: last_name
        in: query
        description: |
          Last name of customer
        required: false
        type: string
      - name: birth_date
        in: query
        description: |
          Customer birth date. YYYY-MM-DD
        required: false
        type: string
      - name: first_acquisition_date
        in: query
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
        required: false
        type: string
      - name: last_acquisition_date
        in: query
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
        required: false
        type: string
      - name: primary_mdn
        in: query
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
        required: false
        type: string
      - name: primary_addr_line1
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_line2
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_city
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_zip
        in: query
        description: |
          ZIP code of the customer primary address
        required: false
        type: string
      - name: primary_addr_state
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_email_addr
        in: query
        description: |
          Customers primary email address
        required: false
        type: string
      - name: primary_addr_country
        in: query
        description: |
          Customer primary address country
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_16'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact
      summary: Create a new Contact
      description: '  Create a new Contact '
      consumes:
      - application/json
      parameters:
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contacts/{Contact_ID}':
    get:
      tags:
      - Contact
      summary: List a Contact
      description: '  List a Contact'
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_16_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact
      summary: Update a specific contact
      description: '  Update a specific contact'
      consumes:
      - application/json
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact_2'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Contact
      summary: Replace a specific contact
      description: '  Replace a specific contact'
      consumes:
      - application/json
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Contact
      summary: Delete a Contact
      description: '  Delete a Contact '
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contacts/{Contact_ID}/access_tokens':
    post:
      tags:
      - Contact
      summary: Create a new contact access token
      description: '  Create a new contact access token '
      consumes:
      - application/json
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - in: body
        name: Access Token
        required: false
        schema:
          $ref: '#/definitions/Access_Token_1'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contacts/{Contact_ID}/access_tokens/{Contact_Access_Token_Id}':
    get:
      tags:
      - Contact
      summary: Return a Contact Access Token
      description: '  Return a Contact Access Token'
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: Contact_Access_Token_Id
        in: path
        description: The Contact Access Token Id for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_17'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Contact
      summary: Delete a Contact Access Token
      description: '  Delete a Contact Access Token '
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: Contact_Access_Token_Id
        in: path
        description: The Contact Access Token Id for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /contacts/{Contact_ID}/application_tokens:
    get:
      tags:
      - Contact Application Token
      summary: Return a list of matching Contact Application Tokens
      description: '  Return a list of matching Contact Application Tokens'
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of contact Application Token creation
        required: false
        type: string
      - name: sender_id_address
        in: query
        description: |
          The address of the sender Id that is associated with this application.
        required: false
        type: string
      - name: message_delivery_provider
        in: query
        description: |
          The code that indicates the message devliery provider (e.g. APN, GCN)
        required: false
        type: string
      - name: token
        in: query
        description: |
          The token the user, application and device.
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_update_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_18'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Application Token
      summary: Create a new contact application token
      description: '  Create a new contact application token '
      consumes:
      - application/json
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact_3'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contacts/{Contact_ID}/application_tokens/{Contact_Application_Token_Id}':
    get:
      tags:
      - Contact Application Token
      summary: Return a Contact Application Token
      description: '  Return a Contact Application Token'
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: Contact_Application_Token_Id
        in: path
        description: The Contact Application Token Id for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_18_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Application Token
      summary: Update a contact application token
      description: '  Update a contact application token'
      consumes:
      - application/json
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: Contact_Application_Token_Id
        in: path
        description: The Contact Application Token Id for this resource.
        required: true
        type: string
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact_4'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Contact Application Token
      summary: Delete a Contact Application
      description: '  Delete a Contact Application '
      parameters:
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      - name: Contact_Application_Token_Id
        in: path
        description: The Contact Application Token Id for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /contacts/fast_access:
    get:
      tags:
      - Fast Access
      summary: Return a list of matching Fast Access Rules
      description: '  Return a list of matching Fast Access Rules'
      parameters:
      - name: id
        in: query
        description: |
          The unique id of a mapping rule
        required: false
        type: string
      - name: target_attribute
        in: query
        description: |
          The name in the contact resource this mapping applies to: fast_access_1 .. fast_access_20.
        required: false
        type: string
      - name: target_attribute_name
        in: query
        description: |
          The friendly name of the fast access attribute. The corresponding attribute will appear under the fast_access sb-object of the contact object. The name must be used for all contact updates. It can be used with filters like fast_access.<name>
          If not provided, the corresponding attribute will appear in the contact and filter criteria as is.
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_19'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Fast Access
      summary: Create a new Fast Access Rule
      description: '  Create a new Fast Access Rule'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Fast Access
        required: false
        schema:
          $ref: '#/definitions/Fast_Access'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contacts/fast_access/{Rule_ID}':
    get:
      tags:
      - Fast Access
      summary: Return a specified Fast Access Rule
      description: '  Return a specified Fast Access Rule'
      parameters:
      - name: Rule_ID
        in: path
        description: The Rule ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_19_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Fast Access
      summary: Update a Fast Access Rule
      description: '  Update a Fast Access Rule'
      consumes:
      - application/json
      parameters:
      - name: Rule_ID
        in: path
        description: The Rule ID for this resource.
        required: true
        type: string
      - in: body
        name: Fast Access
        required: false
        schema:
          $ref: '#/definitions/Fast_Access_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Fast Access
      summary: Delete a Fast Access Rule
      description: '  Delete a Fast Access Rule'
      parameters:
      - name: Rule_ID
        in: path
        description: The Rule ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /contact_groups:
    get:
      tags:
      - Contact Group
      summary: List a Contact group
      description: '  List a Contact group'
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier of the contact group
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          Customer supplied id of the contact group
        required: false
        type: string
      - name: name
        in: query
        description: |
          A name for the group
        required: false
        type: string
      - name: type
        in: query
        description: "The group type: \n- DYNAMIC: meaning the list of members associated with the group is calculated dynamically whenever the group is referenced by applying the CRITERIA to the customer contact list\n- STATIC: meaning the list of members is determined at the time of contact group creation and hence static. Customers will be also able to add or remove contacts from a STATIC group by accessing the contacts list associated with the group\n"
        required: false
        type: string
      - name: status
        in: query
        description: |
          Processing
          Ready
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The creation date of the object.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_20'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1017** - Invalid Json expression in Dynamic Group definition - The Dymanic Group definition was invalid
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Group
      summary: Create a Contact Group
      description: '  Create a Contact Group'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Contact Group
        required: false
        schema:
          $ref: '#/definitions/Contact_Group'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1017** - Invalid Json expression in Dynamic Group definition - The Dymanic Group definition was invalid
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contact_groups/{Group_ID}':
    get:
      tags:
      - Contact Group
      summary: Return a specified Contact Group
      description: '  Return a specified Contact Group'
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_20_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Group
      summary: Update a Contact group
      description: '  Update a Contact group'
      consumes:
      - application/json
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact Group
        required: false
        schema:
          $ref: '#/definitions/Contact_Group_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Contact Group
      summary: Replace a specified group ID
      description: '  Replace a specified group ID'
      consumes:
      - application/json
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact Group
        required: false
        schema:
          $ref: '#/definitions/Contact_Group_2'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Contact Group
      summary: Delete a Contact Group
      description: '  Delete a Contact Group'
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contact_groups/{Group_ID}/contacts':
    get:
      tags:
      - Contact Group
      summary: Return the list of contacts associated with the contact group.
      description: '  Return the list of contacts associated with the contact group. '
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of contact creation
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
        required: false
        type: string
      - name: first_name
        in: query
        description: |
          First name of customer
        required: false
        type: string
      - name: last_name
        in: query
        description: |
          Last name of customer
        required: false
        type: string
      - name: birth_date
        in: query
        description: |
          Customer birth date. YYYY-MM-DD
        required: false
        type: string
      - name: first_acquisition_date
        in: query
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
        required: false
        type: string
      - name: last_acquisition_date
        in: query
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
        required: false
        type: string
      - name: primary_mdn
        in: query
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
        required: false
        type: string
      - name: primary_addr_line1
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_line2
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_city
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_addr_zip
        in: query
        description: |
          ZIP code of the customer primary address
        required: false
        type: string
      - name: primary_addr_state
        in: query
        description: |
          Details of customers primary address
        required: false
        type: string
      - name: primary_email_addr
        in: query
        description: |
          Customers primary email address
        required: false
        type: string
      - name: primary_addr_country
        in: query
        description: |
          Customer primary address country
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_16'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Group
      summary: Add a contact to a static contact group
      description: '  Add a contact to a static contact group'
      consumes:
      - application/json
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact
        required: false
        schema:
          $ref: '#/definitions/Contact_5'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'contact_groups/{Group_ID}/contacts/{Contact_ID}':
    delete:
      tags:
      - Contact Group
      summary: Remove Contact from a Static Contact group
      description: '  Remove Contact from a Static Contact group '
      parameters:
      - name: Group_ID
        in: path
        description: The Group ID for this resource.
        required: true
        type: string
      - name: Contact_ID
        in: path
        description: The Contact ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /consent/contact_address_statuses:
    get:
      tags:
      - Contact Address Status
      summary: Retrieve Contact Address Statues
      description: '  Retrieve Contact Address Statues'
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of address creation. This is a combination of an address type/value and sender id.
          SCG will allocate a new address_status_id for any message sent or received from a new combination of sender id and address value/type
        required: false
        type: string
      - name: address_type
        in: query
        description: |
          The address type: MDN (for phone numbers), EMAIL, SOCIAL, PUSH (...)
        required: false
        type: string
      - name: address
        in: query
        description: |
          The actual value of the address. For SMS/MMS this will be the MDN.
        required: false
        type: string
      - name: sender_id
        in: query
        description: |
          the sender id accociated with the address type/value
        required: false
        type: string
      - name: consent_status
        in: query
        description: |
          this is the current optin status for the specific address / sender id. The possible values are:
          - NONE (no optin or optout message received from the address on the specific sender id)
          - OPTIN (user has explicitly opted in to the sender id)
          - OPTOUT (user has explicitly opted out of the sender id)
          - BLACKLIST (blacklisted address - will be treated as explicit OPTOUT)
          - WHITELIST (whitelisted address - will be treated as explicit OPTIN)
          NOTE: Whitelisted or blacklisted status can not be overwritten by the end-user by sending messages to the sender id. Such users can be only un-listed by changing the optin-status explicitly put POST to address status ID
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The creation date of the object.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_23'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Address Status
      summary: Create a new Contact Address Status
      description: '  Create a new Contact Address Status '
      consumes:
      - application/json
      parameters:
      - in: body
        name: Contact Address Status
        required: false
        schema:
          $ref: '#/definitions/Contact_Address_Status'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'consent/contact_address_statuses/{AddressStatus_ID}':
    get:
      tags:
      - Contact Address Status
      summary: Returns the current version of the specified Contact Address Status History
      description: '  Returns the current version of the specified Contact Address Status History'
      parameters:
      - name: AddressStatus_ID
        in: path
        description: The AddressStatus ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_23_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Contact Address Status
      summary: Create a new Address Status
      description: '  Create a new Address Status'
      consumes:
      - application/json
      parameters:
      - name: AddressStatus_ID
        in: path
        description: The AddressStatus ID for this resource.
        required: true
        type: string
      - in: body
        name: Contact Address Status
        required: false
        schema:
          $ref: '#/definitions/Contact_Address_Status_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Contact Address Status
      summary: Delete a Contact Address Status
      description: '  Delete a Contact Address Status '
      parameters:
      - name: AddressStatus_ID
        in: path
        description: The AddressStatus ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /consent/contact_address_statuses/optout:
    post:
      tags:
      - Contact Address Status Optout
      summary: Update Contact Address Status to OPTOUT
      description: '  Update Contact Address Status to OPTOUT '
      consumes:
      - application/json
      parameters:
      - in: body
        name: Contact Address Status Optout
        required: false
        schema:
          $ref: '#/definitions/Contact_Address_Status_Optout'
      responses:
        "200":
          description: Successful operation. No response body
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /consent/contact_address_history:
    get:
      tags:
      - Contact Address History
      summary: List a Contact Address History
      description: '  List a Contact Address History '
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of the history record creation.
        required: false
        type: string
      - name: msisdn
        in: query
        description: |
          The value of the contact's address. For SMS/MMS this will be the MDN.
        required: false
        type: string
      - name: sender_id
        in: query
        description: |
          The sender id that MO/MT message was sent to/from
        required: false
        type: string
      - name: source
        in: query
        description: |
          The source of the contact's consent status information:
          - MESSAGE - when the consent status has changed as a result of a MO message sent by the contact (SCG managed consent)
          - CARRIER  - when a blacklist file was provided by a carrier and loaded in
          - COMPANY - when the user of SCG has supplied the information (USER managed consent)
        required: false
        type: string
      - name: status
        in: query
        description: |
          The new consent status of the contact
        required: false
        type: string
      - name: timestamp
        in: query
        description: |
          Timestamp indicating when the MO message that triggered the consent status change was received
        required: false
        type: string
      - name: message
        in: query
        description: |
          The body of the actual MO message that triggered the consent status change
        required: false
        type: string
      - name: keyword
        in: query
        description: |
          The keyword detected by the application
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The creation date of the object.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_24'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /access_tokens:
    get:
      tags:
      - Access Token
      summary: Returns the list of matching AccessTokens
      description: '  Returns the list of matching AccessTokens'
      parameters:
      - name: id
        in: query
        description: |
          The unique id of the token
        required: false
        type: string
      - name: expiry_time
        in: query
        description: |
          The UTC timestamp after which the token is no Integer valid.
        required: false
        type: string
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      - name: created_date
        in: query
        description: |
          The timestamp when the resource was created.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The timestamp the resource was last changed
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_25'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Access Token
      summary: Create a new access token for the given resource
      description: '  Create a new access token for the given resource'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Access Token
        required: false
        schema:
          $ref: '#/definitions/Access_Token_2'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'access_tokens/{AccessToken_ID}':
    get:
      tags:
      - Access Token
      summary: Returns the current version of the AccessToken associated with the provided ID
      description: '  Returns the current version of the AccessToken associated with the provided ID'
      parameters:
      - name: AccessToken_ID
        in: path
        description: The AccessToken ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_17'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Access Token
      summary: Delete an AccessToken associated with a provided ID
      description: '  Delete an AccessToken associated with a provided ID'
      parameters:
      - name: AccessToken_ID
        in: path
        description: The AccessToken ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /assistant/auto_alias/history:
    get:
      tags:
      - Auto Alias History
      summary: Return a list of available auto alias history
      description: '  Return a list of available auto alias history'
      parameters: []
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_27'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'assistant/auto_alias/history/{Auto_Alias_History_ID}':
    get:
      tags:
      - Auto Alias History
      summary: Create resource
      description: '  Create resource'
      parameters:
      - name: Auto_Alias_History_ID
        in: path
        description: The Auto Alias History ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_27_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Auto Alias History
      summary: Delete specified resource
      description: '  Delete specified resource'
      parameters:
      - name: Auto_Alias_History_ID
        in: path
        description: The Auto Alias History ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /assistant/auto_alias/message_requests:
    post:
      tags:
      - Auto Alias Message Request
      summary: Create message request to an alias
      description: '  Create message request to an alias'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Message Request
        required: false
        schema:
          $ref: '#/definitions/Message_Request_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /assistant/communication_applications/applications/scripts:
    get:
      tags:
      - Application Script
      summary: Retrieve the list of matching Application Script
      description: '  Retrieve the list of matching Application Script'
      parameters:
      - name: id
        in: query
        description: |
          unique id
        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The creation date of the object.
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_28'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Application Script
      summary: Create a new Application Script
      description: '  Create a new Application Script '
      consumes:
      - application/json
      parameters:
      - in: body
        name: Application Script
        required: false
        schema:
          $ref: '#/definitions/Application_Script'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'assistant/communication_applications/applications/scripts/{Application_Script_ID}':
    get:
      tags:
      - Application Script
      summary: Retrieve a specified Application Script
      description: '  Retrieve a specified Application Script'
      parameters:
      - name: Application_Script_ID
        in: path
        description: The Application Script ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_28_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Application Script
      summary: Update an application script
      description: '  Update an application script'
      consumes:
      - application/json
      parameters:
      - name: Application_Script_ID
        in: path
        description: The Application Script ID for this resource.
        required: true
        type: string
      - in: body
        name: Application Script
        required: false
        schema:
          $ref: '#/definitions/Application_Script_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Application Script
      summary: Delete an Application Script
      description: '  Delete an Application Script '
      parameters:
      - name: Application_Script_ID
        in: path
        description: The Application Script ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /assistant/communication_applications/instances:
    get:
      tags:
      - Application Instance
      summary: Retrieve the list of matching Application Instance
      description: '  Retrieve the list of matching Application Instance'
      parameters:
      - name: id
        in: query
        description: |
          unique job id
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_29'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Application Instance
      summary: Create a new Application Instance
      description: '  Create a new Application Instance '
      consumes:
      - application/json
      parameters:
      - in: body
        name: Application Instance
        required: false
        schema:
          $ref: '#/definitions/Application_Instance'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'assistant/communication_applications/instances/{Application_Instance_ID}':
    get:
      tags:
      - Application Instance
      summary: Retrieve a specified  Application Instance
      description: '  Retrieve a specified  Application Instance'
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_29_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Application Instance
      summary: Update an Application Instance
      description: '  Update an Application Instance'
      consumes:
      - application/json
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Application Instance
      summary: Delete an Application Instance
      description: '  Delete an Application Instance '
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /assistant/communication_applications/instances/{Application_Instance_ID}/sessions:
    get:
      tags:
      - Application Instance Session
      summary: Retrieve the list of matching Application Instance Session
      description: '  Retrieve the list of matching Application Instance Session'
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - name: id
        in: query
        description: |
          unique job id
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The last modification date of the object.
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_30'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Application Instance Session
      summary: Create a new Application Instance Session
      description: '  Create a new Application Instance Session'
      consumes:
      - application/json
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - in: body
        name: Application Instance Session
        required: false
        schema:
          $ref: '#/definitions/Application_Instance_Session'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'assistant/communication_applications/instances/{Application_Instance_ID}/sessions/{Application_Instance_Session_ID}':
    get:
      tags:
      - Application Instance Session
      summary: Retrieve the current version of the specified  Application Instance Session
      description: '  Retrieve the current version of the specified  Application Instance Session'
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - name: Application_Instance_Session_ID
        in: path
        description: The Application Instance Session ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_30_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    put:
      tags:
      - Application Instance Session
      summary: Update an  Application Instance Session
      description: '  Update an  Application Instance Session'
      consumes:
      - application/json
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - name: Application_Instance_Session_ID
        in: path
        description: The Application Instance Session ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Application Instance Session
      summary: Delete an Application Instance Session
      description: '  Delete an Application Instance Session '
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - name: Application_Instance_Session_ID
        in: path
        description: The Application Instance Session ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  ? /assistant/communication_applications/instances/{Application_Instance_ID}/sessions/{Application_Instance_Session_ID}/processor_results
  : post:
      tags:
      - Application Processor Results
      summary: Create a new Application Processor Results
      description: '  Create a new Application Processor Results'
      consumes:
      - application/json
      parameters:
      - name: Application_Instance_ID
        in: path
        description: The Application Instance ID for this resource.
        required: true
        type: string
      - name: Application_Instance_Session_ID
        in: path
        description: The Application Instance Session ID for this resource.
        required: true
        type: string
      - in: body
        name: Application Instance Session
        required: false
        schema:
          $ref: '#/definitions/Application_Instance_Session_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1019** - Attachment Too Big - Attachment content size exceeds system limits
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /connect/connectors:
    get:
      tags:
      - Connector
      summary: List all matching Connectors
      description: '  List all matching Connectors'
      parameters:
      - name: id
        in: query
        description: |
          Unique identifier, allocated by SCG at the time of Connector creation
        required: false
        type: string
      - name: external_id
        in: query
        description: |
          The id of the Connector at the customer system. Can be used by customer to update the Connectors
        required: false
        type: string
      - name: type
        in: query
        description: |
          The type of the customer (bot) side API this connector will use. Currently supported values:

            * AZURE_BOT_DIRECT_LINE - Microsoft Azure Bot Framework Direct Line API
        required: false
        type: string
      - name: sender_id
        in: query
        description: |2+

        required: false
        type: string
      - name: created_date
        in: query
        description: |
          The date the resource was created
        required: false
        type: string
      - name: last_updated_date
        in: query
        description: |
          The data the resource was last changed
        required: false
        type: string
      - name: version_number
        in: query
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
        required: false
        type: integer
      - name: application_id
        in: query
        description: |
          ID of the application that has created the resource
        required: false
        type: integer
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_31'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Connector
      summary: Create a new Connector
      description: '  Create a new Connector'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Connector
        required: false
        schema:
          $ref: '#/definitions/Connector'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'connect/connectors/{Connector_ID}':
    get:
      tags:
      - Connector
      summary: List a Connector
      description: '  List a Connector'
      parameters:
      - name: Connector_ID
        in: path
        description: The Connector ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_31_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Connector
      summary: Update a specific Connector
      description: '  Update a specific Connector'
      consumes:
      - application/json
      parameters:
      - name: Connector_ID
        in: path
        description: The Connector ID for this resource.
        required: true
        type: string
      - in: body
        name: Connector
        required: false
        schema:
          $ref: '#/definitions/Connector_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Connector
      summary: Delete a Contact
      description: '  Delete a Contact '
      parameters:
      - name: Connector_ID
        in: path
        description: The Connector ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /sender_ids_import:
    get:
      tags:
      - Sender Import Job
      summary: List Sender Import Jobs
      description: '  List Sender Import Jobs'
      parameters:
      - name: id
        in: query
        description: |
          unique job id
        required: false
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_36'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Sender Import Job
      summary: Create sender id import job
      description: '  Create sender id import job'
      consumes:
      - application/json
      parameters:
      - in: body
        name: Sender Import Job
        required: false
        schema:
          $ref: '#/definitions/Sender_Import_Job'
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_3'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
  /'sender_ids_import/{import_ID}':
    get:
      tags:
      - Sender Import Job
      summary: Details of Sender Import Job with specified id
      description: '  Details of Sender Import Job with specified id'
      parameters:
      - name: import_ID
        in: path
        description: The import ID for this resource.
        required: true
        type: string
      responses:
        "200":
          description: Successful operation
          schema:
            $ref: '#/definitions/inline_response_200_36_list'
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    post:
      tags:
      - Sender Import Job
      summary: Admin approves a specified import
      description: '  Admin approves a specified import'
      consumes:
      - application/json
      parameters:
      - name: import_ID
        in: path
        description: The import ID for this resource.
        required: true
        type: string
      - in: body
        name: Sender Import Job
        required: false
        schema:
          $ref: '#/definitions/Sender_Import_Job_1'
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
    delete:
      tags:
      - Sender Import Job
      summary: Delete a Sender Import Job
      description: '  Delete a Sender Import Job '
      parameters:
      - name: import_ID
        in: path
        description: The import ID for this resource.
        required: true
        type: string
      responses:
        "204":
          description: Successful operation.  No Content in reponse.
        "400":
          description: |
            Bad Request.  The request could not be understood by the server.

              * **400** - Bad Request - Error Message provides information about what's wrong with the request
              * **1023** - Indexed field too long - One of the values in the request exceeded the maximum allowed length
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "401":
          description: |
            Unauthorized. The request requires user authentication.

              * **401** - Unauthorized - Provided authentication data is invalid or insufficient
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "402":
          description: |
            Payment Required.

              * **402** - Insufficient credit - The account does not have sufficient funds for this operation
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "403":
          description: |
            Forbidden. The user does not have permission to access the specified resource.

              * **403** - Forbidden - Access to this resource is not allowed with the current application token
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "404":
          description: |
            Not found. The requested resource could not be found.

              * **404** - Error message contains details about the missing resource - Requested resource not found
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "409":
          description: |
            Conflict. The request could not be completed due to a conflict with the current state of the target resource.

              * **1001** - Stale data - Concurrent resource update. Refresh the resource and retry.
              * **1011** - Error message contains details about the key being violated - Unique key constraint violated
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
        "500":
          description: |
            Server Error. An error has been encountered while processing this request.

              * **500** - Server Error - Internal server error. Please report
          schema:
            properties:
              error_code:
                type: string
                description: The error code for this error.
              error_description:
                type: string
                description: A human readable description of the error.
definitions:
  inline_response_200_34:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique job id.
      query:
        type: string
        description: |
          The JSON query string for this job.
      ignore_case:
        type: boolean
        description: |
          ignore case in the query
      offset:
        type: integer
        description: |
          Delete only resources that occur after this offset.
      limit:
        type: integer
        description: |
          The maximum number of the
      delete_resource:
        type: string
        description: |
          Resource to be deleted.
          Allowed values are:
          - MESSAGES
          - MESSAGE_REQUESTS
          - ATTACHMENTS
          - CONTACTS
  Digits_Collector:
    type: object
    required:
    - prompt
    properties:
      max_digits:
        type: string
        description: |
          will stop collecting digits when max_digits is reached
      timeout:
        type: integer
        description: |
          will stop collecting if timeout is reached
      terminating_digits:
        type: string
        description: |
          Will stop if some of terminating_digits  is  pressed
      prompt:
        $ref: '#/definitions/digit_collector_prompt'
  digit_collector_prompt:
    type: object
    required:
    - sentence
    properties:
      sentence:
        type: string
        description: |
          sentence to speak in the prompt
      voice:
        type: string
        description: |
          voice to speak the senttence
      gender:
        type: string
        description: |
          gender of the voice
      locale:
        type: string
        description: |
          language locale of the voice
  inline_response_200_31:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_31_list'
  inline_response_200_30:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_30_list'
  Sender_ID_Message_Template_2:
    type: object
    properties:
      designation:
        type: string
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
      name:
        type: string
        description: |
          The name of the template.
      pattern:
        type: string
        description: |
          template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Report Job:
    type: object
    properties:
      query:
        type: string
        description: |
          The JSON query string for this report.
      fileds:
        type: string
        description: |
          A list of field names to be included in the report.
      sort:
        type: string
        description: |
          The sort parameters to be used.
      report_type:
        type: string
        description: |
          The type of the report.  Can be:
          - MESSAGES
          - CONTACTS
  Conference:
    type: object
    required:
    - from
    properties:
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      from:
        type: string
        description: |
          The calling party's address.
  inline_response_200_16_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier, allocated by SCG at the time of contact creation
      external_id:
        type: string
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
      first_name:
        type: string
        description: |
          First name of customer
      last_name:
        type: string
        description: |
          Last name of customer
      birth_date:
        type: string
        description: |
          Customer birth date. YYYY-MM-DD
      first_acquisition_date:
        type: string
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
      last_acquisition_date:
        type: string
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
      primary_mdn:
        type: string
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
      primary_addr_line1:
        type: string
        description: |
          Details of customers primary address
      primary_addr_line2:
        type: string
        description: |
          Details of customers primary address
      primary_addr_city:
        type: string
        description: |
          Details of customers primary address
      primary_addr_zip:
        type: string
        description: |
          ZIP code of the customer primary address
      primary_addr_state:
        type: string
        description: |
          Details of customers primary address
      primary_email_addr:
        type: string
        description: |
          Customers primary email address
      primary_addr_country:
        type: string
        description: |
          Customer primary address country
      primary_social_handle:
        type: string
        description: |
          Customers primary social media ID
      address_list:
        type: string
        description: |
          Stores all known addresses of the customer in a form of a JSON array. Each address in the array can have the following attributes:
          - priority: priority of the address, 1 highest
          - designation: specifies type of the address: home, work
          - use: billing, shipping
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - line1: first address line
          - line2: second address line
          - city
          - state
          - province
          - zip
          - country
      account_list:
        type: string
        description: |
          Stores all known accounts of the customer in a form of a JSON array. Each account in the array can have the following attributes:
          - priority: user defined account priority
          - designation:  primary designation of the account: work, private ...
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - type: email, social, web, loyalty
          - username: the username in the account. This will be the membership id in loyalty programs or the email address for an email account
          - domain: account domain. For example starwood.com
          - access_token: the access token to the account where the account requires some oauth type authorization
          NOTE: other attributes may be required/provided, based on the account type and domain.
      device_list:
        type: string
        description: "Stores all known customer devices in a form of a JSON array. Each account in the device can have the following attributes:\n- priority: user defined account priority\n- designation:  primary designation of the account: work, private ...\n- source: specifies where the address comes from, company specific\n- status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED\n- msisdn\n- carrier\n- mac_address, \n- uuid\n- imei \n- manufacturer: device manufacturer, for example Apple\n- model: model of the device, for example iPhone 5s\n- os: operating system of the device, for example iOS 8.3\nNOTE: other attributes may be required/provided, based on the device type.\n"
      interest_list:
        type: string
        description: "Stores all known customer preferences in a form of a JSON array. Each preference can have the following attributes:\n- code: interest code \n- name: interest name\n- source: where the information was obtained\n- score: how likely the information is, floating point value 0...1\n"
      demographic_list:
        type: string
        description: |
          Stores all known customer demographic in a form of a JSON array. Each demographic can have the following attributes:
          - demographic name
          - source: where the information was obtained
          - score: how likely the information is, floating point value 0...1
      extended_attributes:
        type: string
        description: |
          JSON string of all extended attributes of the customer. Any list of key:value pairs is supported. Also composite attributes can be stored.
      fast_access:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_1:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_2:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_3:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_4:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_5:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_6:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_7:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_8:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_9:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_10:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_11:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_12:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_13:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_14:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_15:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_16:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_17:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_18:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_19:
        type: string
        description: |
          JSON object containing current values of fast access attributes
      fast_access_20:
        type: string
        description: "JSON object containing current values of fast access attributes \n"
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      preferred_language:
        type: string
        description: |
          When translation is enabled, the message to this contact will be translated
      voice_preference:
        type: boolean
        description: "This contacts preference setting for voice message delivery: \n- NONE : no preference\n- PREFER_VOICE : contact prefers voice if possible (voice capable sender ID available as message originator and is not rejected due to price or other policy)\n- REQUIRE_VOICE : contact requires voice - selecting voice capable sender ID overrides price and other policies; message fails if voice sender ID is not available\n"
      social_handles:
        type: string
        description: |
          list of social handles
      social_profile_lookup_prefix:
        type: string
        description: |
          which social id to use to update contact info
      social_profile_lookup_override:
        type: boolean
        description: |
          If set to true will overwrite existing contact attributes that are collected from social id
      timezone:
        type: string
        description: |
          The Timezone
      gender:
        type: string
        description: |
          "The gender. \nSupported values are:\n- female\n- male\n"
      profile_picture_url:
        type: string
        description: |
          The url to the profile picture
      is_rcs_capable:
        type: boolean
        description: |
          Is rcs capable: true or false
  inline_response_200_36:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_36_list'
  Application_Instance_Session_1:
    type: object
    properties:
      call_id:
        type: string
        description: |
          The id of the call that the prompt will be played to.
      processor_id:
        type: string
        description: |
          The id that was sent in the processor event.
      next_step:
        type: string
        description: |
          The name of the application script step that should be executed next.
      prompt:
        type: string
        description: |
          A prompt that should be played to the user.
  inline_response_200_29_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique job id
      description:
        type: string
        description: |
          A description of this instance.
      script_id:
        type: string
        description: |
          The is of the script to be used for this instance.
      sender_id:
        type: string
        description: |
          The sender_id that is to be used with this instance.
      state:
        type: string
        description: |
          The state of the instance. This can be:
          - ENABLED
          - DISABLED
      allow_incoming_call:
        type: string
        description: |
          This is used to enable handling of incoming calls by the application instance.
      createTime:
        type: string
        description: |
          The instance created time
      modifyTime:
        type: string
        description: |
          The instance modyfied time
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Sender_Import_Job_1:
    type: object
    properties:
      approval_state:
        type: string
        description: |
          sender ids import approval state (WAITING, APPROVED, REJECTED, AUTO)
      bulk_permission:
        type: string
        description: |
          bulk permission
      batch_size_limit:
        type: integer
        description: |
          batch size limit
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      register_provider:
        type: string
        description: |
          register provider (NETNUMBERS, NONE, ZIPWHIP)
      charges:
        type: string
        description: |
          sender id fee type (PROCESSING, SETUP, INITIAL, RECURRING, CONSENT_INITIAL, CONSENT_RECURRING, IMPLEMENTATION)
  inline_response_200_31_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier, allocated by SCG at the time of Connector creation
      external_id:
        type: string
        description: |
          The id of the Connector at the customer system. Can be used by customer to update the Connectors
      type:
        type: string
        description: |
          The type of the customer (bot) side API this connector will use. Currently supported values:

            * AZURE_BOT_DIRECT_LINE - Microsoft Azure Bot Framework Direct Line API
      sender_id:
        type: string
        description: |2+

      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
  inline_response_200_15_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique id of the digits collector
      external_id:
        type: string
        description: |
          external Id
      state:
        description: |
          current state
      reason:
        type: string
        description: |
          reason for terminating
      start_time:
        type: string
        description: |
          start time
      end_time:
        type: string
        description: |
          end time
      call_id:
        type: string
        description: |
          id of the call
      call_external_id:
        type: string
        description: |
          external call id
      digits:
        type: string
        description: |
          collected digits
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
  inline_response_200_24:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_24_list'
  inline_response_200_23:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_23_list'
  inline_response_200_20:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_20_list'
  inline_response_200_29:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_29_list'
  Keywords_2:
    type: object
    properties:
      name:
        type: string
        description: |
          name of the keyword
      description:
        type: string
        description: |
          description of the keyword
      value:
        type: string
        description: |
          the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
      case:
        type: string
        description: |
          SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
      sender_id:
        type: string
        description: |
          The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
      valid_from:
        type: string
        description: |
          the date range for which the keyword is valid
      valid_to:
        type: string
        description: |
          the date range for which the keyword is valid
      associated_info:
        type: string
        description: |
          additional information, value is at customer discretion, this attribute is added to the keyword event whenever the keyword is detected
      campaign_id:
        type: string
        description: |
          The campaign id
      type:
        type: string
        description: |
          the type of the keyword:
          - RESERVED: those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them
          - COMPANY: company specific keywords
      actions:
        type: string
        description: |
          actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space:
          - OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)
          - OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)
          - STORE -> no action, just record in user profile
      reply_template:
        type: string
        description: |
          if specified then SCG will send a predefined message back to the user. This attribute will contain the name of the message template to be used in the automatic reply
      attachments:
        type: string
        description: |
          List of attachments to be sent as autoreplay
      search_words_count:
        type: integer
        description: |
          Server will search for pattern in first search_words  words of the message
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Application_Script_1:
    type: object
    properties:
      name:
        type: string
        description: |
          The name of the script.
      description:
        type: string
        description: |
          A description of the script.
      body:
        type: string
        description: |
          The script XML.
  Keywords_1:
    type: object
    properties:
      name:
        type: string
        description: |
          name of the keyword
      description:
        type: string
        description: |
          description of the keyword
      value:
        type: string
        description: |
          the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
      case:
        type: string
        description: |
          SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
      sender_id:
        type: string
        description: |
          The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
      valid_from:
        type: string
        description: |
          the date range for which the keyword is valid
      valid_to:
        type: string
        description: |
          the date range for which the keyword is valid
      associated_info:
        type: string
        description: |
          additional information, value is at customer discretion, this attribute is added to the keyword event whenever the keyword is detected
      campaign_id:
        type: string
        description: |
          The campaign id
      type:
        type: string
        description: |
          the type of the keyword:
          - RESERVED: those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them
          - COMPANY: company specific keywords
      actions:
        type: string
        description: |
          actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space:
          - OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)
          - OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)
          - STORE -> no action, just record in user profile
      reply_template:
        type: string
        description: |
          if specified then SCG will send a predefined message back to the user. This attribute will contain the name of the message template to be used in the automatic reply
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Application_Script:
    type: object
    properties:
      name:
        type: string
        description: |
          The name of the script.
      description:
        type: string
        description: |
          A description of the script.
      body:
        type: string
        description: |
          The script XML.
  inline_response_200_25:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_17'
  inline_response_200_28:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_28_list'
  inline_response_200_27:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_27_list'
  Delete Job:
    type: object
    properties:
      query:
        type: string
        description: |
          The JSON query string for this job.
      ignore_case:
        type: boolean
        description: |
          ignore case in the query
      offset:
        type: integer
        description: |
          Delete only resources that occur after this offset.
      limit:
        type: integer
        description: |
          The maximum number of the
      delete_resource:
        type: string
        description: |
          Resource to be deleted.
          Allowed values are:
          - MESSAGES
          - MESSAGE_REQUESTS
          - ATTACHMENTS
          - CONTACTS
  Sender_Import_Job:
    type: object
    properties:
      import_attachment_id:
        type: string
        description: |
          attachment with csv data
      receipts_attachment_id:
        type: string
        description: |
          attachment with additional info
      address_type:
        type: string
        description: |
          Default Address type
      capabilities:
        type: string
        description: |
          default capabilities
      country:
        type: string
        description: |
          default country
      tollfree_billing:
        type: string
        description: |
          tollfree billing info
  Message_Request:
    type: object
    properties:
      from:
        type: string
        example: channel:1KJPMkuHQkair_o15etpmg
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      to:
        type: array
        example: 13467871829
        description: |
          For MT messages this will be a list of one or more recipient addresses, contact ids, contact group ids
        items:
          type: string
      body:
        type: string
        description: |
          This is the body of the message as supplied by the customer's application.  It can reference a message template and supply the variables assignments for use with a template or contain the actual message body
      attachments:
        type: array
        description: |
          A list of attachment IDs which are associated with this message.
        items:
          type: string
      media_urls:
        type: array
        description: |
          A list of publicly accessible URLs that point to media files.  The media files will be used as attachments to the message.
        items:
          type: string
      subject:
        type: string
        description: |
          The subject - a short summary of the message's purpose.
      application_id:
        type: string
        description: |
          ID of the application that has created the message request
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      consent_requirement:
        type: string
        description: |
          This field indicates if the message delivery is dependent on the consent status for the message recipient. This field is specific to a Sender address (Shortcode) that is classified as 'User Managed' consent.  This is meant for Businesses who are responsible for managing consent but use the SCG contacts database to store the consent status for message recipients. Any contacts/destination MDNs for end-users that a message is sent to but does not have an opt-in status associated with the sender address will be blocked (message will be created but will be in 'failed' status and will not be sent to the recipient).  Supported values are:
          - OPT_IN (message will be sent only if user explicitly opted in)
          - OPT_OUT (message will be sent unless user explicitly opted out)
          - NONE (message will be sent irrespectively of optin status)
      criteria:
        type: string
        description: |
          The criteria string which was used in the bulk transmission, if any.
      verify_number:
        type: boolean
        description: |
          If this flag is set to 'true' then the recipient phone numbers will be checked to ensure they are valid mobile numbers,  virtual mobile numbers or virtual landline numbers.
      recipient_ count:
        type: integer
        description: |
          The number of contacts satisfying the criteria (or in the contact group) who have an address on the channel the bulk message is targeted for.
      sent_count:
        type: integer
        description: |
          The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      delivered_count:
        type: integer
        description: |
          The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      read_count:
        type: integer
        description: |
          The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      converted_count:
        type: integer
        description: |
          The number of messages where conversion has been confirmed. This will apply for messages with URL where the application requested a link track. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      canceled_count:
        type: integer
        description: |
          The number of messages that have been created but not sent because the message request was canceled
      failover:
        type: string
        description: "Controls fail over to SMS in case of MMS, RCS and OTT message delivery failures. \nValid value: SMS\n"
      src_language:
        type: string
        description: |
          This is the source language of a message. The defauly is English 'en'
      dst_language:
        type: string
        description: |
          Translate message to a specified language. If not set,  only messages to contacts with language preference will be translated.
      translate:
        type: boolean
        description: |
          When translate attribute is set to 'true' translation of message body is enabled.
      content_type:
        type: string
        description: |
          The content type of the message request body.
      options:
        $ref: '#/definitions/Message_Request_options'
      body_extensions:
        type: array
        description: |
          Extended body
        items:
          $ref: '#/definitions/Message_Request_body_extensions'
      expiry_time:
        type: string
        example: "2023-07-31T15:50:00 or 2023-07-31 or Mon, 07 Aug 2023 11:54:28 UTC or 1690793596000"
        description: |
          Date when the message would be expired, to be passed in epoch format.
      scheduled_delivery_time:
        type: string
        example: "1690419562110"
        description: |
          Date when the message to be scheduled, to be passed in epoch format.
      scheduled_delivery_time_zone:
        type: string
        example: LOCAL
        description: |
          Date when the message to be scheduled for specific timezone.
      contact_delivery_address_priority:
        type: string
        example: "WHATSAPP,MDN"
        description: |
          Priority list of contact delivery addresses (MDN, PUSH)
  inline_response_200_9_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The identifier
      designation:
        type: string
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
      name:
        type: string
        description: |
          The name of the template.
      pattern:
        type: string
        description: |
          template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
      ownership:
        type: string
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Contact_1:
    type: object
    properties:
      external_id:
        type: string
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
      first_name:
        type: string
        description: |
          First name of customer
      last_name:
        type: string
        description: |
          Last name of customer
      birth_date:
        type: string
        description: |
          Customer birth date. YYYY-MM-DD
      first_acquisition_date:
        type: string
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
      last_acquisition_date:
        type: string
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
      primary_mdn:
        type: string
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
      primary_addr_line1:
        type: string
        description: |
          Details of customers primary address
      primary_addr_line2:
        type: string
        description: |
          Details of customers primary address
      primary_addr_city:
        type: string
        description: |
          Details of customers primary address
      primary_addr_zip:
        type: string
        description: |
          ZIP code of the customer primary address
      primary_addr_state:
        type: string
        description: |
          Details of customers primary address
      primary_email_addr:
        type: string
        description: |
          Customers primary email address
      primary_addr_country:
        type: string
        description: |
          Customer primary address country
      primary_social_handle:
        type: string
        description: |
          Customers primary social media ID
      address_list:
        type: string
        description: |
          Stores all known addresses of the customer in a form of a JSON array. Each address in the array can have the following attributes:
          - priority: priority of the address, 1 highest
          - designation: specifies type of the address: home, work
          - use: billing, shipping
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - line1: first address line
          - line2: second address line
          - city
          - state
          - province
          - zip
          - country
      account_list:
        type: string
        description: |
          Stores all known accounts of the customer in a form of a JSON array. Each account in the array can have the following attributes:
          - priority: user defined account priority
          - designation:  primary designation of the account: work, private ...
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - type: email, social, web, loyalty
          - username: the username in the account. This will be the membership id in loyalty programs or the email address for an email account
          - domain: account domain. For example starwood.com
          - access_token: the access token to the account where the account requires some oauth type authorization
          NOTE: other attributes may be required/provided, based on the account type and domain.
      device_list:
        type: string
        description: "Stores all known customer devices in a form of a JSON array. Each account in the device can have the following attributes:\n- priority: user defined account priority\n- designation:  primary designation of the account: work, private ...\n- source: specifies where the address comes from, company specific\n- status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED\n- msisdn\n- carrier\n- mac_address, \n- uuid\n- imei \n- manufacturer: device manufacturer, for example Apple\n- model: model of the device, for example iPhone 5s\n- os: operating system of the device, for example iOS 8.3\nNOTE: other attributes may be required/provided, based on the device type.\n"
      interest_list:
        type: string
        description: "Stores all known customer preferences in a form of a JSON array. Each preference can have the following attributes:\n- code: interest code \n- name: interest name\n- source: where the information was obtained\n- score: how likely the information is, floating point value 0...1\n"
      demographic_list:
        type: string
        description: |
          Stores all known customer demographic in a form of a JSON array. Each demographic can have the following attributes:
          - demographic name
          - source: where the information was obtained
          - score: how likely the information is, floating point value 0...1
      extended_attributes:
        type: string
        description: |
          JSON string of all extended attributes of the customer. Any list of key:value pairs is supported. Also composite attributes can be stored.
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Contact_2:
    type: object
    properties:
      external_id:
        type: string
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
      first_name:
        type: string
        description: |
          First name of customer
      last_name:
        type: string
        description: |
          Last name of customer
      birth_date:
        type: string
        description: |
          Customer birth date. YYYY-MM-DD
      first_acquisition_date:
        type: string
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
      last_acquisition_date:
        type: string
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
      primary_mdn:
        type: string
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
      primary_addr_line1:
        type: string
        description: |
          Details of customers primary address
      primary_addr_line2:
        type: string
        description: |
          Details of customers primary address
      primary_addr_city:
        type: string
        description: |
          Details of customers primary address
      primary_addr_zip:
        type: string
        description: |
          ZIP code of the customer primary address
      primary_addr_state:
        type: string
        description: |
          Details of customers primary address
      primary_email_addr:
        type: string
        description: |
          Customers primary email address
      primary_addr_country:
        type: string
        description: |
          Customer primary address country
      primary_social_handle:
        type: string
        description: |
          Customers primary social media ID
      address_list:
        type: string
        description: |
          Stores all known addresses of the customer in a form of a JSON array. Each address in the array can have the following attributes:
          - priority: priority of the address, 1 highest
          - designation: specifies type of the address: home, work
          - use: billing, shipping
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - line1: first address line
          - line2: second address line
          - city
          - state
          - province
          - zip
          - country
      account_list:
        type: string
        description: |
          Stores all known accounts of the customer in a form of a JSON array. Each account in the array can have the following attributes:
          - priority: user defined account priority
          - designation:  primary designation of the account: work, private ...
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - type: email, social, web, loyalty
          - username: the username in the account. This will be the membership id in loyalty programs or the email address for an email account
          - domain: account domain. For example starwood.com
          - access_token: the access token to the account where the account requires some oauth type authorization
          NOTE: other attributes may be required/provided, based on the account type and domain.
      device_list:
        type: string
        description: "Stores all known customer devices in a form of a JSON array. Each account in the device can have the following attributes:\n- priority: user defined account priority\n- designation:  primary designation of the account: work, private ...\n- source: specifies where the address comes from, company specific\n- status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED\n- msisdn\n- carrier\n- mac_address, \n- uuid\n- imei \n- manufacturer: device manufacturer, for example Apple\n- model: model of the device, for example iPhone 5s\n- os: operating system of the device, for example iOS 8.3\nNOTE: other attributes may be required/provided, based on the device type.\n"
      interest_list:
        type: string
        description: "Stores all known customer preferences in a form of a JSON array. Each preference can have the following attributes:\n- code: interest code \n- name: interest name\n- source: where the information was obtained\n- score: how likely the information is, floating point value 0...1\n"
      demographic_list:
        type: string
        description: |
          Stores all known customer demographic in a form of a JSON array. Each demographic can have the following attributes:
          - demographic name
          - source: where the information was obtained
          - score: how likely the information is, floating point value 0...1
      extended_attributes:
        type: string
        description: |
          JSON string of all extended attributes of the customer. Any list of key:value pairs is supported. Also composite attributes can be stored.
      preferred_language:
        type: string
        description: |
          When translation is enabled, the message to this contact will be translated
      voice_preference:
        type: boolean
        description: "This contacts preference setting for voice message delivery: \n- NONE : no preference\n- PREFER_VOICE : contact prefers voice if possible (voice capable sender ID available as message originator and is not rejected due to price or other policy)\n- REQUIRE_VOICE : contact requires voice - selecting voice capable sender ID overrides price and other policies; message fails if voice sender ID is not available\n"
      social_handles:
        type: string
        description: |
          list of social handles
      social_profile_lookup_prefix:
        type: string
        description: |
          which social id to use to update contact info
      social_profile_lookup_override:
        type: boolean
        description: |
          If set to true will overwrite existing contact attributes that are collected from social id
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Channel_2:
    type: object
    properties:
      name:
        type: string
        description: |
          User Specified Name of the Channel
      priority:
        type: string
        description: |
          Determines the channel priority: high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
      description:
        type: string
        description: |
          Description of the Channel
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Message_1:
    type: object
    properties:
      conversation_id:
        type: string
        description: |
          The identifier of the conversation for conversation threading.
      campaign_id:
        type: string
        description: |
          The campaign id: A unique identifier for a particular messaging campaign or program
      subject:
        type: string
        description: |
          Subject of the message.
      body:
        type: string
        description: |
          The message body as sent to the recipient.
      attachments:
        type: array
        description: |
          A list of attachment IDs which are associated with this message.
        items:
          type: string
      scheduled_delivery_time:
        type: string
        description: |
          The date and time that this message should be delivered. This is the user specific time as calculated by the SCG based on the destination time zone and requested time zone calculation.
      scheduled_delivery_time_zone:
        type: string
        description: |
          Determines what time zone to apply to the scheduled delivery time:
          - UTC  - If no timezone was supplied in the delivery time then UTC is used.
          - LOCAL -  means that the scheduled delivery time as supplied in the request is expressed in LOCAL recipient time. The time zone of the recipient is determined by SCG automatically based on the primary_address_zip value in the recipient contact record.  The UTC time of day of the supplied scheduled_delivery_time will be used to deliver to the recipient at the same time of day in the local timezone.  For example, if the supplied scheduled delivery time is May 24th at 11:00am UTC, then the message would be delivered to someone with a zipcode in the Pacific timezone at  May 24th at 11:00am PDT.
      expiry_time:
        type: string
        description: |
          This is the timestamp after which the messages will no Integer be sent to the downstream system for delivery
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      contact_delivery_address_priority:
        type: string
        description: |
          Priority list of contact delivery addresses (MDN, PUSH)
      failover:
        type: string
        description: "Controls fail over to SMS in case of MMS, RCS and OTT message delivery failures. \nValid value: SMS\n"
      verify_number:
        type: boolean
        description: |
          If this flag is set to 'true' then the recipient phone numbers will be checked to ensure they are valid mobile numbers,  virtual mobile numbers or virtual landline numbers.
      verify_sms:
        type: boolean
        description: |
          If this flag is set to 'true' then the message content  and the sender of the message will be verified via the  Google messages application. If the verification is  successful, the end-user will be shown a transcript  stating that the message was verified along with  the customer's logo in the Google messages application.
      options:
        type: string
        description: |
          json options in use with push notifications
      sender_id_sort_criteria:
        type: string
        description: |
          Priority list of SenderId selection criteria (DELIVERY_ADDRESS, PRICE)
      from:
        type: string
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      price_threshold:
        type: integer
        description: |
          The price threshold for messages in a request
      to:
        type: string
        description: |
          Recipient address or contact id.
      src_language:
        type: string
        description: |
          This is the source language of a message. The defauly is English 'en'
      dst_language:
        type: string
        description: |
          Translate message to a specified language. If not set,  only messages to contacts with language preference will be translated.
      translate:
        type: boolean
        description: |
          When translate attribute is set to 'true' translation of message body is enabled.
      consent_requirement:
        type: string
        description: |
          This field indicates if the message delivery is dependent on the consent status for the message recipient. This field is specific to a Sender address (Shortcode) that is classified as 'User Managed' consent.  This is meant for Businesses who are responsible for managing consent but use the SCG contacts database to store the consent status for message recipients. Any contacts/destination MDNs for end-users that a message is sent to but does not have an opt-in status associated with the sender address will be blocked (message will be created but will be in 'failed' status and will not be sent to the recipient).  Supported values are:
          - OPT_IN (message will be sent only if user explicitly opted in)
          - OPT_OUT (message will be sent unless user explicitly opted out)
          - NONE (message will be sent irrespectively of optin status)
  Contact_3:
    type: object
    properties:
      sender_id_address:
        type: string
        description: |
          The address of the sender Id that is associated with this application.
      message_delivery_provider:
        type: string
        description: |
          The code that indicates the message devliery provider (e.g. APN, GCN)
      token:
        type: string
        description: |
          The token the user, application and device.
  Message_Request_1:
    type: object
    properties:
      from:
        type: string
        description: "The channel or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      to:
        type: array
        description: |
          For MT messages this will be a list of one or more recipient addresses, contact ids, contact group ids
        items:
          type: string
      body:
        type: string
        description: |
          This is the original message body as supplied by application, prior to keyword processing.
          It can reference a message template and supply the variables assignments for use with a template or contain the actual message body
      attachments:
        type: array
        description: |
          A list of attachment IDs which are associated with this message.
        items:
          type: string
      campaign_id:
        type: string
        description: |
          The customer provided campaign id.
      subject:
        type: string
        description: |
          The subject - a short summary of the message's purpose.
      application_id:
        type: string
        description: |
          ID of the application that has created the message request
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
  Contact_4:
    type: object
    properties:
      sender_id_address:
        type: string
        description: |
          The address of the sender Id that is associated with this application.
      message_delivery_provider:
        type: string
        description: |
          The code that indicates the message devliery provider (e.g. APN, GCN)
      token:
        type: string
        description: |
          The token the user, application and device.
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Sender_ID_2:
    type: object
    properties:
      sender_ids:
        type: array
        description: |
          A list of sender ids
        items:
          type: string
  Message_3:
    type: object
    required:
    - call_ids
    properties:
      call_ids:
        type: array
        description: |
          The list of Call IDs for the calls associated with this bridge.
        items:
          type: string
  Contact_5:
    type: object
    properties:
      contacts:
        type: array
        description: |
          a list of contacts
        items:
          type: string
  Sender_ID_1:
    type: object
    properties:
      parent_id:
        type: string
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
      name:
        type: string
        description: |
          name of the sender address
      ownership:
        type: string
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
      class_id:
        type: string
        description: |
          reference to the sender address class that determines the priority and throughput of the configured sender id
      type_id:
        type: string
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
      state:
        type: string
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
      address:
        type: string
        description: |
          The sender address. The address must correspond to the sender address type. For a2p sms this will be the shortcode or Integercode, for emails this will be the email address etc... For push this is a unique application name.  This name will be used in contacts to identify the application specific push registration ids for a particular user.
      content_type:
        type: string
        description: |
          the content of this field is specific the sender type / gateway associated with this sender
      message_templates:
        type: array
        description: |
          A list of template ids that apply to this sender address. If more than one template applies, the elements will be separated by  a coma.
        items:
          type: string
      country:
        type: string
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
      credentials:
        type: string
        description: |
          An array of  inline JSON objects with a list of name, value pairs that contain the credential and configuration values need to use this sender ID.  There is one object in the array per message delivery provider that will be used for delivery messages with this sender ID.  For example, the array may contain one entry for APN and one entry for GCN.
      consent_managed_by:
        type: string
        description: |
          Possible values: USER, SCG or SCG_UNSOLICITED_OPT_OUT. Default is USER
      capabilities:
        type: array
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, VOICE, WhatsApp etc.
        items:
          type: string
      check_white_list:
        type: boolean
        description: |
          If set, sending via this sender ID is limited to recipients present in the customer's white list.
      register_number:
        type: string
        description: |
          When the 'register_number' can be set to 'true' or 'false'. When set to 'true', this instructs SCG to register a Telephone number with the appropriate Operator or Registration entity.
      register_method:
        type: string
        description: |
          Provides registration method for sender ids that need registration step - currently WhatsApp sender ids.

          Values:

           * voice - deliver verification code via phone call
           * sms -  deliver verification code via SMS
      verification_code:
        type: string
        description: |
          Provides verification code for sender ids that need verification step - currently WhatsApp sender ids.
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Channel_1:
    type: object
    properties:
      name:
        type: string
        description: |
          User Specified Name of the Channel
      priority:
        type: string
        description: |
          Determines the channel priority: high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
      description:
        type: string
        description: |
          Description of the Channel
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_7_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier
      name:
        type: string
        description: |
          The name of the attachment (e.g. it's filename or other non-generated identifier)  The value of this field should be unique for a given message.
      type:
        type: string
        description: |
          The MIME type of the attachment (if known)
      size:
        type: integer
        description: |
          The size, in bytes, of the attachment body
      filename:
        type: string
        description: |
          Original file name of the attachment
      state:
        type: string
        description: |
          CREATED, UPLOADED
      content_url:
        type: string
        description: |
          The url of the content
      designation:
        type: string
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediation channel.
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Message_2:
    type: object
    properties:
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      call_ids:
        type: array
        description: |
          The list of Call IDs for the calls associated with this bridge.
        items:
          type: string
  inline_response_200_13_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique identifier for this resource.
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      from:
        type: string
        description: |
          The calling party's address.
      state:
        type: string
        description: |
          The conference's state:
           - created (the conference is created but has no members)
           - active (the conference is active and has members)
           - completed (the conference is completed and has no members)
      created_time:
        type: string
        description: |
          The date the conference was created.
      completed_time:
        type: string
        description: |
          The time the conference was ended.
      active_members:
        type: integer
        description: |
          Number of active members in the conference.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          For a MT message (one which was sent via this API), this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediation channel.
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_19_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique id of a mapping rule
      target_attribute:
        type: string
        description: |
          The name in the contact resource this mapping applies to: fast_access_1 .. fast_access_20.
      target_attribute_name:
        type: string
        description: |
          The friendly name of the fast access attribute. The corresponding attribute will appear under the fast_access sb-object of the contact object. The name must be used for all contact updates. It can be used with filters like fast_access.<name>
          If not provided, the corresponding attribute will appear in the contact and filter criteria as is.
      value_derivation_script:
        type: string
        description: |
          The rule - JSON Path expression _ on how to compute the value of the target attribute from the contact.
          If not provided the corresponding attribute will be editable in the contact.
      user_data:
        type: string
        description: |
          Data that the user can associate with an attribute, in case they want to do client side mapping instead of using target_attribute_name to do server side mapping of the attributes.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Digits Collector_1:
    type: object
    properties:
      max_digits:
        type: string
        description: |
          will stop collecting digits when max_digits is reached
      timeout:
        type: integer
        description: |
          will stop collecting if timeout is reached
      terminating_digits:
        type: string
        description: |
          Will stop if some of terminating_digits  is  pressed
      prompt:
        type: string
        description: |
          prompt to be  played when start digits collecting
  Contact Import:
    type: object
    properties:
      contact_group_id:
        type: string
        description: |
          Contact Group id - optional, add imported contacts to this group
      import_attachment_id:
        type: string
        description: |
          Import file attachment id - should be in state UPLOADED (file uploaded)
  inline_response_200_18_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier, allocated by SCG at the time of contact Application Token creation
      sender_id_address:
        type: string
        description: |
          The address of the sender Id that is associated with this application.
      message_delivery_provider:
        type: string
        description: |
          The code that indicates the message devliery provider (e.g. APN, GCN)
      token:
        type: string
        description: |
          The token the user, application and device.
      state:
        type: string
        description: |
          The application token's state:
           - ACTIVE
           - INVALID
      badges:
        type: integer
        description: |
          The budges
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_update_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_12_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique identifier for this resource.
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      state:
        type: string
        description: |
          The bridge state:
          - CREATED - The Bridge has been created.
          - ACTIVE - The Bridge is active.
          - HOLD - The Bridge in on hold.
          - COMPLETED - The Bridge has been completed and is no longer active.
          - ERROR - The bridge failed to be created or was ended due to an error.
      completed_time - date:
        type: string
        description: |
          The time that the Bridge was completed.
      activated_time - date:
        type: string
        description: |
          The time that the bridge was activated.
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_1_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique id of the address type
      name:
        type: string
        description: |
          Name of the address type
      description:
        type: string
        description: |
          human readable description of the sender address type
      capabilities:
        type: string
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, EMAIL, etc.
      allowed_mime_types:
        type: string
        description: |
          content type allowed on the sender id. This is a coma delimited list of MIME types. If the list is empty, all MIME types except for the blocked ones are allowed
      blocked_mime_types:
        type: string
        description: |
          content type explicitly blocked on the sender id type. This is a coma delimited list of content types on the sender id.
      gateway_id:
        type: string
        description: |
          this is the id of the gateway / connector to the downstream system that will handle the message delivery. The known gateways/connectors and the respective connection parameters for the gateway are configured separately.
      credential_parameter_list:
        type: array
        items:
          type: string
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Attachment_Data:
    type: object
    properties:
      content-data:
        type: string
        description: |
          The binary data associated with the attachment.  The content-type of the HTPP request/reponse is the content type of the data.
  Call:
    type: object
    required:
    - from
    - to
    properties:
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      from:
        type: string
        description: |
          The Sender ID associated with this call.
      to:
        type: string
        description: |
          The called party's address.
      answer_timeout:
        type: integer
        description: |
          The number of miliseconds that the service will wait for an answer.
      bridge_id:
        type: string
        description: |
          the bridge ID to connect the call
  Access_Token_2:
    type: object
    properties:
      resource:
        type: string
        description: |
          This is the type of resource that this token is associated with. Supported types.
          - ATTACHMENT
          - CONTACT
      resource_id:
        type: string
        description: |
          The unique ID for the resource instance that this token is associated with.
      expiry_time:
        type: string
        description: |
          The UTC timestamp after which the token is no Integer valid.
  Attachment_1:
    type: object
    properties:
      name:
        type: string
        description: |
          The name of the attachment (e.g. it's filename or other non-generated identifier)  The value of this field should be unique for a given message.
      type:
        type: string
        description: |
          The MIME type of the attachment (if known)
      filename:
        type: string
        description: |
          Original file name of the attachment
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Call_1:
    type: object
    required:
    - state
    properties:
      state:
        type: string
        description: |
          The call state can be:
          - STARTED
          - ACTIVE
          - COMPLETED
  Call_2:
    type: object
    properties:
      state:
        type: string
        description: |
          The call's state:
          - STARTED - The call is being setup.
          - ACTIVE - The call is in progress.
          - REJECTED - The called party did not answer.
          - COMPLETED - The call is complete.
  AudioFile_7:
    type: object
    properties:
      text:
        type: string
        description: |
          The text to be spoken.
      language:
        type: string
        description: |
          The language of the text.
      gender:
        type: string
        description: "The gender of the speaker. \nSupported values are:\n- female\n- male\n"
      voice:
        type: string
        description: |
          One of the supported voices.  Voice implies gender and language.
          Supported values are referenced in this page:
          https://sdcsupport.syniverse.com/hc/en-us/articles/360042993153-Customizing-Spoken-Text-on-SCG-Voice-API-with-SSML-tags
  AudioFile_5:
    type: object
    required:
    - source
    - source_type
    properties:
      source_type:
        type: string
        description: "This is the type of the source.  \nSupported values are:\n- ATTACHMENT\n- URL\n"
      source:
        type: string
        description: |
          The attachment ID or URL value for the audio file.
  AudioFile_6:
    type: object
    properties:
      source_type:
        type: string
        description: "This is the type of the source.  \nSupported values are:\n- ATTACHMENT\n- URL\n"
      source:
        type: string
        description: |
          The attachment ID or URL value for the audio file.
  Sender_ID_Message_Template_1:
    type: object
    properties:
      designation:
        type: string
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
      name:
        type: string
        description: |
          The name of the template.
      pattern:
        type: string
        description: |
          template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Application_Instance_Session:
    type: object
    properties:
      to_address:
        type: string
        description: |
          The address to which the session should be established.
      state:
        type: string
        description: |
          The state of the session This can be:
          - NOTSTARTED
          - ACTIVE
          - PAUSED
          - COMPLETED
  AudioFile_3:
    type: object
    properties:
      text:
        type: string
        description: |
          The text to be spoken.
      language:
        type: string
        description: |
          The language of the text.
      gender:
        type: string
        description: "The gender of the speaker. \nSupported values are:\n- female\n- male\n"
      voice:
        type: string
        description: |
          One of the supported voices.  Voice implies gender and language.
          Supported values are referenced in this page:
          https://sdcsupport.syniverse.com/hc/en-us/articles/360042993153-Customizing-Spoken-Text-on-SCG-Voice-API-with-SSML-tags
  Access_Token_1:
    type: object
    properties:
      duration:
        type: string
        description: |
          The UTC timestamp after which the token is no Integer valid.
  inline_response_200_28_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique id
      description:
        type: string
        description: |
          A description of the script.
      body:
        type: string
        description: |
          The script XML.
      createTime:
        type: string
        description: |
          The script created time
      modifyTime:
        type: string
        description: |
          The script modyfied time
      capabilities:
        type: array
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, VOICE, WhatsApp etc.
        items:
          type: string
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  AudioFile_4:
    type: object
    required:
    - text
    properties:
      text:
        type: string
        description: |
          The text to be spoken.
      language:
        type: string
        description: |
          The language of the text.
      gender:
        type: string
        description: "The gender of the speaker. \nSupported values are:\n- female\n- male\n"
      voice:
        type: string
        description: |
          One of the supported voices.  Voice implies gender and language.
          Supported values are referenced in this page:
          https://sdcsupport.syniverse.com/hc/en-us/articles/360042993153-Customizing-Spoken-Text-on-SCG-Voice-API-with-SSML-tags
  AudioFile_1:
    type: object
    required:
    - source
    - source_type
    properties:
      source_type:
        type: string
        description: "This is the type of the source.  \nSupported values are:\n- ATTACHMENT\n- URL\n"
      source:
        type: string
        description: |
          The attachment ID or URL value for the audio file.
  Contact_Group_1:
    type: object
    properties:
      external_id:
        type: string
        description: |
          Customer supplied id of the contact group
      name:
        type: string
        description: |
          A name for the group
      description:
        type: string
        description: |
          Group description
      criteria:
        type: string
        description: |
          Filter definition for creation of the group. Users can use either criteria or members <FORMAT TBD -  figure our the syntax>
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Contact_Group_2:
    type: object
    properties:
      external_id:
        type: string
        description: |
          Customer supplied id of the contact group
      name:
        type: string
        description: |
          A name for the group
      description:
        type: string
        description: |
          Group description
      criteria:
        type: string
        description: |
          Filter definition for creation of the group. Users can use either criteria or members <FORMAT TBD -  figure our the syntax>
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  AudioFile_2:
    type: object
    properties:
      source_type:
        type: string
        description: "This is the type of the source.  \nSupported values are:\n- ATTACHMENT\n- URL\n"
      source:
        type: string
        description: |
          The attachment ID or URL value for the audio file.
  inline_response_200_4_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The channel identifier, allocated by SCG when channel is created
      name:
        type: string
        description: |
          User Specified Name of the Channel
      priority:
        type: string
        description: |
          Determines the channel priority: high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
      description:
        type: string
        description: |
          Description of the Channel
      ownership:
        type: string
        description: |
          SHARED/PRIVATE/PUBLIC
      message_templates:
        type: array
        description: |
          A list of template ids that apply to this sender address. If more than one template applies, the elements will be separated by  a coma.
        items:
          type: string
      country:
        type: string
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  TTS_Text:
    type: object
    required:
    - dtmfText
    properties:
      dtmfText:
        type: string
        description: |
          The DTFM digits to be played.
  Conference_1:
    type: object
    required:
    - state
    properties:
      state:
        type: string
        description: |
          The conference's state:
           - created (the conference is created but has no members)
           - active (the conference is active and has members)
           - completed (the conference is completed and has no members)
  Fast Access Job:
    type: object
    properties:
      target_attribute:
        type: string
        description: |
          Attribute that should be updated
      action:
        type: string
        description: |
          action on specified attribute
      value_derivation_script:
        type: string
        description: |
          update script
  ConferenceMember_1:
    type: object
    properties:
      hold:
        type: boolean
        description: |
          If true, this member is hold to join the conference
      mute:
        type: boolean
        description: |
          If 'true', this member is muted in the conference
  Attachment:
    type: object
    properties:
      name:
        type: string
        description: |
          The name of the attachment (e.g. it's filename or other non-generated identifier)  The value of this field should be unique for a given message.
      type:
        type: string
        description: |
          The MIME type of the attachment (if known)
      filename:
        type: string
        description: |
          Original file name of the attachment
  inline_response_200_24_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier, allocated by SCG at the time of the history record creation.
      msisdn:
        type: string
        description: |
          The value of the contact's address. For SMS/MMS this will be the MDN.
      sender_id:
        type: string
        description: |
          The sender id that MO/MT message was sent to/from
      source:
        type: string
        description: |
          The source of the contact's consent status information:
          - MESSAGE - when the consent status has changed as a result of a MO message sent by the contact (SCG managed consent)
          - CARRIER  - when a blacklist file was provided by a carrier and loaded in
          - COMPANY - when the user of SCG has supplied the information (USER managed consent)
      status:
        type: string
        description: |
          The new consent status of the contact
      timestamp:
        type: string
        description: |
          Timestamp indicating when the MO message that triggered the consent status change was received
      message:
        type: string
        description: |
          The body of the actual MO message that triggered the consent status change
      keyword:
        type: string
        description: |
          The keyword detected by the application
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
  Contact Export:
    type: object
    properties:
      contact_group_id:
        type: string
        description: |
          Contact Group id - optional, export contacts from given group only
  inline_response_200_23_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier, allocated by SCG at the time of address creation. This is a combination of an address type/value and sender id.
          SCG will allocate a new address_status_id for any message sent or received from a new combination of sender id and address value/type
      address_type:
        type: string
        description: |
          The address type: MDN (for phone numbers), EMAIL, SOCIAL, PUSH (...)
      address:
        type: string
        description: |
          The actual value of the address. For SMS/MMS this will be the MDN.
      sender_id:
        type: string
        description: |
          the sender id accociated with the address type/value
      consent_status:
        type: string
        description: |
          this is the current optin status for the specific address / sender id. The possible values are:
          - NONE (no optin or optout message received from the address on the specific sender id)
          - OPTIN (user has explicitly opted in to the sender id)
          - OPTOUT (user has explicitly opted out of the sender id)
          - BLACKLIST (blacklisted address - will be treated as explicit OPTOUT)
          - WHITELIST (whitelisted address - will be treated as explicit OPTIN)
          NOTE: Whitelisted or blacklisted status can not be overwritten by the end-user by sending messages to the sender id. Such users can be only un-listed by changing the optin-status explicitly put POST to address status ID
      from_address:
        type: string
        description: |
          The sender address.
      opt_in_type:
        type: string
        description: "The consent opt in type:\n - WEB,       \n - IVR,      \n - APP,     \n - EMAIL,\n - POS,\n - SMS,\n - SINGLE,\n - MIGRATION\n"
      opt_out_type:
        type: string
        description: "The consent opt out type:\n - WEB,       \n - IVR,      \n - APP,     \n - EMAIL,\n - POS,\n - SMS,\n - SINGLE,\n - MIGRATION\n"
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
  Sender_ID:
    type: object
    properties:
      parent_id:
        type: string
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
      name:
        type: string
        description: |
          name of the sender address
      ownership:
        type: string
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
      class_id:
        type: string
        description: |
          reference to the sender address class that determines the priority and throughput of the configured sender id
      type_id:
        type: string
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
      address:
        type: string
        description: |
          The sender address. The address must correspond to the sender address type. For a2p sms this will be the shortcode or Integercode, for emails this will be the email address etc... For push this is a unique application name.  This name will be used in contacts to identify the application specific push registration ids for a particular user.
      content_type:
        type: string
        description: |
          the content of this field is specific the sender type / gateway associated with this sender
      message_templates:
        type: array
        description: |
          A list of template ids that apply to this sender address. If more than one template applies, the elements will be separated by  a coma.
        items:
          type: string
      country:
        type: string
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
      credentials:
        type: string
        description: |
          An array of  inline JSON objects with a list of name, value pairs that contain the credential and configuration values need to use this sender ID.  There is one object in the array per message delivery provider that will be used for delivery messages with this sender ID.  For example, the array may contain one entry for APN and one entry for GCN.
      consent_managed_by:
        type: string
        description: |
          Possible values: USER, SCG or SCG_UNSOLICITED_OPT_OUT. Default is USER
      capabilities:
        type: array
        description: |
          Message types allowed on the sender ids from of this type: SMS, MMS, VOICE, WhatsApp etc.
        items:
          type: string
      check_white_list:
        type: boolean
        description: |
          If set, sending via this sender ID is limited to recipients present in the customer's white list.
      register_number:
        type: string
        description: |
          When the 'register_number' can be set to 'true' or 'false'. When set to 'true', this instructs SCG to register a Telephone number with the appropriate Operator or Registration entity.
      register_method:
        type: string
        description: |
          Provides registration method for sender ids that need registration step - currently WhatsApp sender ids.

          Values:

           * voice - deliver verification code via phone call
           * sms -  deliver verification code via SMS
      verification_code:
        type: string
        description: |
          Provides verification code for sender ids that need verification step - currently WhatsApp sender ids.
  inline_response_200_9:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_9_list'
  inline_response_200_5:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_5_list'
  Contact Group Job:
    type: object
    properties:
      source_group_id:
        type: string
        description: |
          source group
      query:
        type: string
        description: |
          filter contacts to be processed
      action:
        type: string
        description: |
          action
      target_group_id:
        type: string
        description: |
          target  group
  inline_response_200_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique id of the sender class
      name:
        type: string
        description: |
          Name of the sender class
      description:
        type: string
        description: |
          human readable description of the sender class
      designation:
        type: string
        description: |
          Primary channel designation - commercial, alerts, notifications...
      applicable_countries:
        type: array
        items:
          type: string
      country_peak_throughput:
        type: number
        description: |
          Maximum outbound channel throughput for a given customer per destination country expressed in transactions per second
      country_peak_total_throughput:
        type: number
        description: |
          Maximum outbound channel throughput for all customers using the short or Integer code per destination country expressed in transactions per second (this is the physical limit of the sender address)
      country_daily_throughput:
        type: number
        description: |
          Maximum outbound channel throughput for a given customer per destination country expressed in transactions per day
      delivery_window:
        type: string
        description: |
          Allowed delivery time for the messages. Applying the time validation, the time is to be considered in the time zone of the recipient. This is a JSON string with a list of allowed times by destination country. Countries are represented by an ISO country code. A special country code of 'DEFAULT' is to be used for the default country. For each country a delivery window can be specified. Each weekday can have different delivery window times. As weekday names, use of following days: MON, TUE, WED, THU, FRI, SAT, SUN as well as two additional keywords: HOL (representing local holiday in the country) and OTH (representing all other days of week)
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_6:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_6_list'
  inline_response_200_7:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_7_list'
  Channel:
    type: object
    properties:
      name:
        type: string
        description: |
          User Specified Name of the Channel
      priority:
        type: string
        description: |
          Determines the channel priority: high, normal or low. SCG will deliver to target system first for messages in high priority channels, then normal and at the end low priority. Message size does not affect the message priority
      description:
        type: string
        description: |
          Description of the Channel
  inline_response_200_8:
    type: object
    properties:
      content-data:
        type: string
        description: |
          The binary data associated with the attachment.  The content-type of the HTPP request/reponse is the content type of the data.
  Connector_1:
    type: object
    properties:
      external_id:
        type: string
        description: |
          The id of the Connector at the customer system. Can be used by customer to update the Connectors
      type:
        type: string
        description: |
          The type of the customer (bot) side API this connector will use. Currently supported values:

            * AZURE_BOT_DIRECT_LINE - Microsoft Azure Bot Framework Direct Line API
      sender_id:
        type: string
        description: |2+

      credentials:
        type: string
        description: ""
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_6_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier
      message_request_id:
        type: string
        description: |
          The unique id of the associated message request resource.
      external_message_request_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      conversation_id:
        type: string
        description: |
          The identifier of the conversation for conversation threading.
      campaign_id:
        type: string
        description: |
          The campaign id: A unique identifier for a particular messaging campaign or program
      direction:
        type: string
        description: |
          Message direction: MO for received messages and MT sent messages
      customer_sender_id:
        type: string
        description: |
          The sender_id associated with the message delivery channel. For MT messages this will be the sender_id used to deliver the message. For MO messages this will be the sender_id corresponding to the downstream system which generated the message (determined by SCG based on the from/to address accordingly)
      from_address:
        type: string
        description: |
          The sender address.
      to_address:
        type: string
        description: |
          The recipient address.
      state:
        type: string
        description: "The status of the message to this recipient.  \nValid values for MT messages are:\n- CREATED (message was created and is in the queue of SCG)\n- SENT (message was sent to the outbound delivery system)\n- DELIVERED (message was delivered to end-device of the user)\n- READ (message was read by the user)\n- CONVERTED (message was converted i.e. end user took action upon message)\n- FAILED (message delivery failed)\n- EXPIRED (message was too old to be sent)\n- SCHEDULED (message is created but not submitted for sending)\n- TEST (message was created but the request was a test request)\n- PAUSED (message was created but the request was to pause before delivery)\n- DELETED \nSCG will automatically set the status of the message to converted when the message contains a 'tracked' URL and the link was clicked by the recipient.\nAlternatively the customer also externally can track conversion and could update the message status put applying the PUT method and specifying status = CONVERTED and the conversion timestamp\nValid values for MO Messages are:\n- RECEIVED (received at SCG)\n- PROCESSED (when the customer has accessed the message and updated the status)\n- DELETED (when the message was deleted by the customer)\n"
      failure_code:
        type: string
        description: |
          INVALID_RECIPIENT, NO_CONSENT, OTHER
      failure_details:
        type: string
        description: |
          text description that gives more detail on failed messages
      subject:
        type: string
        description: |
          Subject of the message.
      body:
        type: string
        description: |
          The message body as sent to the recipient.
      sent_date:
        type: string
        description: |
          The timestamp when the message was submitted to downstream system for delivery
      delivered_date:
        type: string
        description: |
          The timestamp when the message has been delivered, corresponds to DR date.
      converted_date:
        type: string
        description: |
          The timestamp when the message was converted. This will be set automatically by SCG for messages with link tracking. For external tracking, the customer must provide the converted timestamp
      reply_to:
        type: string
        description: |
          The Message ID of a previously delivered message which the current message is a reply to.
      attachments:
        type: array
        items:
          type: string
      scheduled_delivery_time:
        type: string
        description: |
          The date and time that this message should be delivered. This is the user specific time as calculated by the SCG based on the destination time zone and requested time zone calculation.
      expiry_time:
        type: string
        description: |
          This is the timestamp after which the messages will no Integer be sent to the downstream system for delivery
      type:
        type: string
        description: |
          The message type (SMS, MMS, PSH, FB)
      contact_id:
        type: string
        description: |
          The ID of the contact (if any) this message was sent to
      price:
        type: number
        description: |
          The message cost.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The timestamp when the message was created, which corresponds to the time when the bulk message POST was done by the client.
      language:
        type: string
        description: |
          Language this message was translated to
      failedTranslation:
        type: string
        description: |
          The reason that translate failed for this message
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      request_body:
        type: string
        description: |
          This is the body of the message as supplied by the customer's application.  It can reference a message template and supply the variables assignments for use with a template or contain the actual message body
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      contact_delivery_address_priority:
        type: string
        description: |
          Priority list of contact delivery addresses (MDN, PUSH)
      failover:
        type: string
        description: "Controls fail over to SMS in case of MMS, RCS and OTT message delivery failures. \nValid value: SMS\n"
      verify_number:
        type: boolean
        description: |
          If this flag is set to 'true' then the recipient phone numbers will be checked to ensure they are valid mobile numbers,  virtual mobile numbers or virtual landline numbers.
      verify_sms:
        type: boolean
        description: |
          If this flag is set to 'true' then the message content  and the sender of the message will be verified via the  Google messages application. If the verification is  successful, the end-user will be shown a transcript  stating that the message was verified along with  the customer's logo in the Google messages application.
      options:
        type: string
        description: |
          json options in use with push notifications
      sender_id_sort_criteria:
        type: string
        description: |
          Priority list of SenderId selection criteria (DELIVERY_ADDRESS, PRICE)
      from:
        type: string
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      pause_before_transmit:
        type: boolean
        description: |
          This is a flag that tells SCG to generate the messages but not to deliver them.
      pause_expiry_time:
        type: string
        description: |
          This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integer pause expiry time, the message request will fail
      price_threshold:
        type: integer
        description: |
          The price threshold for messages in a request
      to:
        type: string
        description: |
          Recipient address or contact id.
      src_language:
        type: string
        description: |
          This is the source language of a message. The defauly is English 'en'
      dst_language:
        type: string
        description: |
          Translate message to a specified language. If not set,  only messages to contacts with language preference will be translated.
      translate:
        type: boolean
        description: |
          When translate attribute is set to 'true' translation of message body is enabled.
      consent_requirement:
        type: string
        description: |
          This field indicates if the message delivery is dependent on the consent status for the message recipient. This field is specific to a Sender address (Shortcode) that is classified as 'User Managed' consent.  This is meant for Businesses who are responsible for managing consent but use the SCG contacts database to store the consent status for message recipients. Any contacts/destination MDNs for end-users that a message is sent to but does not have an opt-in status associated with the sender address will be blocked (message will be created but will be in 'failed' status and will not be sent to the recipient).  Supported values are:
          - OPT_IN (message will be sent only if user explicitly opted in)
          - OPT_OUT (message will be sent unless user explicitly opted out)
          - NONE (message will be sent irrespectively of optin status)
      channel_id:
        type: string
        description: |
          The channel id
      destination_country:
        type: string
        description: |
          destination country
      body_extensions:
        type: string
        description: |
          Extended body
      content_type:
        type: string
        description: |
          The content type of the message request body.
      sender_id_alias:
        type: string
        description: |
          alias of the sender
      protocol_error:
        type: string
        description: |
          The protocol level error that caused the message to fail
      fragment_count:
        type: integer
        description: |
          fragment count
      fragments_info:
        type: array
        items:
          type: string
      media_urls:
        type: array
        items:
          type: string
      mediaURL_attachIds:
        type: array
        items:
          type: string
      number_type:
        type: string
        description: |
          type of a number
      group_to:
        type: array
        items:
          type: string
      shortcode_address_type:
        type: string
        description: |
          shortcode address type (STANDARD, FTEU)
      standalone:
        type: boolean
        description: |
          standalone: true or false
      failover_reference:
        type: string
        description: |
          The failover info
      test_message_flag:
        type: boolean
        description: |
          This is a test mode flag for performing basic functional tests. If this flag is set to 'true' then this will be processed and Out bound messages will be created but the messages will not be delivered to a handset.
      recipient_verifiedSms_enabled:
        type: boolean
        description: |
          recipient verified sms enabled: true or false
  inline_response_200_1:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_1_list'
  inline_response_200_10_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique keyword id
      name:
        type: string
        description: |
          name of the keyword
      description:
        type: string
        description: |
          description of the keyword
      value:
        type: string
        description: |
          the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
      case:
        type: string
        description: |
          SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
      sender_id:
        type: string
        description: |
          The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
      valid_from:
        type: string
        description: |
          the date range for which the keyword is valid
      valid_to:
        type: string
        description: |
          the date range for which the keyword is valid
      associated_info:
        type: string
        description: |
          additional information, value is at customer discretion, this attribute is added to the keyword event whenever the keyword is detected
      campaign_id:
        type: string
        description: |
          The campaign id
      type:
        type: string
        description: |
          the type of the keyword:
          - RESERVED: those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them
          - COMPANY: company specific keywords
      actions:
        type: string
        description: |
          actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space:
          - OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)
          - OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)
          - STORE -> no action, just record in user profile
      reply_template:
        type: string
        description: |
          if specified then SCG will send a predefined message back to the user. This attribute will contain the name of the message template to be used in the automatic reply
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
      attachments:
        type: string
        description: |
          List of attachments to be sent as autoreplay
      search_words_count:
        type: integer
        description: |
          Server will search for pattern in first search_words  words of the message
  inline_response_200_2:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_2_list'
  inline_response_200_3:
    type: object
    properties:
      id:
        type: string
        description: The identifier for the newly created resource.
  inline_response_200_4:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_4_list'
  inline_response_200_11:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_11_list'
  inline_response_200_10:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_10_list'
  Connector:
    type: object
    properties:
      external_id:
        type: string
        description: |
          The id of the Connector at the customer system. Can be used by customer to update the Connectors
      type:
        type: string
        description: |
          The type of the customer (bot) side API this connector will use. Currently supported values:

            * AZURE_BOT_DIRECT_LINE - Microsoft Azure Bot Framework Direct Line API
      sender_id:
        type: string
        description: |2+

      credentials:
        type: string
        description: |2+

  inline_response_200_13:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_13_list'
  Keywords:
    type: object
    properties:
      name:
        type: string
        description: |
          name of the keyword
      description:
        type: string
        description: |
          description of the keyword
      value:
        type: string
        description: |
          the keyword. For example 'SPORTS'. The keyword can be expressed in form of a regular expression. POSIX Extended syntax is supported.
      case:
        type: string
        description: |
          SENSITIVE/INSENSITIVE specifies whether the keyword is case sensitive or not. default is not case sensitive.
      sender_id:
        type: string
        description: |
          The sender id on which the keyword is valid. When this is empty, any sender id associated with the given customer will be sensitive to this keyword
      valid_from:
        type: string
        description: |
          the date range for which the keyword is valid
      valid_to:
        type: string
        description: |
          the date range for which the keyword is valid
      associated_info:
        type: string
        description: |
          additional information, value is at customer discretion, this attribute is added to the keyword event whenever the keyword is detected
      campaign_id:
        type: string
        description: |
          The campaign id
      type:
        type: string
        description: |
          the type of the keyword:
          - RESERVED: those are the platform specific keywords that can not be used by customer in any campaign. Those keywords will always exist, the company will never need to add them
          - COMPANY: company specific keywords
      actions:
        type: string
        description: |
          actions to be applied when the keyword has been received. Multiple actions can be specified. The various actions should be separated by a coma or space:
          - OPTOUT -> mark the user as explicitly opted out (and forward message to Consent Manager)
          - OPTIN > mark the user as explicitly opted in (and forward message to Consent Manager)
          - STORE -> no action, just record in user profile
      reply_template:
        type: string
        description: |
          if specified then SCG will send a predefined message back to the user. This attribute will contain the name of the message template to be used in the automatic reply
      attachments:
        type: string
        description: |
          List of attachments to be sent as autoreplay
      search_words_count:
        type: integer
        description: |
          Server will search for pattern in first search_words  words of the message
  inline_response_200_12:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_12_list'
  Message:
    type: object
    properties:
      conversation_id:
        type: string
        description: |
          The identifier of the conversation for conversation threading.
      campaign_id:
        type: string
        description: |
          The campaign id: A unique identifier for a particular messaging campaign or program
      subject:
        type: string
        description: |
          Subject of the message.
      body:
        type: string
        description: |
          The message body as sent to the recipient.
      attachments:
        type: array
        description: |
          A list of attachment IDs which are associated with this message.
        items:
          type: string
      scheduled_delivery_time:
        type: string
        example: "1690419562110"
        description: |
          The date and time that this message should be delivered. This is the user specific time as calculated by the SCG based on the destination time zone and requested time zone calculation.
      scheduled_delivery_time_zone:
        type: string
        example: LOCAL
        description: |
          Determines what time zone to apply to the scheduled delivery time:
          - UTC  - If no timezone was supplied in the delivery time then UTC is used.
          - LOCAL -  means that the scheduled delivery time as supplied in the request is expressed in LOCAL recipient time. The time zone of the recipient is determined by SCG automatically based on the primary_address_zip value in the recipient contact record.  The UTC time of day of the supplied scheduled_delivery_time will be used to deliver to the recipient at the same time of day in the local timezone.  For example, if the supplied scheduled delivery time is May 24th at 11:00am UTC, then the message would be delivered to someone with a zipcode in the Pacific timezone at  May 24th at 11:00am PDT.
      options:
        $ref: '#/definitions/Message_Request_options'
      body_extensions:
        type: array
        description: "Extended body    \n"
        items:
          $ref: '#/definitions/Message_Request_body_extensions'
      expiry_time:
        type: string
        example: "2023-07-31T15:50:00 or 2023-07-31 or Mon, 07 Aug 2023 11:54:28 UTC or 1690793596000"
        description: |
          This is the timestamp after which the messages will no Integer be sent to the downstream system for delivery
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      contact_delivery_address_priority:
        type: string
        example: "WHATSAPP,MDN"
        description: |
          Priority list of contact delivery addresses (MDN, PUSH)
      failover:
        type: string
        description: |
          Controls fail over to SMS in case of MMS, RCS and OTT message delivery failures.
          Valid value: SMS
      verify_number:
        type: boolean
        description: |
          If this flag is set to 'true' then the recipient phone numbers will be checked to ensure they are valid mobile numbers,  virtual mobile numbers or virtual landline numbers.
      verify_sms:
        type: boolean
        description: |
          If this flag is set to 'true' then the message content  and the sender of the message will be verified via the  Google messages application. If the verification is  successful, the end-user will be shown a transcript  stating that the message was verified along with  the customer's logo in the Google messages application.
      sender_id_sort_criteria:
        type: string
        description: |
          Priority list of SenderId selection criteria (DELIVERY_ADDRESS, PRICE)
      from:
        type: string
        example: channel:1KJPMkuHQkair_o15etpmg
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      price_threshold:
        type: integer
        description: |
          The price threshold for messages in a request
      to:
        type: string
        example: "13467871829"
        description: |
          Recipient address or contact id.
      src_language:
        type: string
        description: |
          This is the source language of a message. The defauly is English 'en'
      dst_language:
        type: string
        description: |
          Translate message to a specified language. If not set,  only messages to contacts with language preference will be translated.
      translate:
        type: boolean
        description: |
          When translate attribute is set to 'true' translation of message body is enabled.
      consent_requirement:
        type: string
        description: |
          This field indicates if the message delivery is dependent on the consent status for the message recipient. This field is specific to a Sender address (Shortcode) that is classified as 'User Managed' consent.  This is meant for Businesses who are responsible for managing consent but use the SCG contacts database to store the consent status for message recipients. Any contacts/destination MDNs for end-users that a message is sent to but does not have an opt-in status associated with the sender address will be blocked (message will be created but will be in 'failed' status and will not be sent to the recipient).  Supported values are:
          - OPT_IN (message will be sent only if user explicitly opted in)
          - OPT_OUT (message will be sent unless user explicitly opted out)
          - NONE (message will be sent irrespectively of optin status)
  Fast_Access_1:
    type: object
    properties:
      target_attribute:
        type: string
        description: |
          The name in the contact resource this mapping applies to: fast_access_1 .. fast_access_20.
      target_attribute_name:
        type: string
        description: |
          The friendly name of the fast access attribute. The corresponding attribute will appear under the fast_access sb-object of the contact object. The name must be used for all contact updates. It can be used with filters like fast_access.<name>
          If not provided, the corresponding attribute will appear in the contact and filter criteria as is.
      value_derivation_script:
        type: string
        description: |
          The rule - JSON Path expression _ on how to compute the value of the target attribute from the contact.
          If not provided the corresponding attribute will be editable in the contact.
      user_data:
        type: string
        description: |
          Data that the user can associate with an attribute, in case they want to do client side mapping instead of using target_attribute_name to do server side mapping of the attributes.
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  ConferenceMember:
    type: object
    required:
    - call_id
    properties:
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      call_id:
        type: string
        description: |
          The id for the Call resource that is associated with this member.
      hold:
        type: boolean
        description: |
          If true, all member can't hear or speak in the conference
      mute:
        type: boolean
        description: |
          If 'true', all member can't speak in the conference
  Access_Token:
    type: object
    properties:
      expiry_time:
        type: string
        description: |
          The UTC timestamp after which the token is no Integer valid.
  inline_response_200_19:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_19_list'
  inline_response_200_18:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_18_list'
  inline_response_200_27_list:
    type: object
    properties:
      id:
        type: string
        description: |
          id of the resource
      alias:
        type: string
        description: |
          alias of the sender
      sender_id:
        type: string
        description: |
          sender_id that was assigned to that alias
      sender_id_address:
        type: string
        description: |
          address of the sender_id
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
  inline_response_200_15:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_15_list'
  inline_response_200_14:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_14_list'
  inline_response_200_17:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique id of the token
      expiry_time:
        type: string
        description: |
          The UTC timestamp after which the token is no Integer valid.
  inline_response_200_16:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_16_list'
  Contact_Group:
    type: object
    properties:
      external_id:
        type: string
        description: |
          Customer supplied id of the contact group
      name:
        type: string
        description: |
          A name for the group
      description:
        type: string
        description: |
          Group description
      criteria:
        type: string
        description: |
          Filter definition for creation of the group. Users can use either criteria or members <FORMAT TBD -  figure our the syntax>
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Sender_ID_Message_Template:
    type: object
    properties:
      designation:
        type: string
        description: |
          The template is used either for VALIDATOR or as an actual TEMPLATE.
          VALIDATOR type templates will be associated with a sender id and any message that is submitted to a sender ID that has some VALIDATOR templates associated with it will be checked against the template.
          TEMPLATE type templates are used to send messages. in such case the message request body will indicate with template to apply and the message processing will use the template body and apply conversion of applicable keywords to create the actual message body.
          NOTE: validator type templates can not be modified by the customer where the message template is associated with a shared sender id
      name:
        type: string
        description: |
          The name of the template.
      pattern:
        type: string
        description: |
          template pattern can be used to enforce compliancy of the message body with the submitted program brief. The template pattern allows also to use the templates to form the message body by using the template pattern and replacing the keywords in the pattern with the values of submitted keywords in the message send from the sender id
  inline_response_200:
    type: object
    properties:
      list:
        type: array
        items:
          $ref: '#/definitions/inline_response_200_list'
  inline_response_200_20_list:
    type: object
    properties:
      id:
        type: string
        description: |
          Unique identifier of the contact group
      external_id:
        type: string
        description: |
          Customer supplied id of the contact group
      name:
        type: string
        description: |
          A name for the group
      description:
        type: string
        description: |
          Group description
      type:
        type: string
        description: "The group type: \n- DYNAMIC: meaning the list of members associated with the group is calculated dynamically whenever the group is referenced by applying the CRITERIA to the customer contact list\n- STATIC: meaning the list of members is determined at the time of contact group creation and hence static. Customers will be also able to add or remove contacts from a STATIC group by accessing the contacts list associated with the group\n"
      criteria:
        type: string
        description: |
          Filter definition for creation of the group. Users can use either criteria or members <FORMAT TBD -  figure our the syntax>
      state:
        type: string
        description: |
          Processing
          Ready
      member_count:
        type: number
        description: |
          Count of members in the group.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
  Fast_Access:
    type: object
    properties:
      target_attribute:
        type: string
        description: |
          The name in the contact resource this mapping applies to: fast_access_1 .. fast_access_20.
      target_attribute_name:
        type: string
        description: |
          The friendly name of the fast access attribute. The corresponding attribute will appear under the fast_access sb-object of the contact object. The name must be used for all contact updates. It can be used with filters like fast_access.<name>
          If not provided, the corresponding attribute will appear in the contact and filter criteria as is.
      value_derivation_script:
        type: string
        description: |
          The rule - JSON Path expression _ on how to compute the value of the target attribute from the contact.
          If not provided the corresponding attribute will be editable in the contact.
      user_data:
        type: string
        description: |
          Data that the user can associate with an attribute, in case they want to do client side mapping instead of using target_attribute_name to do server side mapping of the attributes.
  Contact_Address_Status:
    type: object
    properties:
      address_type:
        type: string
        description: |
          The address type MDN (for phone numbers), EMAIL, SOCIAL, PUSH (...)
  Contact_Address_Status_Optout:
    type: object
    properties:
      sender_id:
        type: string
        description: |
          The sender_id that is to be used with this instance.
      addresses:
        type: array
        description: |
          List of addresses to be optout
        items:
          type: string
      consent_status:
        type: string
        description: "The optout type:\n    - WEB       \n    - IVR      \n    - APP     \n    - EMAIL\n    - POS\n    - SMS\n    - SINGLE\n    - MIGRATION\n"
  inline_response_200_14_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique identifier for this resource.
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      call_id:
        type: string
        description: |
          The id for the Call resource that is associated with this member.
      hold:
        type: boolean
        description: |
          If true, all member can't hear or speak in the conference
      mute:
        type: boolean
        description: |
          If 'true', all member can't speak in the conference
      conference_id:
        type: string
        description: |
          Id of the conference this resource is associated to.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The creation date of the object.
      last_updated_date:
        type: string
        description: |
          The last modification date of the object.
      version_number:
        type: integer
        description: |
          An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking.
  Application_Instance:
    type: object
    properties:
      script_id:
        type: string
        description: |
          The is of the script to be used for this instance.
      sender_id:
        type: string
        description: |
          The sender_id that is to be used with this instance.
      state:
        type: string
        description: |
          The state of the instance. This can be:
          - ENABLED
          - DISABLED
      allow_incoming_call:
        type: string
        description: |
          This is used to enable handling of incoming calls by the application instance.
  inline_response_200_5_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique identifier for the message request
      from:
        type: string
        description: "The from attribute is the channel Id or Sender Id over/from which the message is to be sent.\n-To send from a sender ID, the ID should be prefixed with 'sender_id:'.   \n-To send from a channel the ID should be prefixed with 'channel:'.\n"
      to:
        type: array
        items:
          type: string
      consent_requirement:
        type: string
        description: |
          This field indicates if the message delivery is dependent on the consent status for the message recipient. This field is specific to a Sender address (Shortcode) that is classified as 'User Managed' consent.  This is meant for Businesses who are responsible for managing consent but use the SCG contacts database to store the consent status for message recipients. Any contacts/destination MDNs for end-users that a message is sent to but does not have an opt-in status associated with the sender address will be blocked (message will be created but will be in 'failed' status and will not be sent to the recipient).  Supported values are:
          - OPT_IN (message will be sent only if user explicitly opted in)
          - OPT_OUT (message will be sent unless user explicitly opted out)
          - NONE (message will be sent irrespectively of optin status)
      conversation_id:
        type: string
        description: |
          The identifier of the conversation for conversation threading.
      campaign_id:
        type: string
        description: |
          The campaign id: A unique identifier for a particular messaging campaign or program
      channel_id:
        type: string
        description: |
          The channel id
      recipient_count:
        type: integer
        description: count of recipients
      media_requested_count:
        type: integer
        description: count of requested media
      click_thru_count:
        type: integer
        description: count of thru clicks
      body:
        type: string
        description: |
          This is the body of the message as supplied by the customer's application.  It can reference a message template and supply the variables assignments for use with a template or contain the actual message body
      body_extensions:
        type: string
        description: |
          Extended body
      message_type:
        type: string
        description: "Type of message: \n - SMS\n - MMS\n - PSH\n - VOICE\n - FACEBOOK\n - WECHAT\n - WHATSAPP\n - RCS\n - EMAIL\n - VIBER\n"
      response_description:
        type: string
        description: |
          Response info
      attachments:
        type: array
        items:
          type: string
      media_urls:
        type: array
        items:
          type: string
      mediaURL_attachIds:
        type: array
        items:
          type: string
      group_mms:
        type: boolean
        description: |
          Group mms: true or false
      subject:
        type: string
        description: |
          The subject - a short summary of the message's purpose.
      application_id:
        type: string
        description: |
          ID of the application that has created the message request
      external_id:
        type: string
        description: |
          Application provided unique tracking ID for the message.   Can be used as an alternative key in query methods.
      state:
        type: string
        description: |
          The status of the message request:
          - SUBMITTED
          - ACCEPTED
          - REJECTED
          - PREPARING (while in the preparing state, the recipient cont may increase with time i.e. SCG will keep track of the preparing step to allow polling on the resource to have user see progress)
          - TRANSMITTING (while in the transmission state, the sent count will be updates as the messages are being sent)
          - COMPLETED
          - PAUSED (SCG will go into this state after preparing if pause flag is set)
          - CANCELED  (cancel can be requested at any time)
          NOTE: to resume paused messages, the status should be updated by customer from PAUSED to TRANSMITTING
      verify_sms:
        type: boolean
        description: |
          If this flag is set to 'true' then the message content  and the sender of the message will be verified via the  Google messages application. If the verification is  successful, the end-user will be shown a transcript  stating that the message was verified along with  the customer's logo in the Google messages application.
      sent_count:
        type: integer
        description: |
          The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      delivered_count:
        type: integer
        description: |
          The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      read_count:
        type: integer
        description: |
          The number of messages sent for which some form of delivery receipt confirmation has been received. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      converted_count:
        type: integer
        description: |
          The number of messages where conversion has been confirmed. This will apply for messages with URL where the application requested a link track. The number of messages successfully sent via API to the underlying channel. The counts are increased continuously as additional messages satisfy criteria.
      canceled_count:
        type: integer
        description: |
          The number of messages that have been created but not sent because the message request was canceled
      failed_count:
        type: integer
        description: |
          The number of messages that have expired or have failed delivery
      scheduled_delivery_time:
        type: string
        description: |
          The date and time that this message should be delivered.  The following formats are supported:
          - Unix Epoch time in milliseconds (e.g. 1527966000000)
          - yyyy-MM-dd'T'HH:mm:ss (e.g. 2018-05-24T18:50:00) Note: Defaults to UTC.
          - yyyy-MM-dd'T'HH:mm:ssZ (e.g. 2018-05-24T18:50:00Z)
          - yyyy-MM-dd'T'HH:mm:ss.SSSZ (e.g. 2018-05-24T18:50:00Z)
          - EEE, dd MMM yyyy HH:mm:ss zzz (e.g. Thursday, 24 May 2018 19:20:00 PST)
          - yyyy-MM-dd (e.g. 2018-05-24). Will be scheduled for 12am UTC on the date specified.
      scheduled_delivery_time_zone:
        type: string
        description: |
          Determines what time zone to apply to the scheduled delivery time:
          - UTC  - If no timezone was supplied in the delivery time then UTC is used.
          - LOCAL -  means that the scheduled delivery time as supplied in the request is expressed in LOCAL recipient time. The time zone of the recipient is determined by SCG automatically based on the primary_address_zip value in the recipient contact record.  The UTC time of day of the supplied scheduled_delivery_time will be used to deliver to the recipient at the same time of day in the local timezone.  For example, if the supplied scheduled delivery time is May 24th at 11:00am UTC, then the message would be delivered to someone with a zipcode in the Pacific timezone at  May 24th at 11:00am PDT.
      expiry_time:
        type: string
        description: |
          This is the timestamp after which the messages resulting from the message request should no Integer be sent.
      test_message_flag:
        type: boolean
        description: |
          This is a test mode flag for performing basic functional tests. If this flag is set to 'true' then this will be processed and Out bound messages will be created but the messages will not be delivered to a handset.
      pause_before_transmit:
        type: boolean
        description: |
          This is a flag that tells SCG to generate the messages but not to deliver them.
      pause_expiry_time:
        type: string
        description: |
          This is the timestamp after which all paused messages will expire and will be removed from the outbound queue. The maximum expiry time is 24h. If application creates a message request with Integer pause expiry time, the message request will fail
      price_threshold:
        type: integer
        description: |
          The price threshold for messages in a request
      contact_delivery_address_priority:
        type: array
        items:
          type: string
      scheduled:
        type: boolean
        description: |
          The message is scheduled: true or false
      failover:
        type: string
        description: "Controls fail over to SMS in case of MMS, RCS and OTT message delivery failures. \nValid value: SMS\n"
      failure_code:
        type: string
        description: |
          The failure code associated with this call if applicable.
            failure_details:
      failure_details:
        type: string
        description: |
          The failure message associated with this call if applicable.
      failover_reference:
        type: string
        description: |
          The failover info
      src_language:
        type: string
        description: |
          This is the source language of a message. The defauly is English 'en'
      dst_language:
        type: string
        description: |
          Translate message to a specified language. If not set,  only messages to contacts with language preference will be translated.
      translate:
        type: boolean
        description: |
          When translate attribute is set to 'true' translation of message body is enabled.
      translations_count:
        type: integer
        description: |
          Number of messages being successfully translated
      translations_failed_count:
        type: integer
        description: |
          Number of messages where translations was attempted but failed.
      translations_performed_count:
        type: integer
        description: |
          Number of actual translate requests sent to the translation engine. This is the billable number of translations.
      content_type:
        type: string
        description: |
          The content type of the message request body.
      options:
        type: string
        description: |
          json options in use with push notifications
      created_date:
        type: string
        description: |
          For a MT sent via this API, this indicates the time when the API was called to request message delivery.  For a MO message, this is the point in time when the SCG was notified of the inbound message from the operator network/mediate channel.
      last_updated_date:
        type: string
        description: |
          Timestamp of the last event associated with the message
      version_number:
        type: integer
        description: "An ascending version number of the object.  1 upon creation, incremented by one for each modification done.  \nNOTE: unlike other resources in the messaging gateway, messages are not updated directly. Events happening to a message (sending, delivery receipts, replies, conversions ...) indirectly update the status and hence version number of the message.\n"
  inline_response_200_11_list:
    type: object
    properties:
      id:
        type: string
        description: |
          The unique identifier for this resource.
      external_id:
        type: string
        description: |
          The unique Id assigned by the application.
      from:
        type: string
        description: |
          The Sender ID associated with this call.
      from_address:
        type: string
        description: |
          The address associated with the Sender Id.
      to:
        type: string
        description: |
          The called party's address.
      to_address:
        type: string
        description: |
          The address that was used by the system for the called party.  When the 'to' field specifies something other than the address (e.g. contact ID) then this field will contain the actual address that was used.
      answer_timeout:
        type: integer
        description: |
          The number of miliseconds that the service will wait for an answer.
      state:
        type: string
        description: |
          The call's state:
          - STARTED - The call is being setup.
          - ACTIVE - The call is in progress.
          - REJECTED - The called party did not answer.
          - COMPLETED - The call is complete.
      direction:
        type: string
        description: |
          The direction of the call:
          - IN - This was an incoming call.
          - OUT - This was an outgoing call.
      start_time:
        type: string
        description: |
          The time the call was started.
      answer_time:
        type: string
        description: |
          The time the call was answered.
      end_time:
        type: array
        items:
          type: string
      chargeable_duration:
        type: integer
        description: |
          The call duration in seconds.
      bridge_id:
        type: string
        description: |
          The id of the bridge that is associated with this call.
      failure_code:
        type: string
        description: |
          The failure code associated with this call if applicable.
      failure_details:
        type: integer
        description: |
          The failure message associated with this call if applicable.
      destination_country:
        type: string
        description: |
          destination country
      recording_enabled:
        type: boolean
        description: |
          enable recording: true or false
      recordings:
        type: array
        items:
          type: string
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Contact:
    type: object
    properties:
      external_id:
        type: string
        description: |
          the id of the contact at the customer system. Can be used by customer to update the contacts
      first_name:
        type: string
        description: |
          First name of customer
      last_name:
        type: string
        description: |
          Last name of customer
      birth_date:
        type: string
        description: |
          Customer birth date. YYYY-MM-DD
      first_acquisition_date:
        type: string
        description: |
          The timestamp of the first customer acquisition - i.e. the date when the customer has been for the first time opted in to any program
      last_acquisition_date:
        type: string
        description: |
          The timestamp of the last customer acquisition i.e. the date when the customer has for the last time sent an optin keyword or performed a doubleoptin
      primary_mdn:
        type: string
        description: |
          The primary phone number of the customer. This is the number used to track the double optin for the customer
      primary_addr_line1:
        type: string
        description: |
          Details of customers primary address
      primary_addr_line2:
        type: string
        description: |
          Details of customers primary address
      primary_addr_city:
        type: string
        description: |
          Details of customers primary address
      primary_addr_zip:
        type: string
        description: |
          ZIP code of the customer primary address
      primary_addr_state:
        type: string
        description: |
          Details of customers primary address
      primary_email_addr:
        type: string
        description: |
          Customers primary email address
      primary_addr_country:
        type: string
        description: |
          Customer primary address country
      primary_social_handle:
        type: string
        description: |
          Customers primary social media ID
      address_list:
        type: string
        description: |
          Stores all known addresses of the customer in a form of a JSON array. Each address in the array can have the following attributes:
          - priority: priority of the address, 1 highest
          - designation: specifies type of the address: home, work
          - use: billing, shipping
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - line1: first address line
          - line2: second address line
          - city
          - state
          - province
          - zip
          - country
      account_list:
        type: string
        description: |
          Stores all known accounts of the customer in a form of a JSON array. Each account in the array can have the following attributes:
          - priority: user defined account priority
          - designation:  primary designation of the account: work, private ...
          - source: specifies where the address comes from, company specific
          - status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED
          - type: email, social, web, loyalty
          - username: the username in the account. This will be the membership id in loyalty programs or the email address for an email account
          - domain: account domain. For example starwood.com
          - access_token: the access token to the account where the account requires some oauth type authorization
          NOTE: other attributes may be required/provided, based on the account type and domain.
      device_list:
        type: string
        description: "Stores all known customer devices in a form of a JSON array. Each account in the device can have the following attributes:\n- priority: user defined account priority\n- designation:  primary designation of the account: work, private ...\n- source: specifies where the address comes from, company specific\n- status: status of the address: VALID_NEW, VALID_CONF, INVALID, EXPIRED\n- msisdn\n- carrier\n- mac_address, \n- uuid\n- imei \n- manufacturer: device manufacturer, for example Apple\n- model: model of the device, for example iPhone 5s\n- os: operating system of the device, for example iOS 8.3\nNOTE: other attributes may be required/provided, based on the device type.\n"
      interest_list:
        type: string
        description: "Stores all known customer preferences in a form of a JSON array. Each preference can have the following attributes:\n- code: interest code \n- name: interest name\n- source: where the information was obtained\n- score: how likely the information is, floating point value 0...1\n"
      demographic_list:
        type: string
        description: |
          Stores all known customer demographic in a form of a JSON array. Each demographic can have the following attributes:
          - demographic name
          - source: where the information was obtained
          - score: how likely the information is, floating point value 0...1
      extended_attributes:
        type: string
        description: |
          JSON string of all extended attributes of the customer. Any list of key:value pairs is supported. Also composite attributes can be stored.
      preferred_language:
        type: string
        description: |
          When translation is enabled, the message to this contact will be translated
      voice_preference:
        type: boolean
        description: "This contacts preference setting for voice message delivery: \n- NONE : no preference\n- PREFER_VOICE : contact prefers voice if possible (voice capable sender ID available as message originator and is not rejected due to price or other policy)\n- REQUIRE_VOICE : contact requires voice - selecting voice capable sender ID overrides price and other policies; message fails if voice sender ID is not available\n"
      social_handles:
        type: string
        description: |
          list of social handles
      social_profile_lookup_prefix:
        type: string
        description: |
          which social id to use to update contact info
      social_profile_lookup_override:
        type: boolean
        description: |
          If set to true will overwrite existing contact attributes that are collected from social id
  AudioFile:
    type: object
    required:
    - text
    properties:
      text:
        type: string
        description: |
          The text to be spoken.
      language:
        type: string
        description: |
          The language of the text.
      gender:
        type: string
        description: "The gender of the speaker. \nSupported values are:\n- female\n- male\n"
      voice:
        type: string
        description: |
          One of the supported voices.  Voice implies gender and language.
          Supported values are referenced in this page:
          https://sdcsupport.syniverse.com/hc/en-us/articles/360042993153-Customizing-Spoken-Text-on-SCG-Voice-API-with-SSML-tags
      loopEnabled:
        type: boolean
        description: |
          If set to ture, tts voice will be looping.
      loopCount:
        type: integer
        description: "number of loop to play the tts voice  \n"
  inline_response_200_2_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique id of the sender address
      parent_id:
        type: string
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was used to create customer version of the sender id
      name:
        type: string
        description: |
          name of the sender address
      ownership:
        type: string
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
      class_id:
        type: string
        description: |
          reference to the sender address class that determines the priority and throughput of the configured sender id
      type_id:
        type: string
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
      state:
        type: string
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
      address:
        type: string
        description: |
          The sender address. The address must correspond to the sender address type. For a2p sms this will be the shortcode or Integercode, for emails this will be the email address etc... For push this is a unique application name.  This name will be used in contacts to identify the application specific push registration ids for a particular user.
      content_type:
        type: string
        description: |
          the content of this field is specific the sender type / gateway associated with this sender
      message_templates:
        type: array
        items:
          type: string
      country:
        type: string
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
      credentials:
        type: string
        description: |
          An array of  inline JSON objects with a list of name, value pairs that contain the credential and configuration values need to use this sender ID.  There is one object in the array per message delivery provider that will be used for delivery messages with this sender ID.  For example, the array may contain one entry for APN and one entry for GCN.
      consent_managed_by:
        type: string
        description: |
          Possible values: USER, SCG or SCG_UNSOLICITED_OPT_OUT. Default is USER
      capabilities:
        type: array
        items:
          type: string
      check_white_list:
        type: boolean
        description: |
          If set, sending via this sender ID is limited to recipients present in the customer's white list.
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      company_id:
        type: integer
        description: |
          ID of the company that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          for shared short codes, this is a reference to the system  sender id that is associated with this preprovisioned address.  Whenever a customer wants to use a preprovisioned, shared code, the parent sender address id will indicate the sender id that was us
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      billing:
        type: string
        description: |
          billing info
      default_greating:
        type: string
        description: |
          default greating info
      google_project_id:
        type: string
        description: |
          google project id
      syniverse_chatbot_id:
        type: string
        description: |
          syniverse chatbot id
      applied_charges:
        type: array
        items:
          type: string
      alias:
        type: string
        description: |
          alias of the sender
      start_date:
        type: string
        description: |
          start date
      end_date:
        type: string
        description: |
          end date
      suspend_reason:
        type: string
        description: |
          suspend reason info: MANUAL, INSUFFICIENT_FUNDS, PORTED_OUT
      register_provider:
        type: string
        description: |
          register provider (NETNUMBERS, NONE, ZIPWHIP)
      shortcode_address_type:
        type: string
        description: |
          shortcode address type (STANDARD, FTEU)
      foreign_id:
        type: string
        description: |
          foreign id
      restriction_id:
        type: string
        description: |
          restriction id
      verify_sms_agent_id:
        type: string
        description: |
          verify sms agent id
  inline_response_200_2_list_limited:
    type: object
    properties:
      id:
        type: string
        description: |
          unique id of the sender address
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
      name:
        type: string
        description: |
          name of the sender address
      address:
        type: string
        description: |
          The sender address. The address must correspond to the sender address type. For a2p sms this will be the shortcode or Integercode, for emails this will be the email address etc... For push this is a unique application name.  This name will be used in contacts to identify the application specific push registration ids for a particular user.
      country:
        type: string
        description: |
          The country that the sender address can be used to send messages to. This field will contain ISO country code. The value is managed by Syniverse and not editable by the customer.
      countries:
        type: array
        items:
          type: string  
          description: |
            The countries that the sender address can be used to send messages to. This field will contain the list of ISO country codes. The value is managed by Syniverse and not editable by the customer.
      capabilities:
        type: array
        items:
          type: string
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      company_id:
        type: integer
        description: |
          ID of the company that has created the resource
      type_id:
        type: string
        description: |
          reference the sender address type that determines the data types allowed on the sender id and identifies the gateway used to deliver the messages
      state:
        type: string
        description: |
          represents the sender address status. Following values are allowed:
          - PENDING_IMPLEMENTATION
          - IMPLEMENTED
          - ACTIVE
          - INACTIVE
          - BROKEN
          - PENDING_DELETE
          - PENDING_CONFIRMATION

          For each sender address that require provisioning, when a sender address is requested, the initial status will be 'pending implementation'
  inline_response_200_30_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique job id
      instance_id:
        type: string
        description: |
          The id of instance
      call_id:
        type: string
        description: |
          The id of call
      to_address:
        type: string
        description: |
          The address to which the session should be established.
      state:
        type: string
        description: |
          The state of the session This can be:
          - NOTSTARTED
          - ACTIVE
          - PAUSED
          - COMPLETED
      createTime:
        type: string
        description: |
          The session created time
      start_time:
        type: string
        description: |
          The session started time
      complete_time:
        type: string
        description: |
          The session completed time
      type:
        type: string
        description: |
          The session type: SMS/FB/VOICE
      direction:
        type: string
        description: |
          The session direction: IN/OUT
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  Sender_ID_Purchase:
    type: object
    properties:
      parent_id:
        type: string
        description: |
          This is the Sender ID of the Preprovisioned Sender ID that is being purchased.
  Contact_Address_Status_1:
    type: object
    properties:
      consent_status:
        type: string
        description: |
          this is the current optin status for the specific address / sender id. The possible values are:
          - NONE (no optin or optout message received from the address on the specific sender id)
          - OPTIN (user has explicitly opted in to the sender id)
          - OPTOUT (user has explicitly opted out of the sender id)
          - BLACKLIST (blacklisted address - will be treated as explicit OPTOUT)
          - WHITELIST (whitelisted address - will be treated as explicit OPTIN)
          NOTE: Whitelisted or blacklisted status can not be overwritten by the end-user by sending messages to the sender id. Such users can be only un-listed by changing the optin-status explicitly put POST to address status ID
      version_number:
        type: integer
        description: |
          An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking
  inline_response_200_36_list:
    type: object
    properties:
      id:
        type: string
        description: |
          unique job id
      import_attachment_id:
        type: string
        description: |
          attachment with csv data
      receipts_attachment_id:
        type: string
        description: |
          attachment with additional info
      address_type:
        type: string
        description: |
          Default Address type
      capabilities:
        type: string
        description: |
          default capabilities
      country:
        type: string
        description: |
          default country
      tollfree_billing:
        type: string
        description: |
          tollfree billing info
            state:
      state:
        type: string
        description: |
          The job state: CREATED, RUNNING, COMPLETED, FAILED, RESUMED, WAIT;
      started_date:
        type: string
        description: |
          The job started date
      last_started_date:
        type: string
        description: |
          The job last started date
      completed_date:
        type: string
        description: |
          The job completed date
      resumed_count:
        type: integer
        description: |
          The job resumed count
      failure_details:
        type: string
        description: |
          text description that gives more detail on failed messages
      failures_attachment_id:
        type: string
        description: |
          failures attachment id
      register_failures_attachment_id:
        type: string
        description: |
          register failures attachment id
      imported_count:
        type: integer
        description: |
          imported sender ids count
      registered_count:
        type: integer
        description: |
          registered sender ids count
      failed_registered_count:
        type: integer
        description: |
          failed to registed sender ids count
      approval_state:
        type: string
        description: |
          sender ids import approval state (WAITING, APPROVED, REJECTED, AUTO)
      bulk_permission:
        type: string
        description: |
          bulk permission
      batch_size_limit:
        type: integer
        description: |
          batch size limit
      ownership:
        type: string
        description: |
          this field determines the ownership category of a shortcode. Applies only for SMS type of sender id's. Following values are allowed:
          - PRIVATE -> represents a short code that is private for use by one company only
          - SHARED -> represents a short code that is owned by Syniverse and where multiple customers can use it. When a customer wants to use a SHARED sender id, a new PRIVATE sender address will be created with parent sender id set to the SHARED sender id
          - PREPROVISIONED -> represents an address that is owned by Syniverse and can be selected by a customer. Upon a customer selecting a preprovisioned sender address, new sender id document as a copy of the PREPROVISIONED document is created, with state PRIVATE and parent_id pointing the original PREPROVISIONED sender address. The PREPROVISIONED sender address changes ownership to PURCHASED. Once the PRIVATE sender address, pointing to the PURCHASED is deleted, the PURCHASED sender changes its ownership back to PREPROVISIONED.
          - PURCHASED -> PREPROVISIONED sender address, currently occupied by a customer.
      register_state:
        type: string
        description: |
          The job state (CREATED, RUNNING, COMPLETED, FAILED, RESUMED, WAIT;)
      register_provider:
        type: string
        description: |
          register provider (NETNUMBERS, NONE, ZIPWHIP)
      charges:
        type: string
        description: |
          sender id fee type (PROCESSING, SETUP, INITIAL, RECURRING, CONSENT_INITIAL, CONSENT_RECURRING, IMPLEMENTATION)
      application_id:
        type: integer
        description: |
          ID of the application that has created the resource
      created_date:
        type: string
        description: |
          The date the resource was created
      last_updated_date:
        type: string
        description: |
          The data the resource was last changed
      version_number:
        type: integer
        description: "An ascending version number of the resource.  1 upon creation, incremented by one for each modification done.  Used to implement optimistic locking"
  Message_Request_options:
    type: object
    properties:
      push:badge:
        type: string
        example: auto
      push:notify_type:
        type: string
        example: silent
      push:sound:
        type: string
        example: default
    description: |
      json options in use with push notifications.
  Message_Request_body_extensions:
    type: object
    properties:
      type:
        example: DEEP_LINK
      content:
        example: https://www.syniverse.com/