---
updatedAt: 2026-08-05T23:30:35.000Z
agentTools:
projectIndex: https://docs.talkdesk.com/llms.txt
---
# Get consent recordings for an interaction using a share token
Get consent-type recordings of an interaction using a secure share token. Only consent-type recordings are returned. Designed for third-party systems via OAuth Client Credentials flow with the recordings-consent:read scope.
## Scope
`recordings-consent:read`
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Public API",
"version": "5.12.71",
"description": "Documents public API endpoints. Scopes are given to external software, that we don't control",
"contact": {
"name": "Talkdesk",
"url": "https://talkdesk.com"
}
},
"servers": [
{
"url": "https://api.talkdeskapp.com",
"description": "United States (td-us-1)"
},
{
"url": "https://api.talkdeskapp.eu",
"description": "Europe (td-eu-1)"
},
{
"url": "https://api.talkdeskappca.com",
"description": "Canada (td-ca-1)"
},
{
"url": "https://api.talkdeskapp.co.uk",
"description": "United Kingdom (td-uk-1)"
}
],
"tags": [
{
"name": "Recordings API",
"description": "Recordings API"
}
],
"paths": {
"/recordings-storage/interactions/consent": {
"get": {
"description": "Get consent-type recordings of an interaction using a secure share token. Only consent-type recordings are returned. Designed for third-party systems via OAuth Client Credentials flow with the recordings-consent:read scope.",
"x-namespace": "/recordings-storage",
"summary": "Get consent recordings for an interaction using a share token",
"operationId": "GetConsentRecordingShared",
"security": [
{
"EarlyAccess": [
"recordings-consent:read"
]
}
],
"tags": [
"Recordings API"
],
"parameters": [
{
"name": "token",
"in": "query",
"description": "Secure share token that identifies the interaction and authorizes access to consent recordings. Tokens are short-lived and may be subject to additional usage controls.",
"required": true,
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 4096
}
}
],
"responses": {
"200": {
"description": "OK. Returns metadata and the consent recording link.",
"content": {
"application/json": {
"schema": {
"description": "Data representing the shared interaction recordings.",
"properties": {
"share_metadata": {
"type": "object",
"description": "Meta information that will need to be included in the response token.",
"properties": {
"recorded_at": {
"description": "The date and time when the first recording started (ISO 8601).",
"example": "2022-07-11T10:46:00.000Z",
"type": "string",
"format": "date-time"
},
"agent_name": {
"description": "Agent name.",
"example": "Rafael Alves",
"type": "string"
},
"queues": {
"description": "Agent queues.",
"example": [
"marketing",
"sales"
],
"items": {
"type": "string"
},
"type": "array"
},
"duration": {
"description": "Interaction duration in seconds.",
"example": 154,
"minimum": 1,
"type": "integer"
},
"direction": {
"description": "interaction call direction",
"example": "OUTBOUND",
"enum": [
"OUTBOUND",
"INBOUND",
"TRANSFER"
],
"type": "string"
},
"message": {
"description": "Additional notes attached by the evaluator to be read by the users that will receive the shared recording.",
"example": "At 0:15 the agent does not use the proper words when answering the call.",
"maxLength": 1000,
"type": "string"
}
},
"required": [
"recorded_at",
"agent_name",
"direction",
"duration",
"queues"
]
},
"recordings": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "Recording id",
"example": "61285ec446fa980021dae0ef",
"type": "string"
},
"interaction_id": {
"description": "Interaction id",
"example": "61285ec446fa980021dae0ef",
"type": "string"
},
"index": {
"description": "Calculated field to be used in sorting",
"example": 0,
"type": "integer"
},
"recorded_at": {
"description": "The date and time when the first recording started (ISO 8601).",
"example": "2022-09-14T12:00:00.000Z",
"type": "string",
"format": "date-time"
},
"duration": {
"description": "Interaction duration in seconds.",
"example": 120,
"minimum": 1,
"type": "integer"
},
"type": {
"description": "The type of content that was recorded.",
"type": "string",
"enum": [
"CONVERSATION",
"VOICEMAIL",
"SCREEN"
]
},
"recording_url": {
"description": "The link to recording.",
"example": "https://api.talkdeskstg.com/recordings-storage/interaction/89efa1c4-2ac1-4241-9ab5-821251694584/recordings/1ba635df-963d-4f35-b22f-8b3271e43e41/content?token=AHDjhdjsdjsdjlhfljsdhfkjshdfhsdlgksdjhuyyushdjshfjhsjfhdljfhsdjfjsdhfiosdufoishduasfudhfuoadhfus",
"type": "string"
}
},
"type": "object",
"required": [
"id",
"interaction_id",
"index",
"recorded_at",
"duration",
"type",
"recording_url"
]
},
"description": "List of recordings links shared with the assigned user."
}
}
},
"example": {
"share_metadata": {
"recorded_at": "2022-09-14T12:00:00.000Z",
"agent_name": "Rafael Alves",
"queues": [
"sales"
],
"duration": 120,
"direction": "OUTBOUND",
"message": "Please listen to how the agent answered the client at 0:45. He didn’t follow the protocol and provided false information."
},
"recordings": [
{
"id": "1ba635df-963d-4f35-b22f-8b3271e43e41",
"interaction_id": "89efa1c4-2ac1-4241-9ab5-821251694584",
"index": 0,
"recorded_at": "2022-09-14T12:00:00.000Z",
"duration": 120,
"type": "CONVERSATION",
"recording_url": "https://api.talkdeskstg.com/recordings-storage/interaction/89efa1c4-2ac1-4241-9ab5-821251694584/recordings/1ba635df-963d-4f35-b22f-8b3271e43e41/content?token=AHDjhdjsdjsdjlhfljsdhfkjshdfhsdlgksdjhuyyushdjshfjhsjfhdljfhsdjfjsdhfiosdufoishduasfudhfuoadhfus"
},
{
"id": "1ba635df-963d-4f35-b22f-8b3271e99e99",
"interaction_id": "89efa1c4-2ac1-4241-9ab5-821251694584",
"index": 1,
"recorded_at": "2022-09-14T13:00:00.000Z",
"duration": 6000,
"type": "SCREEN",
"recording_url": "https://env-bucketname.s3.amazonaws.com/staging/recordings/account_id/88c9e56de3ae4f42bb4cc69bbe362199-RE.webm"
}
]
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0050001",
"message\"": "Bad request"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0050002",
"message": "Access denied"
}
}
}
},
"403": {
"description": "Forbidden access",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0050003",
"message": "Forbidden access"
}
}
}
},
"404": {
"description": "Recordings not found",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0050005",
"message": "No recordings found for the specified interaction"
}
}
}
},
"410": {
"description": "Recordings deleted or Expired sharing link",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0050008",
"message": "Shared token expired",
"description": "The shared token expired"
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"EarlyAccess": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://{account_name}.talkdeskid.com/oauth/authorize",
"tokenUrl": "https://{account_name}.talkdeskid.com/oauth/token",
"scopes": {
"messages:read": "Ability to read messages from the API",
"mcp-server:read": "Access the MCP server and call its read-only operation tools",
"mcp-server:write": "Call any MCP operation tool, including those that change data",
"presence-account:read": "Read Account presence",
"presence-user:read": "Read User presence",
"presence-occupancy:write": "Write User occupancy",
"presence-status:write": "Write User status",
"interactions-announcement:write": "Control the announcements in an interaction",
"contacts-custom-fields:read": "Search the custom fields for a given contact",
"contacts-activities:read": "List activities for a contact",
"wfm-public:read": "Get WFM related public data.",
"wfm-public:write": "Create, Update and Delete WFM related public data.",
"industries-activity:write": "Create and update industries activities and events",
"functions:execute": "Execute functions in external provider",
"phone-details:read": "Show phone details from a specific account",
"outbound-numbers:read": "List phone numbers that the agent can use for outbounds",
"numbers:read": "List numbers for an account",
"user-disposition-settings:write": "Update disposition settings for the user",
"attachments:download": "Generate a download link that gives temporary access to the attachment data",
"studio-callbacks:read": "List studio callbacks",
"attachments:read": "Get, and list attachments",
"attachments:request": "Get request ids and urls for uploading",
"attachments:write": "Create, and clone attachments",
"attachments:delete": "Delete an attachment permanently",
"simulated-emails:write": "Write to the eas send simulated email API",
"fsi-insurance-connections-contacts:read": "List and get insurance account holders",
"interactions-public:read": "Read interactions for an account",
"ccaas-user-status:write": "Update user status in ccaas",
"ccaas-user-status:read": "Read user status in ccaas",
"km-external-sources:read": "Read external sources in Talkdesk Knowledge Management",
"km-external-sources:write": "Manage external sources in Talkdesk Knowledge Management",
"omnichannel:interaction-elimination": "Eliminate an omnichannel interaction resource",
"industries-workato-hub": "Allow calling industries workato using a Talkdesk Id OAuth Client",
"secure-messaging:read": "Read secure messaging resources",
"secure-messaging:write": "Create, update secure messaging resources",
"digital-connection-execution:write": "Execute a digital connection action",
"digital-byob-webhook:write": "Reply, Escalate and Resolve Digital interactions via BYOB",
"customer-data-store:read": "Read the multi-channel message",
"email-connection-execution:write": "Execute email connection",
"outbound-notifications:write": "Send outbound notification messages",
"campaign-message:write": "Send campaign message",
"licenses:read": "Get the account licenses",
"seats:read": "Get seats information of a license",
"seats:write": "Add or remove seats from a license",
"recordings-consent:read": "Get consent recording links and metadata",
"voicemails:read": "List voicemails for an account",
"voicemails:write": "Change the voicemail status or assignment",
"ai-agent-conversations-export:read": "Export AI Agent conversations",
"data-datasets:read": "Lists, describes and queries reporting datasets through the dataset endpoints of Data Search API"
}
}
}
}
}
},
"externalDocs": {
"description": "External Documentation",
"url": "https://api-docs.talkdeskapp.com/external_docs"
}
}
```