Subscriber SIP Credentials

Create Subscriber SIP credential

Changed on

Creates a SIP Credential owned by a specified Subscriber, allowing that subscriber's SIP device to register with SignalWire. Use it for per-subscriber devices; use Create SIP credential for a project-scoped credential not tied to a subscriber.

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.

post/api/fabric/resources/subscribers/{fabric_subscriber_id}/sip_endpoints

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/resources/subscribers/{fabric_subscriber_id}/sip_endpoints
  • Auth
    HTTP basic

Path parameters

fabric_subscriber_idstring uuid required

Universal Unique Identifier.

Unique ID of a Fabric Subscriber.

Request body

usernamestring required

Username of the Sip Endpoint.

passwordstring required

Password of the Sip Endpoint.

caller_idstring

Caller ID of the Sip Endpoint.

send_asstring

The Number to send as.

ciphersCiphers[]

Ciphers of the Sip Endpoint.

codecsCodecs[]

Codecs of the Sip Endpoint.

encryption'required' | 'optional' | 'default'

Example request

{
  "username": "justice-league",
  "password": "hack-me-if-you-can",
  "caller_id": "call-id-123",
  "send_as": "+14632322867"
}

Response

The request has succeeded and a new resource has been created as a result.

idstring uuid required

Universal Unique Identifier.

usernamestring required

Username of the Sip Endpoint.

caller_idstring required

Caller ID of the Sip Endpoint.

send_asstring required

Purchased or verified number

ciphersCiphers[] required

Ciphers of the Sip Endpoint.

codecsCodecs[] required

Codecs of the Sip Endpoint.

encryption'required' | 'optional' | 'default' required

Example response

{
  "username": "justice-league",
  "caller_id": "call-id-123",
  "send_as": "+14632322867"
}

Changes

  • 9709f1df4022Revision changes
    • warning

      added the new OPUS@16000H@20I enum value to the / response property for the response status

    • warning

      added the new OPUS@24000H@20I enum value to the / response property for the response status

    • warning

      added the new OPUS@48000H@20I enum value to the / response property for the response status

    • warning

      added the new OPUS@8000H@20I enum value to the / response property for the response status

    • info

      added the new OPUS@16000H@20I enum value to the request property /

    • info

      added the new OPUS@24000H@20I enum value to the request property /

    • info

      added the new OPUS@48000H@20I enum value to the request property /

    • info

      added the new OPUS@8000H@20I enum value to the request property /

  • a888562fa415Revision changes
    • breaking

      removed the enum value OPUS@16000H@20I of the request property /

    • breaking

      removed the enum value OPUS@24000H@20I of the request property /

    • breaking

      removed the enum value OPUS@48000H@20I of the request property /

    • breaking

      removed the enum value OPUS@8000H@20I of the request property /

    • info

      removed the OPUS@16000H@20I enum value from the / response property for the response status

    • info

      removed the OPUS@24000H@20I enum value from the / response property for the response status

    • info

      removed the OPUS@48000H@20I enum value from the / response property for the response status

    • info

      removed the OPUS@8000H@20I enum value from the / response property for the response status

Some revisions have not been checked yet.