TeXML Twilio-compatible REST Commands

TeXML Twilio-compatible REST Commands

Fetch a call

Returns an individual call identified by its CallSid. This endpoint is eventually consistent.

SecuritybearerAuth
Request
path Parameters
call_sid
required
string (CallControlId)

The CallSid that identifies the call resource.

Example: v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
account_sid
required
string (AccountSid)

The id of the account the resource belongs to.

Example: 61bf923e-5e4d-4595-a110-56190ea18a1b
Responses
200

Call resource.

Response Schema: application/json
object (Call resource)
account_sid
string

The id of the account the resource belongs to.

answered_by
string

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

Enum: "human" "machine" "not_sure"
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

The direction of this call.

Enum: "inbound" "outbound"
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

The status of this call.

Enum: "ringing" "in-progress" "canceled" "completed" "failed" "busy" "no-answer"
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.

404

Conference does not exist

get/texml/Accounts/{account_sid}/Calls/{call_sid}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "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"
    }
}
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 (CallControlId) 
The CallSid that identifies the call resource.


 
 Example:  v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
Request Body schema: application/json
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
HTTP request type used for Url.


 Enum: "GET" "POST"  
FallbackUrl
string
A failover URL for which Telnyx will retrieve the TeXML call instructions if the Url is not responding.


 
FallbackMethod
string
HTTP request type used for FallbackUrl.


 Enum: "GET" "POST"  
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.


 
Responses 
200
Call resource.


Response Schema: application/json
object (Call resource) 
 
account_sid
string
The id of the account the resource belongs to.


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


 Enum: "human" "machine" "not_sure"  
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
The direction of this call.


 Enum: "inbound" "outbound"  
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
The status of this call.


 Enum: "ringing" "in-progress" "canceled" "completed" "failed" "busy" "no-answer"  
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.


 
post/texml/Accounts/{account_sid}/Calls/{call_sid}
Request samples 
application/json
{
  • "Status": "completed"
}
Response samples 
application/json
{
  • "data": {
    • "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"
    }
}
Fetch multiple call resources
Returns multiple call resouces for an account. This endpoint is eventually consistent.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
query Parameters
Page
integer
The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.


 
 Example:  Page=1
PageSize
integer
The number of records to be displayed on a page


 
 Example:  PageSize=10
PageToken
string
Used to request the next page of results.


 
To
string
Filters calls by the to number.


 
 Example:  To=+1312345678
From
string
Filters calls by the from number.


 
 Example:  From=+1312345678
Status
string
Filters calls by status.


 Enum: "canceled" "completed" "failed" "busy" "no-answer"  
 Example:  Status=no-answer
StartTime
string
Filters calls by the start date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. StartTime>=2023-05-22.


 
 Example:  StartTime=>=2023-05-22
EndTime
string
Filters calls by their end date. Expected format is YYYY-MM-DD. Also accepts inequality operators, e.g. EndTime>=2023-05-22.


 
 Example:  EndTime=>=2023-05-22
Responses 
200
Multiple call resources.


Response Schema: application/json
object (Multiple call resources) 
 
Array of objects (Call resource) 
 
end
integer
The number of the last element on the page, zero-indexed.


 
first_page_uri
string
/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1


 
next_page_uri
string
/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ


 
page
integer
Current page number, zero-indexed.


 
page_size
integer
The number of items on the page


 
start
integer
The number of the first element on the page, zero-indexed.


 
uri
string
The URI of the current page.


 
404
Conference does not exist


get/texml/Accounts/{account_sid}/Calls
Request samples 
Response samples 
application/json
{
  • "data": {
    • "calls": [ ],
    • "end": 0,
    • "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1",
    • "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1&PageToken=MTY4AjgyNDkwNzIxMQ",
    • "page": 0,
    • "page_size": 1,
    • "start": 0,
    • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=0&PageSize=1"
    }
}
Fetch multiple recording resources
Returns multiple recording resources for an account.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
query Parameters
Page
integer
The number of the page to be displayed, zero-indexed, should be used in conjuction with PageToken.


 
 Example:  Page=1
PageSize
integer
The number of records to be displayed on a page


 
 Example:  PageSize=10
DateCreated
string <datetime-iso8601> 
Filters recording by the creation date. Expected format is ISO8601 date or date-time, ie.  {YYYY}-{MM}-{DD} or {YYYY}-{MM}-{DD}T{hh}:{mm}:{ss}Z. Also accepts inequality operators, e.g. DateCreated>=2023-05-22.


 
 Example:  DateCreated=2023-05-22
Responses 
200
Successful Get Call Recordings Response


Response Schema: application/json
Array of objects (Texml Get Call Recording Response Body) 
 
end
integer
The number of the last element on the page, zero-indexed.


 
first_page_uri
string <uri> 
Relative uri to the first page of the query results


 
previous_page_uri
string <uri> 
Relative uri to the previous page of the query results


 
next_page_uri
string
Relative uri to the next page of the query results


 
page
integer
Current page number, zero-indexed.


 
page_size
integer
The number of items on the page


 
start
integer
The number of the first element on the page, zero-indexed.


 
uri
string
The URI of the current page.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/texml/Accounts/{account_sid}/Recordings.json
Request samples 
Response samples 
application/json
{
  • "recordings": [
    • {
      • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
      • "channels": 1,
      • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "duration": "12",
      • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      • "source": "StartCallRecordingAPI",
      • "status": "paused",
      • "error_code": null,
      • "subresources_uris": {
        • "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
        },
      • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
      • "media_url": "http://recordings.com/mp3/filename.mp3"
      }
    ],
  • "end": 19,
  • "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "previous_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1",
  • "page": 0,
  • "page_size": 20,
  • "start": 0,
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1"
}
Fetch recording resource
Returns recording resource identified by recording id.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
recording_id
required
string <uuid> 
Uniquely identifies the recording by id.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
200
Retrieves call recording resource.


Response Schema: application/json
account_sid
string (AccountSid) 
 
call_sid
string (CallControlId) 
 
conference_sid
string or null <uuid>  (ConferenceSid) 
 
channels
integer (TwimlRecordingChannels) 
 Default:  2
 Enum: 1 2  
date_created
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
date_updated
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
start_time
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
duration
string or null (TexmlRecordingDuration) 
The duration of this recording, given in seconds.


 
sid
string (TexmlSid) 
Identifier of a resource.


 
source
string (RecordingSource) 
Defines how the recording was created.


 Enum: "StartCallRecordingAPI" "StartConferenceRecordingAPI" "OutboundAPI" "DialVerb" "Conference" "RecordVerb" "Trunking"  
status
string (TexmlRecordingStatus) 
 Enum: "in-progress" "completed" "paused" "stopped"  
error_code
string or null (TexmlErrorCode) 
 
object (Texml recording subresources uris) 
Subresources details for a recording if available.


 
uri
string
The relative URI for this recording resource.


 
media_url
string <uri>  (TexmlRecordingMediaUrl) 
 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
Request samples 
Response samples 
application/json
{
  • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
  • "channels": 1,
  • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "duration": "12",
  • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
  • "source": "StartCallRecordingAPI",
  • "status": "paused",
  • "error_code": null,
  • "subresources_uris": {
    • "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
    },
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
  • "media_url": "http://recordings.com/mp3/filename.mp3"
}
Delete recording resource
Deletes recording resource identified by recording id.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
recording_id
required
string <uuid> 
Uniquely identifies the recording by id.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Responses 
204
The resource was deleted successfully.


404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
delete/texml/Accounts/{account_sid}/Recordings/{recording_sid}.json
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "title": "string",
  • "detail": "string",
  • "source": {
    • "pointer": "/json/pointer",
    • "parameter": "string"
    },
  • "meta": { }
}
Request recording for a call
Starts recording with specified parameters for call idientified by call_sid.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
call_sid
required
string (CallControlId) 
The CallSid that identifies the call resource.


 
 Example:  v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
Request Body schema: application/x-www-form-urlencoded
Starts call recording on a call.


RecordingStatusCallbackEvent
string (RecordingStatusCallbackEvent) 
 Default:  "completed"
Recording status callback event types.


 Enum: "in-progress" "completed" "absent"  
RecordingStatusCallback
string <uri>  (TexmlStatusCallback) 
Url where status callbacks will be sent.


 
RecordingStatusCallbackMethod
string (TexmlStatusCallbackMethod) 
 Default:  "POST"
HTTP method used to send status callbacks.


 Enum: "GET" "POST"  
RecordingChannels
string (TexmlRecordingChannels) 
 Default:  "dual"
When dual, final audio file has the first leg on channel A, and the rest on channel B. mono mixes both tracks into a single channel.


 Enum: "mono" "dual"  
RecordingTrack
string (RecordingTrack) 
 Default:  "both"
The audio track to be recorded.


 Enum: "inbound" "outbound" "both"  
Responses 
200
Successful call recording create response


Response Schema: application/json
account_sid
string (AccountSid) 
 
call_sid
string (CallControlId) 
 
conference_sid
string or null <uuid>  (ConferenceSid) 
 
channels
integer (TwimlRecordingChannels) 
 Default:  2
 Enum: 1 2  
date_created
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
date_updated
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
start_time
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
duration
string or null (TexmlRecordingDuration) 
The duration of this recording, given in seconds.


 
sid
string (TexmlSid) 
Identifier of a resource.


 
source
string (RecordingSource) 
Defines how the recording was created.


 Enum: "StartCallRecordingAPI" "StartConferenceRecordingAPI" "OutboundAPI" "DialVerb" "Conference" "RecordVerb" "Trunking"  
error_code
string or null (TexmlErrorCode) 
 
track
string (RecordingTrack) 
 Default:  "both"
The audio track to be recorded.


 Enum: "inbound" "outbound" "both"  
uri
string
The relative URI for this recording resource.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
Request samples 
application/x-www-form-urlencoded
RecordingStatusCallbackEvent=in-progress&RecordingStatusCallback=http%3A%2F%2Fwebhook.com%2Fcallback&RecordingStatusCallbackMethod=GET&RecordingChannels=mono&RecordingTrack=inbound
Response samples 
application/json
{
  • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
  • "channels": 1,
  • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "duration": "12",
  • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
  • "source": "StartCallRecordingAPI",
  • "error_code": null,
  • "track": "inbound",
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json"
}
Fetch recordings for a call
Returns recordings for a call identified by call_sid.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
call_sid
required
string (CallControlId) 
The CallSid that identifies the call resource.


 
 Example:  v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
Responses 
200
Successful Get Call Recordings Response


Response Schema: application/json
Array of objects (Texml Get Call Recording Response Body) 
 
end
integer
The number of the last element on the page, zero-indexed.


 
first_page_uri
string <uri> 
Relative uri to the first page of the query results


 
previous_page_uri
string <uri> 
Relative uri to the previous page of the query results


 
next_page_uri
string
Relative uri to the next page of the query results


 
page
integer
Current page number, zero-indexed.


 
page_size
integer
The number of items on the page


 
start
integer
The number of the first element on the page, zero-indexed.


 
uri
string
The URI of the current page.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json
Request samples 
Response samples 
application/json
{
  • "recordings": [
    • {
      • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
      • "channels": 1,
      • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "duration": "12",
      • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      • "source": "StartCallRecordingAPI",
      • "status": "paused",
      • "error_code": null,
      • "subresources_uris": {
        • "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
        },
      • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
      • "media_url": "http://recordings.com/mp3/filename.mp3"
      }
    ],
  • "end": 19,
  • "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "previous_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1",
  • "page": 0,
  • "page_size": 20,
  • "start": 0,
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1"
}
Update recording on a call
Updates recording resource for particular call.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
call_sid
required
string (CallControlId) 
The CallSid that identifies the call resource.


 
 Example:  v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA
recording_id
required
string <uuid> 
Uniquely identifies the recording by id.


 
 Example:  6a09cdc3-8948-47f0-aa62-74ac943d6c58
Request Body schema: application/x-www-form-urlencoded
Update call recording on a call.


Status
string
 Enum: "in-progress" "paused" "stopped"  
Responses 
200
Successful call recording create response


Response Schema: application/json
account_sid
string (AccountSid) 
 
call_sid
string (CallControlId) 
 
conference_sid
string or null <uuid>  (ConferenceSid) 
 
channels
integer (TwimlRecordingChannels) 
 Default:  2
 Enum: 1 2  
date_created
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
date_updated
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
start_time
string <datetime-rfc2822>  (DateTimeRFC2822) 
 
duration
string or null (TexmlRecordingDuration) 
The duration of this recording, given in seconds.


 
sid
string (TexmlSid) 
Identifier of a resource.


 
source
string (RecordingSource) 
Defines how the recording was created.


 Enum: "StartCallRecordingAPI" "StartConferenceRecordingAPI" "OutboundAPI" "DialVerb" "Conference" "RecordVerb" "Trunking"  
error_code
string or null (TexmlErrorCode) 
 
track
string (RecordingTrack) 
 Default:  "both"
The audio track to be recorded.


 Enum: "inbound" "outbound" "both"  
uri
string
The relative URI for this recording resource.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
post/texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json
Request samples 
application/x-www-form-urlencoded
Status=paused
Response samples 
application/json
{
  • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
  • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
  • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
  • "channels": 1,
  • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
  • "duration": "12",
  • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
  • "source": "StartCallRecordingAPI",
  • "error_code": null,
  • "track": "inbound",
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls/v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json"
}
Fetch recordings for a conference
Returns recordings for a conference identified by conference_sid.


SecuritybearerAuth 
Request 
path Parameters
account_sid
required
string (AccountSid) 
The id of the account the resource belongs to.


 
 Example:  61bf923e-5e4d-4595-a110-56190ea18a1b
conference_sid
required
string or null <uuid>  (ConferenceSid) 
The ConferenceSid that identifies the conference resource.


 
 Example:  673611c9-3f0d-4b78-81ca-1a90840d9c88
Responses 
200
Successful Get Call Recordings Response


Response Schema: application/json
Array of objects (Texml Get Call Recording Response Body) 
 
end
integer
The number of the last element on the page, zero-indexed.


 
first_page_uri
string <uri> 
Relative uri to the first page of the query results


 
previous_page_uri
string <uri> 
Relative uri to the previous page of the query results


 
next_page_uri
string
Relative uri to the next page of the query results


 
page
integer
Current page number, zero-indexed.


 
page_size
integer
The number of items on the page


 
start
integer
The number of the first element on the page, zero-indexed.


 
uri
string
The URI of the current page.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
title
required
string
 
detail
string
 
object
 
meta
object
 
get/texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json
Request samples 
Response samples 
application/json
{
  • "recordings": [
    • {
      • "account_sid": "61bf923e-5e4d-4595-a110-56190ea18a1b",
      • "call_sid": "v3:KBnLO0ZK3DhKM5s7bE9VluaSmKsOchKht_fUYvxcp8ysbmzCCtpkmA",
      • "conference_sid": "673611c9-3f0d-4b78-81ca-1a90840d9c88",
      • "channels": 1,
      • "date_created": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "date_updated": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "start_time": "Fri, 11 Aug 2023 19:12:11 +0000",
      • "duration": "12",
      • "sid": "e9cea0be-7dbd-4b98-98b1-c0089d9d43b0",
      • "source": "StartCallRecordingAPI",
      • "status": "paused",
      • "error_code": null,
      • "subresources_uris": {
        • "transcriptions": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac/Transcriptions.json"
        },
      • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings/b08f0fa1-a32c-4218-b3b5-9cf78941ccac.json",
      • "media_url": "http://recordings.com/mp3/filename.mp3"
      }
    ],
  • "end": 19,
  • "first_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "previous_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1",
  • "next_page_uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Calls.json?Page=1&PageSize=1",
  • "page": 0,
  • "page_size": 20,
  • "start": 0,
  • "uri": "/v2/texml/Accounts/61bf923e-5e4d-4595-a110-56190ea18a1b/Recordings.json?Page=0&PageSize=1"
}