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)

    Call handler of the Sip Endpoint.

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

    username stringrequired

    Username of the Sip Endpoint.

    Example: justice-league
    password stringrequired

    Password of the Sip Endpoint.

    Example: hack-me-if-you-can
    password_confirmation stringrequired

    Confirmation of the Password

    Example: hack-me-if-you-can
    caller_id string

    Caller ID of the Sip Endpoint.

    Example: call-id-123
    send_as string

    The Number to send as.

    Example: +14632322867
    ciphers CipherType (string)[]

    Ciphers of the Sip Endpoint.

    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]

    codecs CodecType (string)[]

    Codecs of the Sip Endpoint.

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

    encryption EncryptionType (string)

    Encryption requirement of the Sip Endpoint.

    Possible values: [default, required, optional]

    Default value: default
    Example: optional

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.

    Example: justice-league
    caller_id stringrequired

    Caller ID of the Sip Endpoint.

    Example: call-id-123
    send_as stringrequired

    Purchased or verified number

    Example: +14632322867
    ciphers CipherType (string)[]required

    Ciphers of the Sip Endpoint.

    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]

    codecs CodecType (string)[]required

    Codecs of the Sip Endpoint.

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

    encryption EncryptionType (string)required

    Encryption

    Possible values: [default, required, optional]

    call_handler CallHandlerType (string)required

    Call handler of the Sip Endpoint.

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

    calling_handler_resource_id uuidrequired

    Universal Unique Identifier.