TAtalkdesk
Recordings API

Get call recordings list

Changed on

Get list of recordings for a call, screen recording is not included

get/calls/{call_id}/recordings

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/calls/{call_id}/recordings
  • Auth
    OAuth 2
    Authorization code: https://{account_name}.talkdeskid.com/oauth/authorize
    Token URL: https://{account_name}.talkdeskid.com/oauth/token scopes: recordings:read

Path parameters

call_idstring required

The call id (interaction id)

Response

List of recordings

totalinteger
countinteger
pageinteger
per_pageinteger

Example response

{
  "total": 2,
  "count": 2,
  "page": 1,
  "per_page": 2,
  "_embedded": {
    "recordings": [
      {
        "id": "1ba635df-963d-4f35-b22f-8b3271e43e41",
        "call_id": "89efa1c4-2ac1-4241-9ab5-821251694584",
        "created_at": "2016-07-11T16:34:50.000Z",
        "index": 0,
        "duration": 5,
        "type": "conversation",
        "agents": {
          "channel_1": [
            {
              "participant_type": "AGENT",
              "participant_id": "0190ef26f59b750d84fc04128b211bd2"
            }
          ],
          "channel_2": [
            {
              "participant_type": "CONTACT",
              "participant_id": null
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api-docs.talkdesk.org/recordings/{recording_id}"
          },
          "media": {
            "href": "http://api-docs.talkdesk.org/recordings/{recording_id}/content?token=some.token.signed"
          }
        }
      },
      {
        "id": "8c062997-f8d0-4d82-b128-6f37b67e1169",
        "call_id": "89efa1c4-2ac1-4241-9ab5-821251694584",
        "created_at": "2016-07-11T16:34:50.000Z",
        "index": 1,
        "duration": 15,
        "type": "consultation",
        "agents": {
          "channel_1": [
            {
              "participant_type": "EXTERNAL_NUM",
              "participant_id": null
            }
          ],
          "channel_2": [
            {
              "participant_type": "AGENT",
              "participant_id": "0190ef26f59b750d84fc04128b211bd2"
            },
            {
              "participant_type": "AGENT",
              "participant_id": "0190ef277e777e6cad7f85e9e264821f"
            }
          ]
        },
        "_links": {
          "self": {
            "href": "http://api-docs.talkdesk.org/recordings/{recording_id}"
          },
          "media": {
            "href": "http://api-docs.talkdesk.org/recordings/{recording_id}/content?token=some.token.signed"
          }
        }
      }
    ]
  },
  "_links": {
    "self": {
      "href": "http://api-docs.talkdesk.org/calls/{call_id}/recordings"
    },
    "page": {
      "templated": true,
      "href": "http://api-docs.talkdesk.org/calls/{call_id}/recordings"
    },
    "next": {
      "href": "http://api-docs.talkdesk.org/calls/{call_id}/recordings?page=1"
    }
  }
}

Changes

  • f69c52fd7456Revision changes
    • warning

      added the new consent enum value to the /// response property for the response status

    • warning

      added the new precall enum value to the /// response property for the response status