Skip to contentSkip to navigationSkip to topbar
Twilio Docs
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
accountSidSID<AC>

Optional

Not PII

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

Not PII

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

Possible values:
canceledcompleteddeletedfailedin-progressinitprocessingqueued
addOnSidSID<XB>

Optional

Not PII

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

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

Optional

Not PII

The SID of the Add-on configuration.

Pattern: ^XE[0-9a-fA-F]{32}$Min length: 34Max length: 34
dateCreatedstring<date-time-rfc-2822>

Optional

Not PII

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

dateUpdatedstring<date-time-rfc-2822>

Optional

Not PII

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

dateCompletedstring<date-time-rfc-2822>

Optional

Not PII

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

referenceSidSID<RE>

Optional

Not PII

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

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

Optional

Not PII

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
Not PII

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
Not PII

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
Not PII

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 AddOnResultLink to code sample: Fetch an AddOnResult
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function fetchRecordingAddOnResult() {

11
  const addOnResult = await client

12
    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

14
    .fetch();

15


16
  console.log(addOnResult.sid);

17
}

18


19
fetchRecordingAddOnResult();

Response

1
{

2
  "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

3
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

4
  "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

5
  "status": "completed",

6
  "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

7
  "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

8
  "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",

9
  "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",

10
  "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000",

11
  "subresource_uris": {

12
    "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json"

13
  }

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

Path parameters

path-parameters-1 page anchor
Property nameTypeRequiredPIIDescription
accountSidSID<AC>
required
Not PII

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
Not PII

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

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

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
pageSizeinteger<int64>

Optional

Not PII

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

Minimum: 1Maximum: 1000
pageinteger

Optional

Not PII

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

Minimum: 0
pageTokenstring

Optional

Not PII

The page token. This is provided by the API.

This endpoint returns all Results associated with a given Recording.

List multiple AddOnResultsLink to code sample: List multiple AddOnResults
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function listRecordingAddOnResult() {

11
  const addOnResults = await client

12
    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .addOnResults.list({ limit: 20 });

14


15
  addOnResults.forEach((a) => console.log(a.sid));

16
}

17


18
listRecordingAddOnResult();

Response

1
{

2
  "end": 0,

3
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults.json?PageSize=50&Page=0",

4
  "next_page_uri": null,

5
  "page": 0,

6
  "page_size": 50,

7
  "previous_page_uri": null,

8
  "add_on_results": [

9
    {

10
      "sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

11
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

12
      "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

13
      "status": "completed",

14
      "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

15
      "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",

16
      "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",

17
      "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",

18
      "date_completed": "Wed, 01 Sep 2010 15:15:41 +0000",

19
      "subresource_uris": {

20
        "payloads": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json"

21
      }

22
    }

23
  ],

24
  "start": 0,

25
  "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

Path parameters

path-parameters-2 page anchor
Property nameTypeRequiredPIIDescription
accountSidSID<AC>
required
Not PII

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
Not PII

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
Not PII

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.

Delete an AddOnResultLink to code sample: Delete an AddOnResult
1
// Download the helper library from https://www.twilio.com/docs/node/install

2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";

3


4
// Find your Account SID and Auth Token at twilio.com/console

5
// and set the environment variables. See http://twil.io/secure

6
const accountSid = process.env.TWILIO_ACCOUNT_SID;

7
const authToken = process.env.TWILIO_AUTH_TOKEN;

8
const client = twilio(accountSid, authToken);

9


10
async function deleteRecordingAddOnResult() {

11
  await client

12
    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

14
    .remove();

15
}

16


17
deleteRecordingAddOnResult();