XML Translator Connection Authentication V1

XML Call Control Authentication operations for connections

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

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

Request Body schema: application/json
required

XML Translator details

xml_request_url
required
string

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: "post"

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

Responses
200

XML Translator 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_xml_authentication
Request samples
application/json
{
  • "xml_request_url": "string",
  • "xml_failover_url": "string",
  • "xml_request_method": "post"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}

Update XML Translator settings for a connection

BETA: Updates the connection XML Translator 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 TeXML App (formerly connection) whose XML Translator settings are to be updated

Request Body schema: application/json
required

XML Translator details

xml_request_url
required
string

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: "post"

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

Responses
200

XML Translator 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_xml_authentication
Request samples
application/json
{
  • "xml_request_url": "string",
  • "xml_failover_url": "string",
  • "xml_request_method": "post"
}
Response samples
application/json
{
  • "success": true,
  • "message": "string",
  • "reasons": {
    • "property1": [
      • "string"
      ],
    • "property2": [
      • "string"
      ]
    }
}