Skip to main content

Set a connection to use call control authentication

POST 
/security/connections/:connection_id/call_control_authentication

Sets the authentication method of a connection and associates the call control settings. This will remove any other authentication type set for the connection.

Request

Path Parameters

    connection_id stringrequired

    ID of the Call Control App (formerly ID of the connection) which you will set to use this type of authentication

Body

required

Call Control details

    webhook_url stringrequired

    URL to which Telnyx will deliver your Call Control webhooks

    failover_url string

    URL to which Telnyx will deliver your Call Control webhooks if we get an error response from your webhook_url

    hangup_on_timeout boolean

    If true, Telnyx will hang up the call after the timeout specified by the call_control_timeout parameter

    call_control_timeout integer

    The number of seconds Telnyx should wait before hanging up a call when hangup_on_timeout is set to true

Responses

200: Call Control Authentication creation response

400: Bad Request

401: Unauthorized

404: Record Not Found

Request samples


curl -L 'https://api.telnyx.com/security/connections/:connection_id/call_control_authentication' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"webhook_url": "string",
"failover_url": "string",
"hangup_on_timeout": true,
"call_control_timeout": 0
}'

Response samples


{
"success": true,
"message": "string",
"reasons": {}
}