List SIP endpoints

Deprecated

GET

https://{your_space_name}.signalwire.com/api/relay/rest/endpoints/sip

GET

/api/relay/rest/endpoints/sip

$ curl https://{your_space_name}.signalwire.com/api/relay/rest/endpoints/sip \
>      -u "<project_id>:<api_token>"

1 {
2   "links": {
3     "self": "string",
4     "first": "string",
5     "next": "string",
6     "prev": "string"
7   },
8   "data": [
9     {
10       "type": "sip_endpoint",
11       "id": "67075301-69b2-4fc3-8a2c-c95a69a5665e",
12       "username": "c3p0",
13       "caller_id": "C-3P0",
14       "send_as": "random",
15       "ciphers": [
16         "string"
17       ],
18       "codecs": [
19         "string"
20       ],
21       "encryption": "required",
22       "call_handler": "ai_agent",
23       "calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
24       "call_request_url": "string",
25       "call_request_method": "POST",
26       "call_fallback_url": "string",
27       "call_fallback_method": "POST",
28       "call_status_callback_url": "string",
29       "call_status_callback_method": "POST",
30       "call_laml_application_id": "string",
31       "call_dialogflow_agent_id": "string",
32       "call_relay_topic": "office",
33       "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
34       "call_relay_context": "string",
35       "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
36       "call_relay_application": "string",
37       "call_video_room_id": "string",
38       "call_relay_script_url": "https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92"
39     }
40   ]
41 }

Returns a list of your SIP endpoints.

This endpoint is deprecated. Use SIP Credentials instead.

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.

Returns a list of your SIP endpoints. <Warning>This endpoint is deprecated. Use [SIP Credentials](/docs/apis/rest/sip-credentials/create-sip-credential) 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](/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) ```

Query parameters

filter_usernamestringOptional

Filter SIP endpoints by username (partial match).

filter_caller_idstringOptional

Filter SIP endpoints by caller ID (partial match).

page_numberintegerOptionalDefaults to 0

The page number to retrieve (0-indexed).

page_sizeintegerOptional1-1000Defaults to 50

The number of items per page (1-1000).

page_tokenstringOptional

Token for cursor-based pagination. Required when page_number > 0.

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of SIP endpoints.

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

500

Internal Server Error