Skip to main content

Set a connection to use XML Translator authentication

POST 
/security/connections/:connection_id/call_control_xml_authentication

BETA: 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 TeXML App (formerly connection) which you will set to use this type of authentication

Body

required

XML Translator details

    xml_request_url stringrequired

    URL to which Telnyx will deliver your XML Translator webhooks

    xml_failover_url string

    URL to which Telnyx will deliver your XML Translator webhooks if we get an error response from your xml_request_url

    xml_request_method string

    Default value: post

    Method Telnyx will use to interact with your XML Translator webhooks. Either 'get' or 'post'.

Responses ​

200: XML Translator Authentication creation response

Schema

    success booleanrequired
    message stringrequired

    reasons

    object

    property name*

    string[]

  • Array [

    • string

  • ]

400: Bad Request

401: Unauthorized

404: Record Not Found

Request samples

curl -L 'https://api.telnyx.com/security/connections/:connection_id/call_control_xml_authentication' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
  "xml_request_url": "string",
  "xml_failover_url": "string",
  "xml_request_method": "post"
}'

Response samples

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