FabricSip Endpoints

Assign a Resource to a SIP endpoint

View as Markdown
This endpoint assigns a specific resource to a SIP endpoint, allowing inbound calls to be handled by the resource. <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) ```

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
Allowed values:
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