Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Recording Add-on Results Resource


This endpoint allows Recording Add-on Listing users to fetch a Result, view a list of Results, or delete Results associated with a specific Recording.

(warning)

Warning

The retention period for Recording Add-on Results is 30 days, after which they cannot be accessed.


AddOnResult Properties

addonresult-properties page anchor
Property nameTypeRequiredDescriptionChild properties
sidSID<XR>Optional
Not PII

The unique string that that we created to identify the Recording AddOnResult resource.

Pattern: ^XR[0-9a-fA-F]{32}$Min length: 34Max length: 34

account_sidSID<AC>Optional

The SID of the Account that created the Recording AddOnResult resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

statusenum<string>Optional

The status of the result. Can be: canceled, completed, deleted, failed, in-progress, init, processing, queued.

Possible values:
canceledcompleteddeletedfailedin-progressinitprocessingqueued

add_on_sidSID<XB>Optional

The SID of the Add-on to which the result belongs.

Pattern: ^XB[0-9a-fA-F]{32}$Min length: 34Max length: 34

add_on_configuration_sidSID<XE>Optional

The SID of the Add-on configuration.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34

date_updatedstring<date-time-rfc-2822>Optional

The date and time in GMT that the resource was last updated specified in RFC 2822(link takes you to an external page) format.


date_completedstring<date-time-rfc-2822>Optional

The date and time in GMT that the result was completed specified in RFC 2822(link takes you to an external page) format.


reference_sidSID<RE>Optional

The SID of the recording to which the AddOnResult resource belongs.

Pattern: ^RE[0-9a-fA-F]{32}$Min length: 34Max length: 34

subresource_urisobject<uri-map>Optional

A list of related resources identified by their relative URIs.


Fetch an instance of an AddOnResult

fetch-an-instance-of-an-addonresult page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

The SID of the Account that created the Recording AddOnResult resource to fetch.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

ReferenceSidSID<RE>required

The SID of the recording to which the result to fetch belongs.

Pattern: ^RE[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<XR>required

The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.

Pattern: ^XR[0-9a-fA-F]{32}$Min length: 34Max length: 34

This endpoint returns details on a given Result associated with a given Recording.

Fetch an AddOnResult

fetch-an-addonresult page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_19
// Download the helper library from https://www.twilio.com/docs/node/install
_19
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_19
_19
// Find your Account SID and Auth Token at twilio.com/console
_19
// and set the environment variables. See http://twil.io/secure
_19
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19
const authToken = process.env.TWILIO_AUTH_TOKEN;
_19
const client = twilio(accountSid, authToken);
_19
_19
async function fetchRecordingAddOnResult() {
_19
const addOnResult = await client
_19
.recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19
.addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19
.fetch();
_19
_19
console.log(addOnResult.sid);
_19
}
_19
_19
fetchRecordingAddOnResult();

Output

_14
{
_14
"sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"status": "completed",
_14
"add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_14
"date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
_14
"date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
_14
"date_completed": "Wed, 01 Sep 2010 15:15:41 +0000",
_14
"subresource_uris": {
_14
"payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json"
_14
}
_14
}


Retrieve a list of results belonging to the recording

retrieve-a-list-of-results-belonging-to-the-recording page anchor
GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

The SID of the Account that created the Recording AddOnResult resources to read.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

ReferenceSidSID<RE>required

The SID of the recording to which the result to read belongs.

Pattern: ^RE[0-9a-fA-F]{32}$Min length: 34Max length: 34
Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000

PageintegerOptional

The page index. This value is simply for client state.

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

This endpoint returns all Results associated with a given Recording.

List multiple AddOnResults

list-multiple-addonresults page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function listRecordingAddOnResult() {
_18
const addOnResults = await client
_18
.recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18
.addOnResults.list({ limit: 20 });
_18
_18
addOnResults.forEach((a) => console.log(a.sid));
_18
}
_18
_18
listRecordingAddOnResult();

Output

_26
{
_26
"end": 0,
_26
"first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0",
_26
"next_page_uri": null,
_26
"page": 0,
_26
"page_size": 50,
_26
"previous_page_uri": null,
_26
"add_on_results": [
_26
{
_26
"sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26
"reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26
"status": "completed",
_26
"add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26
"add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_26
"date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
_26
"date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
_26
"date_completed": "Wed, 01 Sep 2010 15:15:41 +0000",
_26
"subresource_uris": {
_26
"payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json"
_26
}
_26
}
_26
],
_26
"start": 0,
_26
"uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0"
_26
}


Delete a result and purge all associated Payloads

delete-a-result-and-purge-all-associated-payloads page anchor
DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json

Property nameTypeRequiredPIIDescription
AccountSidSID<AC>required

The SID of the Account that created the Recording AddOnResult resources to delete.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

ReferenceSidSID<RE>required

The SID of the recording to which the result to delete belongs.

Pattern: ^RE[0-9a-fA-F]{32}$Min length: 34Max length: 34

SidSID<XR>required

The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete.

Pattern: ^XR[0-9a-fA-F]{32}$Min length: 34Max length: 34

This endpoint deletes a given Result that is associated with a given Recording. All Payloads that are associated with the Result will also be removed.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function deleteRecordingAddOnResult() {
_17
await client
_17
.recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17
.addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_17
.remove();
_17
}
_17
_17
deleteRecordingAddOnResult();


Rate this page: