List SIP credentials

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints

GET

/api/fabric/resources/sip_endpoints

curl https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints \
     -u "<project_id>:<api_token>"

[
  {
    "links": {
      "self": "string",
      "first": "string",
      "next": "string",
      "prev": "string"
    },
    "data": [
      {
        "type": "sip_endpoint",
        "id": "67075301-69b2-4fc3-8a2c-c95a69a5665e",
        "username": "c3p0",
        "caller_id": "C-3P0",
        "send_as": "random",
        "ciphers": [
          "string"
        ],
        "codecs": [
          "string"
        ],
        "encryption": "required",
        "call_handler": "ai_agent",
        "calling_handler_resource_id": "fe4093d9-58c2-4931-b4b9-5679f82652c6",
        "call_request_url": "string",
        "call_request_method": "POST",
        "call_fallback_url": "string",
        "call_fallback_method": "POST",
        "call_status_callback_url": "string",
        "call_status_callback_method": "POST",
        "call_laml_application_id": "string",
        "call_dialogflow_agent_id": "string",
        "call_relay_topic": "office",
        "call_relay_topic_status_callback_url": "https://myapplication/handle_relay_callbacks",
        "call_relay_context": "string",
        "call_relay_context_status_callback_url": "https://myapplication/handle_relay_callbacks",
        "call_relay_application": "string",
        "call_video_room_id": "string",
        "call_relay_script_url": "https://dev.signalwire.com/relay-bins/f9d13f68-f71e-4042-95bb-b07b9e2f2f92"
      }
    ]
  }
]

Returns the project’s SIP Credential resources. Use it to inventory credentials used by SIP devices that register with SignalWire. Use Subscriber SIP Credentials when credentials must belong to one Subscriber, or SIP Gateways for external SIP destinations that SignalWire dials.

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.

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)

Response

The request has succeeded.

linksobject

Pagination links.

datalist of objects

List of SIP endpoints.

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error