SignalWire Applications API

openapi: 3.2.0
info:
  title: Compatibility Applications API
  version: 1.0.0
  description: Manage cXML applications for handling voice and messaging.
servers:
- url: https://{space_name}.signalwire.com/api/laml/2010-04-01
  description: SignalWire Compatibility API
  variables:
    space_name:
      default: YOUR_SPACE
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: Applications
  description: Manage cXML applications for handling voice and messaging.
  externalDocs:
    url: https://signalwire.com/docs/compatibility-api/rest
    description: Developer documentation on the Compatibility REST API
paths:
  /Accounts/{AccountSid}/Applications:
    get:
      operationId: list_applications
      summary: List Applications
      description: 'The ability to read all of the applications that are associated with your Account. This will be returned as a list of applications.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/AccountSidPath'
      - name: FriendlyName
        in: query
        required: false
        description: Filter by a named unique identifier for the resource.
        schema:
          type: string
        explode: false
      - name: Page
        in: query
        required: false
        description: The page number to retrieve. Page numbers are zero-indexed, so the first page is 0.
        schema:
          type: integer
          format: int32
          minimum: 0
          default: 0
        explode: false
      - name: PageSize
        in: query
        required: false
        description: The number of results to return per page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          format: int32
          minimum: 1
          maximum: 1000
          default: 50
        explode: false
      - name: PageToken
        in: query
        required: false
        description: A token used to retrieve a specific page of results.
        schema:
          type: string
        explode: false
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationListResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Applications
    post:
      operationId: create_application
      summary: Create an Application
      description: 'Create an Application.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/AccountSidPath'
      responses:
        '201':
          description: Response containing a newly created application.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Application'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Applications
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreateApplicationRequest'
  /Accounts/{AccountSid}/Applications/{Sid}:
    get:
      operationId: get_application
      summary: Find an Application by ID
      description: 'Find an Application by ID.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/AccountSidPath'
      - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Applications
    post:
      operationId: update_application
      summary: Update an Application
      description: 'Update an Application.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/AccountSidPath'
      - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationResponse'
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '422':
          description: The request could not be processed due to validation errors. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Applications
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateApplicationRequest'
    delete:
      operationId: delete_application
      summary: Delete an Application
      description: 'Delete an Application.


        #### Permissions


        The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_ or _Messaging_ or _Fax_.


        Learn more about API scopes.'
      parameters:
      - $ref: '#/components/parameters/AccountSidPath'
      - $ref: '#/components/parameters/ApplicationPathSid'
      responses:
        '204':
          description: 204 No Content response.
        '400':
          description: The request was invalid or cannot be processed. Check the error details for more information.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '401':
          description: Authentication failed. Please verify your credentials and try again.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
        '404':
          description: The requested resource was not found. Please verify the resource identifier.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CompatibilityErrorResponse'
      tags:
      - Applications
components:
  parameters:
    ApplicationPathSid:
      name: Sid
      in: path
      required: true
      description: The Application ID that uniquely identifies the Application.
      schema:
        $ref: '#/components/schemas/uuid'
    AccountSidPath:
      name: AccountSid
      in: path
      required: true
      description: The Account ID that has the Application.
      schema:
        $ref: '#/components/schemas/uuid'
  schemas:
    UpdateApplicationRequest:
      type: object
      required:
      - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 64
          description: A named unique identifier for the resource.
          examples:
          - My Friendly Name
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when a phone number receives a call or fax.
          examples:
          - http://example.com
        VoiceMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          examples:
          - http://example.com
        VoiceFallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to pass status updates to the Application.
          examples:
          - http://example.com
        StatusCallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an SMS is received.
          examples:
          - http://example.com
        SmsMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          examples:
          - http://www.example.com/sms-fallback
        SmsFallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsStatusCallback:
          type: string
          format: uri
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
        SmsStatusCallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
      unevaluatedProperties:
        not: {}
      description: Request body for updating an application.
    CompatibilityErrorResponse:
      type: object
      required:
      - code
      - message
      - more_info
      - status
      properties:
        code:
          type: integer
          format: int32
          description: Error code.
          examples:
          - 20003
        message:
          type: string
          description: Error message.
          examples:
          - Authentication failed
        more_info:
          type: string
          description: URL for more information about the error.
          examples:
          - https://signalwire.com/docs/compatibility-api/reference/errors
        status:
          type: integer
          format: int32
          description: HTTP status code.
          examples:
          - 401
      unevaluatedProperties:
        not: {}
      description: Error response model.
    ApplicationListResponse:
      type: object
      required:
      - uri
      - first_page_uri
      - next_page_uri
      - previous_page_uri
      - page
      - page_size
      - applications
      properties:
        uri:
          type: string
          description: The URI for this resource.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50
        first_page_uri:
          type: string
          description: The URI for the first page of results.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=0&PageSize=50
        next_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI for the next page of results. Null if there are no more pages.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications?Page=1&PageSize=50
        previous_page_uri:
          anyOf:
          - type: string
          - type: 'null'
          description: The URI for the previous page of results. Null if this is the first page.
          examples:
          - null
        page:
          type: integer
          format: int32
          description: The current page number. Zero-indexed.
          examples:
          - 0
        page_size:
          type: integer
          format: int32
          description: The number of results per page.
          examples:
          - 50
        applications:
          type: array
          items:
            $ref: '#/components/schemas/Application'
          description: List of applications.
      unevaluatedProperties:
        not: {}
      description: Response containing a list of applications.
    CreateApplicationRequest:
      type: object
      required:
      - FriendlyName
      properties:
        FriendlyName:
          type: string
          maxLength: 64
          description: A named unique identifier for the resource.
          examples:
          - My Friendly Name
        VoiceUrl:
          type: string
          format: uri
          description: The URL to request when a phone number receives a call or fax.
          examples:
          - http://example.com
        VoiceMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        VoiceFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          examples:
          - http://example.com
        VoiceFallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        StatusCallback:
          type: string
          format: uri
          description: The URL to pass status updates to the Application.
          examples:
          - http://example.com
        StatusCallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsUrl:
          type: string
          format: uri
          description: The URL to request when an SMS is received.
          examples:
          - http://example.com
        SmsMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsFallbackUrl:
          type: string
          format: uri
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          examples:
          - http://www.example.com/sms-fallback
        SmsFallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
        SmsStatusCallback:
          type: string
          format: uri
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
        SmsStatusCallbackMethod:
          type: string
          enum:
          - GET
          - POST
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
          default: POST
      unevaluatedProperties:
        not: {}
      description: Request body for creating an application.
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    ApplicationResponse:
      type: object
      required:
      - sid
      - account_sid
      - api_version
      - date_created
      - date_updated
      - friendly_name
      - uri
      - voice_url
      - voice_method
      - voice_fallback_url
      - voice_fallback_method
      - status_callback
      - status_callback_method
      - voice_caller_id_lookup
      - sms_url
      - sms_method
      - sms_fallback_url
      - sms_fallback_method
      - sms_status_callback
      - sms_status_callback_method
      - message_status_callback
      properties:
        sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the Application.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        account_sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the Account that created this Application.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        api_version:
          type: string
          description: The version of the SignalWire API.
          examples:
          - '2010-04-01'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was created.
          examples:
          - Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was updated.
          examples:
          - Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: A named unique identifier for the resource.
          examples:
          - My Friendly Name
        uri:
          type: string
          description: The URI for this Application.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json
        voice_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to request when a phone number receives a call or fax.
          examples:
          - http://example.com
        voice_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        voice_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          examples:
          - http://example.com
        voice_fallback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to pass status updates to the Application.
          examples:
          - http://example.com
        status_callback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        voice_caller_id_lookup:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether or not to look up a caller's ID from the database. Always null.
          examples:
          - null
        sms_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to request when an SMS is received.
          examples:
          - http://example.com
        sms_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        sms_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          examples:
          - http://www.example.com/sms-fallback
        sms_fallback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        sms_status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
        sms_status_callback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        message_status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
      unevaluatedProperties:
        not: {}
      description: Response containing a single application.
    Application:
      type: object
      required:
      - sid
      - account_sid
      - api_version
      - date_created
      - date_updated
      - friendly_name
      - uri
      - voice_url
      - voice_method
      - voice_fallback_url
      - voice_fallback_method
      - status_callback
      - status_callback_method
      - voice_caller_id_lookup
      - sms_url
      - sms_method
      - sms_fallback_url
      - sms_fallback_method
      - sms_status_callback
      - sms_status_callback_method
      - message_status_callback
      properties:
        sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the Application.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        account_sid:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: The unique identifier for the Account that created this Application.
          examples:
          - b3877c40-da60-4998-90ad-b792e98472af
        api_version:
          type: string
          description: The version of the SignalWire API.
          examples:
          - '2010-04-01'
        date_created:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was created.
          examples:
          - Sat, 15 Sept 2018 10:00:00 +0000
        date_updated:
          type: string
          description: The date, in RFC 2822 GMT format, this Application was updated.
          examples:
          - Sat, 16 Sept 2018 10:00:00 +0000
        friendly_name:
          type: string
          description: A named unique identifier for the resource.
          examples:
          - My Friendly Name
        uri:
          type: string
          description: The URI for this Application.
          examples:
          - /api/laml/2010-04-01/Accounts/b3877c40-da60-4998-90ad-b792e98472af/Applications/b3877c40-da60-4998-90ad-b792e98472af.json
        voice_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to request when a phone number receives a call or fax.
          examples:
          - http://example.com
        voice_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `VoiceUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        voice_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL SignalWire will request if errors occur when fetching the `VoiceUrl`.
          examples:
          - http://example.com
        voice_fallback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `VoiceFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to pass status updates to the Application.
          examples:
          - http://example.com
        status_callback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to the `StatusCallback` URL is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        voice_caller_id_lookup:
          anyOf:
          - type: boolean
          - type: 'null'
          description: Whether or not to look up a caller's ID from the database. Always null.
          examples:
          - null
        sms_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to request when an SMS is received.
          examples:
          - http://example.com
        sms_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        sms_fallback_url:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL SignalWire will request if errors occur when fetching the `SmsUrl`.
          examples:
          - http://www.example.com/sms-fallback
        sms_fallback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsFallbackUrl` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        sms_status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
        sms_status_callback_method:
          anyOf:
          - type: string
          - type: 'null'
          description: Whether the request to `SmsStatusCallback` is a `GET` or a `POST`. Default is `POST`.
          examples:
          - POST
        message_status_callback:
          anyOf:
          - type: string
          - type: 'null'
          description: The URL to receive status updates for messages sent via this Application.
          examples:
          - http://www.example.com/sms-status-callback
      unevaluatedProperties:
        not: {}
      description: Application model representing a cXML application.
  securitySchemes:
    SignalWireBasicAuth:
      type: http
      scheme: Basic
      description: 'SignalWire Basic Authentication using Project ID and API Token.


        The client sends HTTP requests with the Authorization header containing

        the word Basic followed by a space and a base64-encoded string of project_id:token.

        The project ID will be used as the username and the API token as the password.


        Example:

        ```

        Authorization: Basic base64(project_id:token)

        ```'
      x-fern-basic:
        username:
          name: project_id
          env: SIGNALWIRE_PROJECT_ID
        password:
          name: api_token
          env: SIGNALWIRE_API_TOKEN