FabricSubscribers Sip Endpoints

Create Subscriber SIP Endpoint

View as Markdown

Creates a Subscriber Sip Endpoint

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.

Authentication

AuthorizationBasic
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) ```

Path parameters

fabric_subscriber_idstringRequiredformat: "uuid"
Unique ID of a Fabric Subscriber.

Request

This endpoint expects an object.
usernamestringRequired
Username of the Sip Endpoint.
passwordstringRequired
Password of the Sip Endpoint.
caller_idstringOptional
Caller ID of the Sip Endpoint.
send_asstringOptional
The Number to send as.
cipherslist of enumsOptional
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enumsOptional
Codecs of the Sip Endpoint.
encryptionenumOptional
Encryption requirement of the Sip Endpoint.
Allowed values:

Response

The request has succeeded and a new resource has been created as a result.
idstringformat: "uuid"
Unique ID of the Sip Endpoint.
usernamestring
Username of the Sip Endpoint.
caller_idstring
Caller ID of the Sip Endpoint.
send_asstring
Purchased or verified number
cipherslist of enums
Ciphers of the Sip Endpoint.
Allowed values:
codecslist of enums
Codecs of the Sip Endpoint.
encryptionenum
Encryption requirement of the Sip Endpoint.
Allowed values:

Errors