listRecordingTranscription
References to text transcriptions of call recordings
Details
- Method:
GET - Path:
/2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json - Operation ID:
ListRecordingTranscription
Parameters
{
"AccountSid": {
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read.",
"required": true,
"location": "path",
"type": "string"
},
"RecordingSid": {
"description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcriptions to read.",
"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": "ListRecordingTranscriptionResponse",
"type": "object",
"properties": {
"transcriptions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"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 Transcription resource."
},
"api_version": {
"type": "string",
"nullable": true,
"description": "The API version used to create the transcription."
},
"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."
},
"duration": {
"type": "string",
"nullable": true,
"description": "The duration of the transcribed audio in seconds."
},
"price": {
"type": "number",
"nullable": true,
"description": "The charge for the transcript in the currency associated with the account. This value is populated after the transcript is complete so it may not be available immediately."
},
"price_unit": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "The currency in which `price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`)."
},
"recording_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^RE[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) from which the transcription was created."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^TR[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that that we created to identify the Transcription resource."
},
"status": {
"type": "string",
"enum": [
"in-progress",
"completed",
"failed"
],
"description": "The status of the transcription. Can be: `in-progress`, `completed`, `failed`."
},
"transcription_text": {
"type": "string",
"nullable": true,
"description": "The text content of the transcription.",
"x-twilio": {
"pii": {
"handling": "sensitive",
"deleteSla": 30
}
}
},
"type": {
"type": "string",
"nullable": true,
"description": "The transcription type."
},
"uri": {
"type": "string",
"nullable": true,
"description": "The URI of the resource, relative to `https://api.twilio.com`."
}
}
}
},
"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('listRecordingTranscription', {
# Add required parameters here
})