Open Context Protocol is live! 🚀 Read the launch post
listRecordingAddOnResultPayload

listRecordingAddOnResultPayload

Retrieve a list of payloads belonging to the AddOnResult

Details

  • Method: GET
  • Path: /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json
  • Operation ID: ListRecordingAddOnResultPayload

Parameters

{
  "AccountSid": {
    "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "ReferenceSid": {
    "description": "The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "AddOnResultSid": {
    "description": "The SID of the AddOnResult to which the payloads to read belongs.",
    "required": true,
    "location": "path",
    "type": "string"
  },
  "PageSize": {
    "description": "How many resources to return in each list page. The default is 50, and the maximum is 1000.",
    "required": false,
    "location": "query",
    "type": "integer",
    "format": "int64"
  },
  "Page": {
    "description": "The page index. This value is simply for client state.",
    "required": false,
    "location": "query",
    "type": "integer"
  },
  "PageToken": {
    "description": "The page token. This is provided by the API.",
    "required": false,
    "location": "query",
    "type": "string"
  }
}

Response Schema

{
  "title": "ListRecordingAddOnResultPayloadResponse",
  "type": "object",
  "properties": {
    "payloads": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^XH[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The unique string that that we created to identify the Recording AddOnResult Payload resource."
          },
          "add_on_result_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^XR[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the AddOnResult to which the payload belongs."
          },
          "account_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^AC[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource."
          },
          "label": {
            "type": "string",
            "nullable": true,
            "description": "The string provided by the vendor that describes the payload."
          },
          "add_on_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^XB[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the Add-on to which the result belongs."
          },
          "add_on_configuration_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^XE[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the Add-on configuration."
          },
          "content_type": {
            "type": "string",
            "nullable": true,
            "description": "The MIME type of the payload."
          },
          "date_created": {
            "type": "string",
            "format": "date-time-rfc-2822",
            "nullable": true,
            "description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
          },
          "date_updated": {
            "type": "string",
            "format": "date-time-rfc-2822",
            "nullable": true,
            "description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
          },
          "reference_sid": {
            "type": "string",
            "minLength": 34,
            "maxLength": 34,
            "pattern": "^RE[0-9a-fA-F]{32}$",
            "nullable": true,
            "description": "The SID of the recording to which the AddOnResult resource that contains the payload belongs."
          },
          "subresource_uris": {
            "type": "object",
            "format": "uri-map",
            "nullable": true,
            "description": "A list of related resources identified by their relative URIs."
          }
        }
      }
    },
    "end": {
      "type": "integer"
    },
    "first_page_uri": {
      "format": "uri",
      "type": "string"
    },
    "next_page_uri": {
      "format": "uri",
      "nullable": true,
      "type": "string"
    },
    "page": {
      "type": "integer"
    },
    "page_size": {
      "type": "integer"
    },
    "previous_page_uri": {
      "format": "uri",
      "nullable": true,
      "type": "string"
    },
    "start": {
      "type": "integer"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  }
}

Usage

from ocp_agent import OCPAgent

agent = OCPAgent()
await agent.register_api('twilio')

# Call this tool
result = await agent.call_tool('listRecordingAddOnResultPayload', {
    # Add required parameters here
})