Retrieve a list of payloads belonging to the AddOnResult

GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json

A single Add-on results' payload

Retrieve a list of payloads belonging to the AddOnResult

Path parameters

  • AccountSid string Required

    The SID of the Account that created the Recording AddOnResult Payload resources to read.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

  • ReferenceSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RE[0-9a-fA-F]{32}$.

  • AddOnResultSid string Required

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

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XR[0-9a-fA-F]{32}$.

Query parameters

  • PageSize integer(int64)

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

    Minimum value is 1, maximum value is 1000.

  • Page integer

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

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • payloads array[object]
      Hide payloads attributes Show payloads attributes object
      • sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XH[0-9a-fA-F]{32}$.

      • add_on_result_sid string | null

        The SID of the AddOnResult to which the payload belongs.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XR[0-9a-fA-F]{32}$.

      • account_sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

      • label string | null

        The string provided by the vendor that describes the payload.

      • add_on_sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XB[0-9a-fA-F]{32}$.

      • add_on_configuration_sid string | null

        The SID of the Add-on configuration.

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^XE[0-9a-fA-F]{32}$.

      • content_type string | null

        The MIME type of the payload.

      • date_created string(date-time-rfc-2822) | null

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

      • date_updated string(date-time-rfc-2822) | null

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

      • reference_sid string | null

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

        Minimum length is 34, maximum length is 34. Format should match the following pattern: ^RE[0-9a-fA-F]{32}$.

      • subresource_uris object(uri-map) | null

        A list of related resources identified by their relative URIs.

    • end integer
    • first_page_uri string(uri)
    • next_page_uri string(uri) | null
    • page integer
    • page_size integer
    • previous_page_uri string(uri) | null
    • start integer
    • uri string(uri)
GET /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json
curl \
 --request GET 'https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json' \
 --user "username:password"
Response examples (200)
{
  "end": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
  "page": 0,
  "start": 0,
  "payloads": [
    {
      "sid": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "label": "XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "add_on_sid": "XBaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "content_type": "application/json",
      "date_created": "Wed, 01 Sep 2010 15:15:41 +0000",
      "date_updated": "Wed, 01 Sep 2010 15:15:41 +0000",
      "reference_sid": "REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "subresource_uris": {
        "data": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads/XHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Data.json"
      },
      "add_on_result_sid": "XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "add_on_configuration_sid": "XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
    }
  ],
  "page_size": 50,
  "next_page_uri": null,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
  "previous_page_uri": null
}
{
  "end": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
  "page": 0,
  "start": 0,
  "payloads": [],
  "page_size": 50,
  "next_page_uri": null,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Recordings/REaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AddOnResults/XRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payloads.json?PageSize=50&Page=0",
  "previous_page_uri": null
}