TeXML REST Commands API

TeXML REST Commands

Update call

Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.

SecuritybearerAuth
Request
path Parameters
call_sid
required
string

The CallSid that identifies the call to update.

Request Body schema: application/json
required

Update Call request object

FallbackMethod
string

HTTP request type used for FallbackUrl.

Enum: "GET" "POST"
FallbackUrl
string

A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding.

Method
string

HTTP request type used for Url.

Enum: "GET" "POST"
Status
string

The value to set the call status to. Setting the status to completed ends the call.

StatusCallback
string

URL destination for Telnyx to send status callback events to for the call.

StatusCallbackMethod
string

HTTP request type used for StatusCallback.

Enum: "GET" "POST"
Texml
string

TeXML to replace the current one with.

Url
string

The URL where TeXML will make a request to retrieve a new set of TeXML instructions to continue the call flow.

Responses
200

Successful response upon updating a TeXml call.

Response Schema: application/json
object (UpdateCommandResult)
sid
string
status
string
post/texml/calls/{call_sid}/update
Request samples
application/json
{
  • "Status": "completed"
}
Response samples
application/json
{
  • "data": {
    • "sid": "c46e06d7-b78f-4b13-96b6-c576af9640ff",
    • "status": "accepted"
    }
}