Assign Resource to SIP credential

POST

https://{your_space_name}.signalwire.com/api/fabric/resources/:id/sip_endpoints

Assigns an existing resource as the calling handler for a SIP Credential. Use it when calls placed by the registered SIP device should run that resource’s instructions. This operation does not create a credential; use Create SIP credential first when the device does not yet have one.

Currently only supports calling as a handler and automatically defaults to it.

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.

Assigns an existing resource as the calling handler for a SIP Credential. Use it when calls placed by the registered SIP device should run that resource's instructions. This operation does not create a credential; use [Create SIP credential](/docs/apis/rest/sip-credentials/create-sip-credential) first when the device does not yet have one. <Note> Currently only supports `calling` as a handler and automatically defaults to it. </Note> #### 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).

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)

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

idstringRequiredformat: "uuid"

The unique identifier of the Resource.

Request

This endpoint expects an object.

sip_endpoint_idstringRequiredformat: "uuid"

The unique identifier of the SIP endpoint.

Response

The request has succeeded.

idstringformat: "uuid"

The unique identifier of the SIP endpoint.

namestring

The name for the SIP endpoint.

typeenum

The Resource type

cover_urlstring or nullformat: "uri"

The cover URL for the SIP endpoint.

preview_urlstring or nullformat: "uri"

The preview URL for the SIP endpoint.

channelsobject

An object containing the resource addresses with the specified comunication channels

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error