Recordings API

Get recording details

Changed on

Get recording details, screen recording is not included

get/recordings/{id}

Request

  • Base URL
    https://api.talkdeskapp.com
  • URL
    https://api.talkdeskapp.com/recordings/{id}
  • 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

idstring required

The recording id

Query parameters

redactedstring

If this parameter omitted or redacted=true, the api will show the redacted recordings if available, otherwise it will show the original recordings.

Response

Recording details

Example response

{
  "id": "1ba635df-963d-4f35-b22f-8b3271e43e41",
  "call_id": "89efa1c4-2ac1-4241-9ab5-821251694584",
  "created_at": "2016-07-11T16:34:50.000Z",
  "index": 0,
  "duration": 10,
  "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}/media"
    }
  }
}

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