Skip to main content

Update call

POST 
/texml/Accounts/:account_sid/Calls/:call_sid

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

Request ​

Path Parameters

    call_sid stringrequired

    The CallSid that identifies the call to update.

    account_sid stringrequired

    The id of the account the resource belongs to.

Body

required

Update Call request object

    Status string

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

    Url string

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

    Method string

    Possible values: [GET, POST]

    HTTP request type used for Url.

    FallbackUrl string

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

    FallbackMethod string

    Possible values: [GET, POST]

    HTTP request type used for FallbackUrl.

    StatusCallback string

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

    StatusCallbackMethod string

    Possible values: [GET, POST]

    HTTP request type used for StatusCallback.

    Texml string

    TeXML to replace the current one with.

Responses ​

200: Call resource.

Schema

    account_sid string

    The id of the account the resource belongs to.

    answered_by string

    Possible values: [human, machine, not_sure]

    The value of the answering machine detection result, if this feature was enabled for the call.

    caller_name string

    Caller ID, if present.

    date_created string

    The timestamp of when the resource was created.

    date_updated string

    The timestamp of when the resource was last updated.

    direction string

    Possible values: [inbound, outbound]

    The direction of this call.

    duration string

    The duration of this call, given in seconds.

    end_time string

    The end time of this call.

    from string

    The phone number or SIP address that made this call.

    from_formatted string

    The from number formatted for display.

    price string

    The price of this call, the currency is specified in the price_unit field. Only populated when the call cost feature is enabled for the account.

    price_unit string

    The unit in which the price is given.

    sid string

    The identifier of this call.

    start_time string

    The start time of this call.

    status string

    Possible values: [ringing, in-progress, canceled, completed, failed, busy, no-answer]

    The status of this call.

    to string

    The phone number or SIP address that received this call.

    to_formatted string

    The to number formatted for display.

    uri string

    The relative URI for this call.

Request samples

curl -L -X POST 'https://api.telnyx.com/v2/texml/Accounts/:account_sid/Calls/:call_sid' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

{
  "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  "answered_by": null,
  "caller_name": "+13122010094",
  "date_created": "Thu, 15 Jun 2023 09:56:45 +0000",
  "date_updated": "Thu, 15 Jun 2023 09:56:56 +0000",
  "direction": "inbound",
  "duration": "11",
  "end_time": "Thu, 15 Jun 2023 09:56:56 +0000",
  "from": "+13123456789",
  "from_formatted": "(312) 345-6789",
  "price": null,
  "price_unit": null,
  "sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  "start_time": "Thu, 15 Jun 2023 09:56:45 +0000",
  "status": "completed",
  "to": "+13987654321",
  "to_formatted": "(398) 765-4321",
  "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA.json"
}