List of Recordings for a Call

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

Scope

recordings:read

Body Response - Schema

200 (list of recordings)

ParameterTypeDescription
totalintegern/a
countintegern/a
pageintegern/a
per_pageintegern/a
_embeddedobject"_embedded" subdivides into:

1 - "recordings" (array[object]), which subdivides into:

1.1 - "id" (string)
1.2 - "call_id" (string)
1.3 - "created_at" (string)
1.4 - "index" (integer)
1.5 - "duration" (integer)
1.6 - "type" (string) - the type of content that was recorded. Allowed values: "conversation", "voicemail".
1.7 - "agents" (object) which subdivides into:

1.7.1 - "channel_1" [array(object)] which subdivides into:
1.7.1.1 - "participant_type" (string) Allowed values: AGENT, CONTACT, EXTERNAL_NUM
1.7.1.2 - "participant_id" (string)

1.7.2 - "channel_2" [array(object)]
1.7.2.1 - "participant_type" (string) Allowed values: AGENT, CONTACT, EXTERNAL_NUM
1.7.2.2 - "participant_id" (string)

1.8 - "links" (object) which subdivides into:
1.8.1 - "self" (object) which subdivides into:
1.8.1.1 - "href" (string) Default:
http://api-docs.talkdesk.org/recordings/:id

1.8.2 - "media" (object)which subdivides into:
1.8.2.1 - "href" Default:
http://api-docs.talkdesk.org/recordings/:id/media
_linksobject"_links" subdivides into:

1 - "self" (object), which subdivides into:
1.1 - "href" (string) - default:
http://api-docs.talkdesk.org/calls/:call_id/recordings

2 - "page" (object), which subdivides into:
2.1 - "templated" (boolean)
2.2 - "href" (string) - default:
http://api-docs.talkdesk.org/calls/:call_id/recordings

3 - "next" (object), which subdivides into:
3.1 - "href" (string) - default:
http://api-docs.talkdesk.org/calls/:call_id/recordings

401 (unauthorized), 403 (forbidden access), 404 (recording not found)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language
Authorization
Header
Click Try It! to start a request and see the response here!