List all SIP Endpoints.

GET 
/endpoints/sip

Returns a list of your SIP Endpoints. The endpoints are returned sorted by creation date, with the most recent endpoints appearing first. The list is filterable by sending in any of the following parameters.

Permissions

The API token must include the following scopes: Voice.

Request

Query Parameters

filter_username string

String representing the username portion of the endpoint. Will return all SIP Endpoints containing this value as a substring.

filter_caller_id string

Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint. Will return all SIP Endpoints containing this value as a substring.

Responses

200

OK

application/json

Schema

Schema

links

object

self string

first string

next string

prev string
data object[]

Example (from schema)

{
  "links": {
    "self": "string",
    "first": "string",
    "next": "string",
    "prev": "string"
  },
  "data": [
    {
      "id": "67075301-69b2-4fc3-8a2c-c95a69a5665e",
      "username": "c3p0",
      "caller_id": "C-3P0",
      "send_as": "random",
      "ciphers": [
        "AEAD_AES_256_GCM_8",
        "AES_256_CM_HMAC_SHA1_80",
        "AES_CM_128_HMAC_SHA1_80",
        "AES_256_CM_HMAC_SHA1_32",
        "AES_CM_128_HMAC_SHA1_32"
      ],
      "codecs": [
        "OPUS",
        "G722",
        "PCMU",
        "PCMA",
        "VP8",
        "H264"
      ],
      "encryption": "required",
      "call_handler": "ai_agent",
      "call_request_url": null,
      "call_request_method": "POST",
      "call_fallback_url": null,
      "call_fallback_method": "POST",
      "call_status_callback_url": null,
      "call_status_callback_method": "POST",
      "call_laml_application_id": "",
      "call_relay_context": "",
      "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
      "call_video_room_id": "",
      "call_flow_id": "",
      "call_ai_agent_id": "",
      "call_relay_script_url": "https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92"
    }
  ]
}

Loading...