fetchRecordingAddOnResult
Fetch an instance of an AddOnResult
Details
- Method:
GET - Path:
/2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json - Operation ID:
FetchRecordingAddOnResult
Parameters
{
"AccountSid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch.",
"required": true,
"location": "path",
"type": "string"
},
"ReferenceSid": {
"description": "The SID of the recording to which the result to fetch belongs.",
"required": true,
"location": "path",
"type": "string"
},
"Sid": {
"description": "The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch.",
"required": true,
"location": "path",
"type": "string"
}
}Response Schema
{
"type": "object",
"properties": {
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^XR[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that that we created to identify the Recording AddOnResult resource."
},
"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 resource."
},
"status": {
"type": "string",
"enum": [
"canceled",
"completed",
"deleted",
"failed",
"in-progress",
"init",
"processing",
"queued"
],
"description": "The status of the result. Can be: `canceled`, `completed`, `deleted`, `failed`, `in-progress`, `init`, `processing`, `queued`."
},
"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."
},
"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."
},
"date_completed": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in GMT that the result was completed 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 belongs."
},
"subresource_uris": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "A list of related resources identified by their relative URIs."
}
}
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('twilio')
# Call this tool
result = await agent.call_tool('fetchRecordingAddOnResult', {
# Add required parameters here
})