On this page

Recording Add-on Results Payloads Subresource

This subresource of the Recording Add-on Results resource allows Recording Add-on Listing users to fetch a Payload, view a list of Payloads, or delete Payloads associated with a specific Recording Add-on Result.

(warning)

Warning

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

Payload Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<XH>Optional

Not PII

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

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

add_on_result_sidSID<XR>Optional

Not PII

The SID of the AddOnResult to which the payload belongs.

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

account_sidSID<AC>Optional

Not PII

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

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

labelstringOptional

Not PII

The string provided by the vendor that describes the payload.

add_on_sidSID<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

add_on_configuration_sidSID<XE>Optional

Not PII

The SID of the Add-on configuration.

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

content_typestringOptional

Not PII

The MIME type of the payload.

date_createdstring<date-time-rfc-2822>Optional

Not PII

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring<date-time-rfc-2822>Optional

Not PII

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

reference_sidSID<RE>Optional

Not PII

The SID of the recording to which the AddOnResult resource that contains the payload belongs.

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

subresource_urisobject<uri-map>Optional

Not PII

A list of related resources identified by their relative URIs.

Fetch an instance of a result payload

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Recording AddOnResult Payload 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 AddOnResult resource that contains the payload to fetch belongs.

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

AddOnResultSidSID<XR>required

Not PII

The SID of the AddOnResult to which the payload to fetch belongs.

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

SidSID<XH>required

Not PII

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

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

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

Fetch a Payload

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchRecordingAddOnResultPayload() {
11  const payload = await client
12    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .fetch();
16
17  console.log(payload.sid);
18}
19
20fetchRecordingAddOnResultPayload();

Output

1{
2  "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6  "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8  "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9  "content_type": "application/json",
10  "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
11  "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
12  "subresource_uris": {
13    "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json"
14  }
15}

Retrieve a list of payloads belonging to the AddOnResult

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Recording AddOnResult Payload 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 AddOnResult resource that contains the payloads to read belongs.

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

AddOnResultSidSID<XR>required

Not PII

The SID of the AddOnResult to which the payloads to read belongs.

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

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

Not PII

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

Minimum: 1Maximum: 1000

PageintegerOptional

Not PII

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

Minimum: 0

PageTokenstringOptional

Not PII

The page token. This is provided by the API.

This endpoint returns all Payloads associated with a given Result.

List multiple Payloads

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listRecordingAddOnResultPayload() {
11  const payloads = await client
12    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .payloads.list({ limit: 20 });
15
16  payloads.forEach((p) => console.log(p.sid));
17}
18
19listRecordingAddOnResultPayload();

Output

1{
2  "end": 0,
3  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
4  "next_page_uri": null,
5  "page": 0,
6  "page_size": 50,
7  "previous_page_uri": null,
8  "payloads": [
9    {
10      "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11      "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12      "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13      "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16      "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
17      "content_type": "application/json",
18      "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
19      "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
20      "subresource_uris": {
21        "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json"
22      }
23    }
24  ],
25  "start": 0,
26  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0"
27}

Delete a payload from the result along with all associated Data

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json

Path parameters

Property nameTypeRequiredPIIDescription

AccountSidSID<AC>required

Not PII

The SID of the Account that created the Recording AddOnResult Payload 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 AddOnResult resource that contains the payloads to delete belongs.

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

AddOnResultSidSID<XR>required

Not PII

The SID of the AddOnResult to which the payloads to delete belongs.

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

SidSID<XH>required

Not PII

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

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

This endpoint deletes a given Payload associated with a given Result.

Delete a Payload

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteRecordingAddOnResultPayload() {
11  await client
12    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .remove();
16}
17
18deleteRecordingAddOnResultPayload();