List Subscriber SIP Endpoints

GET 
/resources/subscribers/:fabric_subscriber_id/sip_endpoints

A list of Sip Endpoints of the Subscriber

Request

Path Parameters

fabric_subscriber_id uuidrequired

Unique ID of a Fabric Subscriber.

Responses

200

The request has succeeded.

application/json

Schema

Schema

data

object[]

required

Array [

id uuidrequired

Universal Unique Identifier.

username stringrequired

Username of the Sip Endpoint.

caller_id stringrequired

Caller ID of the Sip Endpoint.

send_as stringrequired

Purchased or verified number

ciphers CipherType (string)[]required

Possible values: [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]

Ciphers of the Sip Endpoint.

codecs CodecType (string)[]required

Possible values: [OPUS, G722, PCMU, PCMA, G729, VP8, H264]

Codecs of the Sip Endpoint.

encryption EncryptionType (string)required

Possible values: [default, required, optional]

Encryption

]

links

object

required

self urirequired

Link of the current page

first urirequired

Link to the first page

next urirequired

Link to the next page

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "username": "justice-league",
      "caller_id": "call-id-123",
      "send_as": "+14632322867",
      "ciphers": [
        "AEAD_AES_256_GCM_8"
      ],
      "codecs": [
        "OPUS"
      ],
      "encryption": "default"
    }
  ],
  "links": {
    "self": "https://{space_name}.signalwire.com/api/fabric/resources/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?page_number=0&page_size=50",
    "first": "https://{space_name}.signalwire.com/api/fabric/resources/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?page_number=0&page_size=50",
    "next": "https://{space_name}.signalwire.com/api/fabric/resources/subscribers/d369a402-7b43-4512-8735-9d5e1f387814/sip_endpoints?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca"
  }
}

401

Access is unauthorized.

application/json

Schema

Schema

string

Possible values: [Unauthorized]

404

The server cannot find the requested resource.

application/json

Schema

Schema

string

Possible values: [Not Found]

Loading...