On this page

Recording Add-on Results Payloads Data Subresource

This subresource of the Recording Add-on Results Payloads subresource allows Recording Add-on Listing users to fetch or list the Data associated with a specific Recording Add-on Result Payload. The response includes a 307 redirect to a signed URL where the Data can be downloaded.

(warning)

Warning

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

Data Properties

Property nameTypeRequiredDescriptionChild properties

redirect_tostring<uri>Optional

Not PII

The URL to redirect to to get the data returned by the AddOn that was previously stored.

Fetch Data

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{PayloadSid}/Data.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

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

Fetch a data

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 fetchRecordingAddOnResultPayloadData() {
11  const data = await client
12    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .data()
16    .fetch();
17
18  console.log(data.redirectTo);
19}
20
21fetchRecordingAddOnResultPayloadData();

Output

1{
2  "redirect_to": "http://example.com"
3}

List all Data

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{PayloadSid}/Data.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

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

List multiple datas

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 fetchRecordingAddOnResultPayloadData() {
11  const data = await client
12    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
15    .data()
16    .fetch();
17
18  console.log(data.redirectTo);
19}
20
21fetchRecordingAddOnResultPayloadData();

Output

1{
2  "redirect_to": "http://example.com"
3}