For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
  • Resource Management
        • POSTCreate Subscriber SIP credential
        • DELDelete Subscriber SIP credential
        • GETGet Subscriber SIP credential
        • GETList Subscriber SIP credentials
        • PATCHUpdate Subscriber SIP credential
      • POSTCreate Subscriber
      • DELDelete Subscriber
      • GETGet Subscriber
      • GETList Subscriber Addresses
      • GETList Subscribers
      • PUTUpdate Subscriber
LogoLogoSignalWire Docs
Log inSign up
Support
Resource ManagementSubscribersSubscriber SIP Credentials

Create Subscriber SIP credential

|View as Markdown|Open in Claude|
POST
https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers/:fabric_subscriber_id/sip_endpoints
POST
/api/fabric/resources/subscribers/:fabric_subscriber_id/sip_endpoints
$curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/subscribers/fabric_subscriber_id/sip_endpoints \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{
>  "username": "justice-league",
>  "password": "hack-me-if-you-can"
>}'
1{
2  "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3  "username": "justice-league",
4  "caller_id": "call-id-123",
5  "send_as": "+14632322867",
6  "ciphers": [
7    "AEAD_AES_256_GCM_8"
8  ],
9  "codecs": [
10    "PCMU"
11  ],
12  "encryption": "optional"
13}
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).
Was this page helpful?
Previous

Delete Subscriber SIP credential

Next
Built with

Creates a Subscriber 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.

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.
encryptionenumOptionalDefaults to default
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

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

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)