v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB

SIP Credentials

Assign Resource to SIP credential

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.

post/api/fabric/resources/{id}/sip_endpoints

Path parameters

idstring uuid required

Universal Unique Identifier.

The unique identifier of the Resource.

Request body

sip_endpoint_idstring uuid required

Universal Unique Identifier.

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name for the SIP endpoint.

type'call' required

The Resource type

cover_urlstring uri nullable required

The cover URL for the SIP endpoint.

preview_urlstring uri nullable required

The preview URL for the SIP endpoint.

Example response

{
  "name": "sip_user",
  "type": "call",
  "cover_url": "https://example.com/cover.jpg",
  "preview_url": "https://example.com/preview.jpg",
  "channels": {
    "audio": "/external/resource_name?channel=audio"
  }
}