SignalWire Subscriber SIP Credentials API

openapi: 3.2.0
info:
  title: SignalWire REST Subscriber SIP Credentials 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 [Subscriber](/docs/platform/subscribers) SIP Endpoints.
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: Subscriber SIP Credentials
  description: Endpoints related to creating & managing [Subscriber](/docs/platform/subscribers) SIP Endpoints.
  externalDocs:
    url: https://signalwire.com/docs/apis
    description: Developer documentation on Subscriber SIP Endpoint, Fabric API endpoints
paths:
  /api/fabric/resources/subscribers/{fabric_subscriber_id}/sip_endpoints:
    get:
      operationId: list_subscriber_sip_credentials
      summary: List Subscriber SIP credentials
      description: 'A list of SIP Credentials for the [Subscriber](/docs/platform/subscribers).


        #### 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/FabricSubscriberID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberSipEndpointListResponse'
        '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:
      - Subscriber SIP Credentials
    post:
      operationId: create_subscriber_sip_credential
      summary: Create Subscriber SIP credential
      description: 'Creates a [Subscriber](/docs/platform/subscribers) SIP Credential.


        #### 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/FabricSubscriberID'
      responses:
        '201':
          description: The request has succeeded and a new resource has been created as a result.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberSIPEndpoint'
        '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/SipEndpointCreateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Subscriber SIP Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriberSipEndpointRequest'
  /api/fabric/resources/subscribers/{fabric_subscriber_id}/sip_endpoints/{id}:
    get:
      operationId: get_subscriber_sip_credential
      summary: Get Subscriber SIP credential
      description: 'Returns a [Subscriber](/docs/platform/subscribers) SIP Credential 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/SIPEndpointID'
      - $ref: '#/components/parameters/FabricSubscriberID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberSIPEndpoint'
        '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:
      - Subscriber SIP Credentials
    patch:
      operationId: update_subscriber_sip_credential
      summary: Update Subscriber SIP credential
      description: 'Updates a [Subscriber](/docs/platform/subscribers) SIP Credential 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/SIPEndpointID'
      - $ref: '#/components/parameters/FabricSubscriberID'
      responses:
        '200':
          description: The request has succeeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriberSIPEndpoint'
        '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/SipEndpointUpdateStatusCode422'
        '500':
          description: An internal server error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Types.StatusCodes.StatusCode500'
      tags:
      - Subscriber SIP Credentials
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriberSipEndpointRequestUpdate'
    delete:
      operationId: delete_subscriber_sip_credential
      summary: Delete Subscriber SIP credential
      description: 'Deletes a [Subscriber](/docs/platform/subscribers) SIP Credential 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/SIPEndpointID'
      - $ref: '#/components/parameters/FabricSubscriberID'
      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:
      - Subscriber SIP Credentials
components:
  schemas:
    SubscriberSipEndpointPaginationResponse:
      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/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?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/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?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/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
        prev:
          type: string
          format: uri
          description: The link to the previous page
          examples:
          - https://example.signalwire.com/api/fabric/resources/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca
      unevaluatedProperties:
        not: {}
    SubscriberSIPEndpoint:
      type: object
      required:
      - id
      - username
      - caller_id
      - send_as
      - ciphers
      - codecs
      - encryption
      properties:
        id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: Unique ID of the Sip Endpoint.
          examples:
          - acaa5c49-be5e-4477-bce0-48f4b23b7720
        username:
          type: string
          description: Username of the Sip Endpoint.
          examples:
          - justice-league
        caller_id:
          type: string
          description: Caller ID of the Sip Endpoint.
          examples:
          - call-id-123
        send_as:
          type: string
          description: Purchased or verified number
          examples:
          - '+14632322867'
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers of the Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs of the Sip Endpoint.
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Encryption requirement of the Sip Endpoint.
          examples:
          - optional
      unevaluatedProperties:
        not: {}
    SipEndpointCreateStatusCode422:
      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: invalid_parameter
          message: Ciphers are invalid
          attribute: ciphers
          url: https://signalwire.com/docs/apis/error-codes
    SubscriberSipEndpointRequestUpdate:
      type: object
      properties:
        username:
          type: string
          description: Username of the Sip Endpoint.
          examples:
          - justice-league
        password:
          type: string
          description: Password of the Sip Endpoint.
          examples:
          - hack-me-if-you-can
        caller_id:
          type: string
          description: Caller ID of the Sip Endpoint.
          examples:
          - call-id-123
        send_as:
          type: string
          description: The Number to send as.
          examples:
          - '+14632322867'
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers of the Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs of the Sip Endpoint.
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Encryption requirement of the Sip Endpoint.
          examples:
          - optional
          default: default
      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
    uuid:
      type: string
      format: uuid
      description: Universal Unique Identifier.
    SipEndpointUpdateStatusCode422:
      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: invalid_parameter
          message: Ciphers are invalid
          attribute: ciphers
          url: https://signalwire.com/docs/apis/error-codes
    Types.StatusCodes.StatusCode404:
      type: object
      required:
      - error
      properties:
        error:
          type: string
          enum:
          - Not Found
      unevaluatedProperties:
        not: {}
      description: The server cannot find the requested resource.
    SubscriberSipEndpointRequest:
      type: object
      required:
      - username
      - password
      properties:
        username:
          type: string
          description: Username of the Sip Endpoint.
          examples:
          - justice-league
        password:
          type: string
          description: Password of the Sip Endpoint.
          examples:
          - hack-me-if-you-can
        caller_id:
          type: string
          description: Caller ID of the Sip Endpoint.
          examples:
          - call-id-123
        send_as:
          type: string
          description: The Number to send as.
          examples:
          - '+14632322867'
        ciphers:
          type: array
          items:
            $ref: '#/components/schemas/Ciphers'
          description: Ciphers of the Sip Endpoint.
        codecs:
          type: array
          items:
            $ref: '#/components/schemas/Codecs'
          description: Codecs of the Sip Endpoint.
        encryption:
          allOf:
          - $ref: '#/components/schemas/Encryption'
          description: Encryption requirement of the Sip Endpoint.
          examples:
          - optional
          default: default
      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
    SubscriberSipEndpointListResponse:
      type: object
      required:
      - data
      - links
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/SubscriberSIPEndpoint'
        links:
          $ref: '#/components/schemas/SubscriberSipEndpointPaginationResponse'
      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.
    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
    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.
  parameters:
    SIPEndpointID:
      name: id
      in: path
      required: true
      description: Unique ID of a Sip Endpoint.
      schema:
        $ref: '#/components/schemas/uuid'
    FabricSubscriberID:
      name: fabric_subscriber_id
      in: path
      required: true
      description: Unique ID of a Fabric Subscriber.
      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>

        ```'