SignalWire SIP Gateway API

openapi: 3.2.0
info:
  title: SignalWire REST SIP Gateway API
  version: 1.0.0
  contact:
    name: SignalWire
    url: https://support.signalwire.com/portal/en/newticket?departmentId=1029313000000006907&layoutId=1029313000000074011
    email: support@signalwire.com
  license:
    name: MIT
    url: https://github.com/signalwire/docs/blob/main/LICENSE
  termsOfService: https://signalwire.com/legal/signalwire-cloud-agreement
  description: Endpoints related to creating & managing SIP Gateways
servers:
- url: https://{space_name}.signalwire.com
  description: SignalWire API
  variables:
    space_name:
      default: '{Your_Space_Name}'
      description: Your SignalWire Space name
security:
- SignalWireBasicAuth: []
tags:
- name: SIP Gateway
  description: Endpoints related to creating & managing SIP Gateways
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on SIP Gateway, Fabric API endpoints
paths:
  /api/fabric/resources/sip_gateways:
    get:
      operationId: list_sip_gateways
      summary: List SIP gateways
      description: 'Returns a paginated list of SIP Gateways for the authenticated project.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters: []
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
    post:
      operationId: create_sip_gateway
      summary: Create SIP gateway
      description: 'Creates a SIP Gateway that can be used to dial external SIP entities.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters: []
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipGatewayRequest'
  /api/fabric/resources/sip_gateways/{id}:
    get:
      operationId: get_sip_gateway
      summary: Get SIP gateway
      description: 'Returns an SIP Gateway by ID


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/SipGatewayID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
    patch:
      operationId: update_sip_gateway
      summary: Update SIP gateway
      description: 'Updates a SIP Gateway by ID


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/SipGatewayID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '422':
          description: The request contains invalid parameters. See errors for details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SipGatewayRequestUpdate'
    delete:
      operationId: delete_sip_gateway
      summary: Delete SIP gateway
      description: 'Deletes a SIP Gateway by ID


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/SipGatewayID'
      responses:
        '204':
          description: 'There is no content to send for this request, but the headers may be useful. '
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
  /api/fabric/resources/sip_gateways/{id}/addresses:
    get:
      operationId: list_sip_gateway_addresses
      summary: List SIP gateway Addresses
      description: 'Returns a paginated list of Fabric Addresses associated with the specified SIP Gateway.


        #### Permissions


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


        [Learn more about API scopes](/docs/platform/your-signalwire-api-space).'
      parameters:
      - $ref: '#/components/parameters/SipGatewayAddressRequest'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SipGatewayAddressListResponse'
        '401':
          description: Access is unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode401'
        '404':
          description: The server cannot find the requested resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode404'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - SIP Gateway
components:
  schemas:
    SipGatewayPaginationResponse:
      type: object
      required:
      - self
      - first
      properties:
        self:
          type: string
          format: uri
          description: Link to the current page of results
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50
        first:
          type: string
          format: uri
          description: Link to the first page of results
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50
        next:
          type: string
          format: uri
          description: Link to the next page of results
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
        prev:
          type: string
          format: uri
          description: Link to the previous page of results
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
      unevaluatedProperties:
        not: {}
    Types.StatusCodes.StatusCode401:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Unauthorized
      unevaluatedProperties:
        not: {}
      description: Access is unauthorized.
    Encryption:
      type: string
      enum:
      - required
      - optional
      - default
    SipGatewayCreateStatusCode422:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Types.StatusCodes.RestApiErrorItem'
          description: List of validation errors.
      unevaluatedProperties:
        not: {}
      description: The request contains invalid parameters. See errors for details.
      examples:
      - statusCode: 422
        errors:
        - type: validation_error
          code: missing_required_parameter
          message: Name can't be blank
          attribute: name
          url: https://signalwire.com/docs/apis/error-codes
    SipGateway:
      type: object
      required:
      - id
      - uri
      - name
      - ciphers
      - codecs
      - encryption
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the SIP Gateway.
          examples:
          - cce59cad-104d-4c28-ada4-98cfd102ae09
        uri:
          type: string
          description: The URI for the SIP Gateway.
          examples:
          - user3@domain.com
        name:
          type: string
          description: Display name of the SIP Gateway.
          examples:
          - My SIP Gateway
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
          examples:
          - - AEAD_AES_256_GCM_8
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs.
          examples:
          - - OPUS
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement.
          examples:
          - required
      unevaluatedProperties:
        not: {}
    Codecs:
      type: string
      enum:
      - PCMU
      - PCMA
      - G722
      - G729
      - OPUS
      - OPUS@48000H@20I
      - OPUS@24000H@20I
      - OPUS@16000H@20I
      - OPUS@8000H@20I
      - VP8
      - H264
    AddressChannel:
      anyOf:
      - $ref: '#/components/schemas/AudioChannel'
      - $ref: '#/components/schemas/MessagingChannel'
      - $ref: '#/components/schemas/VideoChannel'
    VideoChannel:
      type: object
      required:
      - video
      properties:
        video:
          type: string
          description: Video Channel of Fabric Address
          examples:
          - /external/resource_name?channel=video
      unevaluatedProperties:
        not: {}
    Ciphers:
      type: string
      enum:
      - AEAD_AES_256_GCM_8
      - AES_256_CM_HMAC_SHA1_80
      - AES_CM_128_HMAC_SHA1_80
      - AES_256_CM_HMAC_SHA1_32
      - AES_CM_128_HMAC_SHA1_32
    SipGatewayResponse:
      type: object
      required:
      - id
      - project_id
      - display_name
      - type
      - created_at
      - updated_at
      - sip_gateway
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the resource.
          examples:
          - 0823a606-0aff-4c90-9eba-f88ba118fe05
        project_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Project ID associated with the resource.
          examples:
          - bc949800-7b40-43cf-8438-a85facfcbdd1
        display_name:
          type: string
          description: Display name of the SIP Gateway.
          examples:
          - My SIP Gateway
        type:
          type: string
          enum:
          - sip_gateway
          description: Type of the resource.
          examples:
          - sip_gateway
        created_at:
          type: string
          format: date-time
          description: Timestamp when the resource was created.
          examples:
          - '2024-05-06T12:20:00Z'
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the resource was last updated.
          examples:
          - '2024-05-06T12:20:00Z'
        sip_gateway:
          allOf:
          - $ref: '#/components/schemas/SipGateway'
          description: SIP Gateway configuration details.
      unevaluatedProperties:
        not: {}
    AudioChannel:
      type: object
      required:
      - audio
      properties:
        audio:
          type: string
          description: Audio Channel of Fabric Address
          examples:
          - /external/resource_name?channel=audio
      unevaluatedProperties:
        not: {}
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    Types.StatusCodes.StatusCode404:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Not Found
      unevaluatedProperties:
        not: {}
      description: The server cannot find the requested resource.
    SipGatewayAddressListResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/FabricAddressCall'
          description: An array of objects containing a list of SIP Gateway Addresses
        links:
          allOf:
          - $ref: '#/components/schemas/SipGatewayAddressPaginationResponse'
          description: Object containing pagination links
      unevaluatedProperties:
        not: {}
    Types.StatusCodes.StatusCode500:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Internal Server Error
      unevaluatedProperties:
        not: {}
      description: An internal server error occurred.
    SipGatewayListResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SipGatewayResponse'
          description: An array of objects that contain a list of SIP Gateway data
        links:
          allOf:
          - $ref: '#/components/schemas/SipGatewayPaginationResponse'
          description: Pagination links for the response.
      unevaluatedProperties:
        not: {}
    MessagingChannel:
      type: object
      required:
      - messaging
      properties:
        messaging:
          type: string
          description: Messaging Channel of Fabric Address
          examples:
          - /external/resource_name?channel=messaging
      unevaluatedProperties:
        not: {}
    Types.StatusCodes.RestApiErrorItem:
      type: object
      required:
      - type
      - code
      - message
      - url
      properties:
        type:
          type: string
          description: The category of error.
          examples:
          - validation_error
        code:
          type: string
          description: A specific error code.
          examples:
          - invalid_parameter
        message:
          type: string
          description: A description of what caused the error.
          examples:
          - Name must be present
        attribute:
          anyOf:
          - type: string
          - type: 'null'
          description: The request parameter that caused the error, if applicable.
          examples:
          - name
        url:
          type: string
          description: A link to documentation about this error.
          examples:
          - https://signalwire.com/docs/apis/error-codes
      unevaluatedProperties:
        not: {}
      description: Details about a specific error.
    SipGatewayRequestUpdate:
      type: object
      properties:
        name:
          type: string
          description: Display name for the SIP Gateway.
          examples:
          - My SIP Gateway
        uri:
          type: string
          description: External SIP URI.
          examples:
          - user2@domain.com
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement for the SIP connection.
          examples:
          - required
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
          examples:
          - - AEAD_AES_256_GCM_8
            - AES_256_CM_HMAC_SHA1_80
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs for media transmission.
          examples:
          - - OPUS
      unevaluatedProperties:
        not: {}
    FabricAddressCall:
      type: object
      required:
      - id
      - name
      - display_name
      - cover_url
      - preview_url
      - locked
      - channels
      - created_at
      - type
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Fabric Address.
          examples:
          - 691af061-cd86-4893-a605-173f47afc4c2
        name:
          type: string
          description: Name of the Fabric Address.
          examples:
          - justice-league
        display_name:
          type: string
          description: Display name of the Fabric Address.
          examples:
          - Justice League
        cover_url:
          type: string
          description: Cover url of the Fabric Address.
          examples:
          - https://coverurl.com
        preview_url:
          type: string
          description: Preview url of the Fabric Address.
          examples:
          - https://previewurl.com
        locked:
          type: boolean
          description: Locks the Fabric Address. This is used to prevent the Fabric Address from accepting calls.
          examples:
          - true
        channels:
          allOf:
          - $ref: '#/components/schemas/AddressChannel'
          description: Channels of the Fabric Address.
        created_at:
          type: string
          format: date-time
          description: Fabric Address Creation Date.
          examples:
          - '2024-05-06T12:20:00Z'
        type:
          type: string
          enum:
          - call
          description: The display type of a fabric address pointing to call.
          examples:
          - call
      unevaluatedProperties:
        not: {}
      title: Call Address
    SipGatewayRequest:
      type: object
      required:
      - name
      - uri
      - encryption
      - ciphers
      - codecs
      properties:
        name:
          type: string
          description: Display name for the SIP Gateway.
          examples:
          - My SIP Gateway
        uri:
          type: string
          description: External SIP URI.
          examples:
          - user2@domain.com
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Specifies the encryption requirement for the SIP connection.
          examples:
          - required
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: List of supported SIP ciphers.
          examples:
          - - AEAD_AES_256_GCM_8
            - AES_256_CM_HMAC_SHA1_80
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: List of supported codecs for media transmission.
          examples:
          - - OPUS
      unevaluatedProperties:
        not: {}
    SipGatewayAddressPaginationResponse:
      type: object
      required:
      - self
      - first
      properties:
        self:
          type: string
          format: uri
          description: Link of the current page
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50
        first:
          type: string
          format: uri
          description: Link to the first page
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50
        next:
          type: string
          format: uri
          description: Link to the next page
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
        prev:
          type: string
          format: uri
          description: Link to the previous page
          examples:
          - https://example.signalwire.com/api/fabric/resources/sip_gateways/a87db7ed-8ebe-42e4-829f-8ba5a4152f54/addresses?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
      unevaluatedProperties:
        not: {}
  parameters:
    SipGatewayAddressRequest:
      name: id
      in: path
      required: true
      description: The unique identifier of the SIP Gateway.
      schema:
        $ref: '#/components/schemas/uuid'
    SipGatewayID:
      name: id
      in: path
      required: true
      description: Unique ID of a SIP Gateway.
      schema:
        $ref: '#/components/schemas/uuid'
  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
    SignalWireBearerAuth:
      type: http
      scheme: Bearer
      description: 'SignalWire Bearer Token Authentication for subscriber endpoints.

        The client sends HTTP requests with the Authorization header containing

        the word Bearer followed by a space and the subscriber token.


        Example:

        ```

        Authorization: Bearer <subscriber_token>

        ```'