openapi: 3.1.0
info:
  title: CPaaS API
  version: 3.5.1
  description: 'Manage CPaaS SMS numbers and channels. Use this API to retrieve dedicated

    SMS phone numbers, shortcodes, and keywords associated with your account,

    and to generate Facebook Messenger metadata for attaching messenger IDs to

    CPaaS profiles.'
servers:
- url: https://{region}-api.dotdigital.com
  variables:
    region:
      default: r1
      enum:
      - r1
      - r2
      - r3
      description: The Dotdigital region id your account belongs to
components:
  securitySchemes:
    sec0:
      type: http
      scheme: basic
security:
- sec0: []
paths:
  /sms/dedicatedNumbers:
    get:
      summary: Get SMS phone numbers
      description: ''
      operationId: get-sms-phone-number
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '[

                    {

                    "number": "447123123123",

                    "countryIsoCode": "GBR"

                    }

                    ]'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    number:
                      type: string
                      examples:
                      - '447123123123'
                    countryIsoCode:
                      type: string
                      examples:
                      - GBR
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
  /sms/shortcodes:
    get:
      summary: Get SMS shortcodes
      description: ''
      operationId: get-sms-shortcodes
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '[

                    {

                    "number": "123123",

                    "keyword": "",

                    "countryIsoCode": "GBR"

                    }

                    ]'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    number:
                      type: string
                      examples:
                      - '123123'
                    keyword:
                      type: string
                      examples:
                      - ''
                    countryIsoCode:
                      type: string
                      examples:
                      - GBR
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
  /sms/keywords:
    get:
      summary: Get SMS keywords
      description: ''
      operationId: get-sms-keywords
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '[

                    {

                    "number": "123123",

                    "keyword": "TEST",

                    "countryIsoCode": "GBR"

                    }

                    ]'
              schema:
                type: array
                items:
                  type: object
                  properties:
                    number:
                      type: string
                      examples:
                      - '123123'
                    keyword:
                      type: string
                      examples:
                      - TEST
                    countryIsoCode:
                      type: string
                      examples:
                      - GBR
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
  /channels/facebook/state:
    post:
      summary: Facebook Meta Data Service
      description: Used to generate meta data to help attach Facebook messenger Ids to CPaaS profiles
      operationId: facebook-meta-data-service
      parameters:
      - name: apiSpaceId
        in: query
        description: The API space associated with the Facebook channel
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - profileId
              properties:
                profileId:
                  type: string
                  description: The profile id of the user you want the Facebook Messenger Id associated with
                data:
                  type: string
                  description: Optional additional data that can be added to the CPaaS profile
            examples:
              Typical usage:
                value:
                  profileId: dave@acme.com
      responses:
        '200':
          description: '200'
          content:
            text/plain:
              examples:
                Result:
                  value: '"ae1d3451d3bb705f1c9798cb566d99763165b26c370cea06864ac90cd91c25e21c1592a6e965f612ed578f449eb4c3YKQK9LktXekKjmkSbBiwtewd1vfZylgwlBtgNmYl/7KBlUugqZznzP9buXl0b/Ywowv0M6HohG+Ii34ifAhLnRHcg6EPRpoPMnbHP7ca/IK7bQfFc0Ct+KXA1mDV1SHVk"'
              schema:
                type: string
                examples:
                - ae1d3451d3bb705f1c9798cb566d99763165b26c370cea06864ac90cd91c25e21c1592a6e965f612ed578f449eb4c3YKQK9LktXekKjmkSbBiwtewd1vfZylgwlBtgNmYl/7KBlUugqZznzP9buXl0b/Ywowv0M6HohG+Ii34ifAhLnRHcg6EPRpoPMnbHP7ca/IK7bQfFc0Ct+KXA1mDV1SHVk
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
x-readme:
  samples-languages:
  - curl
  - csharp
  - java
  - node
  - php
  - python
  - ruby
  explorer-enabled: true
  proxy-enabled: true
  samples-enabled: true