From Bright Pattern Documentation
(Created page with "<translate> = Get Metadata = Gets the metadata of a recording. == Request == === URL === http[s]://<host>/admin/ws/t/<tenant_url>/recordings/metadata?giid=<GIID>&stepid=<ste...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host>/admin/ws/t/< | + | http[s]://<host>/admin/ws/t/<tenant.url>/recordings/metadata?giid=<GIID>&stepid=<STEP_ID> |
| + | |||
| + | === HTTP Method === | ||
| + | GET | ||
=== Parameters === | === Parameters === | ||
| Line 22: | Line 25: | ||
| string | | string | ||
| required | | required | ||
| − | | step | + | | interaction step id |
|} | |} | ||
| − | |||
| − | |||
| − | |||
=== Body === | === Body === | ||
| Line 37: | Line 37: | ||
=== Example === | === Example === | ||
{ | { | ||
| − | + | "Start Time": "11/13/2018 05:51:16 PM MSK +03:00", | |
| − | + | "Agent loginId": null, | |
| − | + | "Agent First Name": null, | |
| − | + | "Agent Last Name": null, | |
| − | + | "Customer phone": "3001", | |
| − | + | "Direction": "INBOUND", | |
| − | + | "Service": "Maintenance Renewal", | |
| − | + | "Disposition": null, | |
| − | + | "Notes": "", | |
| − | + | "Voice Signature": "0", | |
| − | + | "Flagged": "0", | |
| − | + | "Talk Time": "0:04", | |
| − | + | "RecordingId": "20181113175116_3001_461CAD1307384B9BA2F78836F4A5A06F.wav", | |
| − | + | "Global Interaction ID": "5C3DD69D-4DB2-4232-A7A9-0813C6EC1F97", | |
| − | + | "Review URL": "https://example.com/admin?giid=5C3DD69D-4DB2-4232-A7A9-0813C6EC1F97&stepId=461CAD13-0738-4B9B-A2F7-8836F4A5A06F", | |
| − | + | "Screen Recording": "0" | |
} | } | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 22:05, 13 December 2018
• 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=<STEP_ID>
HTTP Method
GET
Parameters
| Parameter | Data Type | Optional/Required | Description |
| giid | string | required | global interaction identifier ( GIID) |
| stepid | string | required | interaction step id |
Body
Empty
Response
Data-Type
JSON object
Example
{
"Start Time": "11/13/2018 05:51:16 PM MSK +03:00",
"Agent loginId": null,
"Agent First Name": null,
"Agent Last Name": null,
"Customer phone": "3001",
"Direction": "INBOUND",
"Service": "Maintenance Renewal",
"Disposition": null,
"Notes": "",
"Voice Signature": "0",
"Flagged": "0",
"Talk Time": "0:04",
"RecordingId": "20181113175116_3001_461CAD1307384B9BA2F78836F4A5A06F.wav",
"Global Interaction ID": "5C3DD69D-4DB2-4232-A7A9-0813C6EC1F97",
"Review URL": "https://example.com/admin?giid=5C3DD69D-4DB2-4232-A7A9-0813C6EC1F97&stepId=461CAD13-0738-4B9B-A2F7-8836F4A5A06F",
"Screen Recording": "0"
}