SIP Endpoints (Legacy)
List SIP endpoints
Returns a list of your SIP endpoints.
<Warning>This endpoint is deprecated. Use SIP Credentials instead.</Warning>
Permissions
The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice.
Learn more about API scopes.
get/api/relay/rest/endpoints/sip
Query parameters
filter_usernamestring
Filter SIP endpoints by username (partial match).
filter_caller_idstring
Filter SIP endpoints by caller ID (partial match).
page_numberinteger
The page number to retrieve (0-indexed).
page_sizeinteger
The number of items per page (1-1000).
page_tokenstring
Token for cursor-based pagination. Required when page_number > 0.
Response
The request has succeeded.
Example response
{
"data": [
{
"type": "sip_endpoint",
"username": "c3p0",
"caller_id": "C-3P0",
"send_as": "random",
"encryption": "required",
"call_request_method": "POST",
"call_fallback_method": "POST",
"call_status_callback_method": "POST",
"call_relay_topic": "office",
"call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
"call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
"call_relay_script_url": "https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92"
}
]
}