From Bright Pattern Documentation
• 3.18
Contents
- Introduction
- API Methods
Recording Retrieval API Specification
Get Metadata
Gets the metadata of a recording.
Request
URL
http[s]://<host>/admin/ws/t/<tenant_url>/recordings/metadata?giid=<GIID>&stepid=<stepId>
Parameters
| Parameter | Data Type | Optional/Required | Description |
| giid | string | required | global interaction identifier ( GIID) |
| stepid | string | required | step ID of the recording (i.e., the segment of the recording) |
HTTP Method
GET
Body
Empty
Response
Data-Type
JSON object
Example
{
"Start Time":"08/10/2017 10:18:32 AM PDT -07:00",
"Agent loginId":null,
"Agent First Name":null,
"Agent Last Name":null,
"Customer phone":"3001",
"Direction":"INBOUND",
"Service":null,
"Disposition":null,
"Notes":"",
"Voice Signature":"0",
"Flagged":"0",
"Talk Time":"0:23",
"RecordingId":"20170810101832_3001_A3BF72D5E65846F1A2387CA11F7AD4ED.wav",
"Global Interaction ID":"F663B850-6FC4-4B5E-9DC4-69E62FADD0E4",
"Review URL":"https://example.com/admin?giid=40C6CA6E-98E2-4116-86EF-925883CFFE36&stepId=A3BF72D5-E658-46F1-A238-7CA11F7AD4ED",
"Screen Recording":"0"
}
Response Codes
| Code | Description |
| 200 | Success |
| 401 | Authentication failed |
| 403 | User authenticated, but does not have sufficient privileges |
| 404 | File not found |