Skip to main content

Create Subscriber SIP Endpoint

POST 
/resources/subscribers/:fabric_subscriber_id/sip_endpoints

Creates a Subscriber Sip Endpoint

Request​

Path Parameters

    fabric_subscriber_id uuidrequired

    Unique ID of a Fabric Subscriber.

Body

required

    oneOf

    call_handler CallHandlerPassthroughType (string)

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

    Call handler of the Sip Endpoint.

    username stringrequired

    Username of the Sip Endpoint.

    password stringrequired

    Password of the Sip Endpoint.

    password_confirmation stringrequired

    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​

The request has succeeded and a new resource has been created as a result.

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.

Loading...