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

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


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

Output


_15{
_15  "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_15  "content_type": "application/json",
_15  "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
_15  "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
_15  "subresource_uris": {
_15    "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json"
_15  }
_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

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_19// Download the helper library from https://www.twilio.com/docs/node/install
_19const 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
_19const accountSid = process.env.TWILIO_ACCOUNT_SID;
_19const authToken = process.env.TWILIO_AUTH_TOKEN;
_19const client = twilio(accountSid, authToken);
_19
_19async function listRecordingAddOnResultPayload() {
_19  const payloads = await client
_19    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_19    .payloads.list({ limit: 20 });
_19
_19  payloads.forEach((p) => console.log(p.sid));
_19}
_19
_19listRecordingAddOnResultPayload();

Output


_27{
_27  "end": 0,
_27  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
_27  "next_page_uri": null,
_27  "page": 0,
_27  "page_size": 50,
_27  "previous_page_uri": null,
_27  "payloads": [
_27    {
_27      "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_27      "content_type": "application/json",
_27      "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
_27      "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
_27      "subresource_uris": {
_27        "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json"
_27      }
_27    }
_27  ],
_27  "start": 0,
_27  "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

Node.js

Python

Java

PHP

Ruby

twilio-cli

curl


_18// Download the helper library from https://www.twilio.com/docs/node/install
_18const 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
_18const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18const authToken = process.env.TWILIO_AUTH_TOKEN;
_18const client = twilio(accountSid, authToken);
_18
_18async function deleteRecordingAddOnResultPayload() {
_18  await client
_18    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18    .remove();
_18}
_18
_18deleteRecordingAddOnResultPayload();