Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Page tools
On this page
Looking for more inspiration?Visit the

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

payload-properties page anchor
Property nameTypeRequiredPIIDescriptionChild properties
endinteger

Optional

Not PII
firstPageUristring<uri>

Optional

Not PII
nextPageUristring<uri>

Optional

Not PII
pageinteger

Optional

Not PII
pageSizeinteger

Optional

Not PII
previousPageUristring<uri>

Optional

Not PII
startinteger

Optional

Not PII
uristring<uri>

Optional

Not PII
payloadsarray[object]

Optional

Not PII

Fetch an instance of a result payload

fetch-an-instance-of-a-result-payload page anchor

GET https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{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 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 an instance of a result payloadLink to code sample: Fetch an instance of a result payload
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 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


20
fetchRecordingAddOnResultPayload();

Response

Note about this response
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

retrieve-a-list-of-payloads-belonging-to-the-addonresult page anchor

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

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 Payloads associated with a given Result.

Retrieve a list of payloads belonging to the AddOnResultLink to code sample: Retrieve a list of payloads belonging to the 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 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.end));

17
}

18


19
listRecordingAddOnResultPayload();

Response

Note about this response
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-a-payload-from-the-result-along-with-all-associated-data page anchor

DELETE https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{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 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 from the result along with all associated DataLink to code sample: Delete a payload from the result along with all associated Data
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 deleteRecordingAddOnResultPayload() {

11
  await client

12
    .recordings("REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

13
    .addOnResults("XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

14
    .payloads("XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")

15
    .remove();

16
}

17


18
deleteRecordingAddOnResultPayload();