Update Subscriber SIP Endpoint

PATCH 
/resources/subscribers/:fabric_subscriber_id/sip_endpoints/:id

Updates a Subscriber Sip Endpoint by ID

Request

Path Parameters

id uuidrequired

Unique ID of a Sip Endpoint.

fabric_subscriber_id uuidrequired

Unique ID of a Fabric Subscriber.

application/json

Body

required

oneOf

Update Subscriber SIP Endpoint with Call Handler

call_handler CallHandlerPassthroughType (string)

Possible values: [default, passthrough, block-pstn]

Call handler of the Sip Endpoint.

username string

Username of the Sip Endpoint.

password string

Password of the Sip Endpoint.

password_confirmation string

Confirmation of the Password

caller_id string

Caller ID of the Sip Endpoint.

send_as string

The Number to send as.

ciphers CipherType (string)[]

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)[]

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

Codecs of the Sip Endpoint.

encryption EncryptionType (string)

Possible values: [default, required, optional]

Default value: default

Encryption requirement of the Sip Endpoint.

Update Subscriber SIP Endpoint with Resource ID

calling_handler_resource_id uuid

Universal Unique Identifier.

username string

Username of the Sip Endpoint.

password string

Password of the Sip Endpoint.

password_confirmation string

Confirmation of the Password

caller_id string

Caller ID of the Sip Endpoint.

send_as string

The Number to send as.

ciphers CipherType (string)[]

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)[]

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

Codecs of the Sip Endpoint.

encryption EncryptionType (string)

Possible values: [default, required, optional]

Default value: default

Encryption requirement of the Sip Endpoint.

Responses

200

The request has succeeded.

application/json

Schema

Schema

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

call_handler CallHandlerType (string)required

Possible values: [default, passthrough, block-pstn, relay_script, laml_webhook, laml_application, dialogflow, relay_context, relay_connector, video_room, ai_agent, call_flow]

Call handler of the Sip Endpoint.

calling_handler_resource_id uuidrequired

Universal Unique Identifier.

Example (from schema)

{
  "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",
  "call_handler": "default",
  "calling_handler_resource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

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]

422

Client error

application/json

Schema

Schema

errors

object[]

required

Array [

type stringrequired

Error type.

code stringrequired

Error code.

message stringrequired

Error details.

attribute stringrequired

Request parameter associated with this error.

url stringrequired

Link to developer resource for this error.

]

Example (from schema)

{
  "errors": [
    {
      "type": "validation_error",
      "code": "invalid_parameter",
      "message": "Ciphers are invalid",
      "attribute": "ciphers",
      "url": "https://developer.signalwire.com/rest/signalwire-rest/overview/error-codes#invalid_parameter"
    }
  ]
}

Loading...