Call Control Authentication for Connections V1

Call Control Authentication operations for connections

Set a connection to use 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
required
string

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

Request Body schema: application/json
required

Call Control details

webhook_url
required
string

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

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

post/security/connections/{connection_id}/call_control_authentication
Request samples
application/json
{
  • "webhook_url": "string",
  • "failover_url": "string",
  • "hangup_on_timeout": true,
  • "call_control_timeout": 0
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}

Update call control settings for a connection

Updates the connection call control settings with the values of the parameters passed. Any parameters not included in the request will be left unchanged.

Request
path Parameters
connection_id
required
string

ID of the Call Control App (formerly ID of the connection) whose call control settings are to be updated

Request Body schema: application/json
required

Call Control details

webhook_url
required
string

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 update response

Response Schema: application/json
success
required
boolean
message
required
string
object
400

Bad Request

401

Unauthorized

404

Record Not Found

put/security/connections/{connection_id}/call_control_authentication
Request samples
application/json
{
  • "webhook_url": "string",
  • "failover_url": "string",
  • "hangup_on_timeout": true,
  • "call_control_timeout": 0
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}