From Bright Pattern Documentation
| (3 intermediate revisions by the same user not shown) | |||
| Line 5: | Line 5: | ||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host> | + | http[s]://<host>/admin/ws/t/<tenant.url>/recordings/metadata?giid=<GIID>&stepid=<STEP_ID>&convert=false |
=== HTTP Method === | === HTTP Method === | ||
| Line 15: | Line 15: | ||
| '''Data Type''' | | '''Data Type''' | ||
| '''Optional/Required''' | | '''Optional/Required''' | ||
| + | | '''Default Value''' | ||
| '''Description''' | | '''Description''' | ||
|- | |- | ||
| Line 20: | Line 21: | ||
| string | | string | ||
| required | | required | ||
| + | | none | ||
| global interaction identifier ([[Reporting-reference-guide/GlobalInteractionIdentifier | GIID]]) | | global interaction identifier ([[Reporting-reference-guide/GlobalInteractionIdentifier | GIID]]) | ||
|- | |- | ||
| Line 25: | Line 27: | ||
| string | | string | ||
| required | | required | ||
| + | | none | ||
| interaction step ID | | interaction step ID | ||
|- | |- | ||
| convert | | convert | ||
| boolean | | boolean | ||
| − | | | + | | optional |
| − | | "true" | + | | "true" |
| + | | "true" means convert sound data to PCM; "false" means leave as stored - GSM | ||
|} | |} | ||
Latest revision as of 22:06, 13 December 2018
• 3.18
Contents
- Introduction
- API Methods
- 1 Get File
Recording Retrieval API Specification
Get File
Gets the audio file of a recording.
Request
URL
http[s]://<host>/admin/ws/t/<tenant.url>/recordings/metadata?giid=<GIID>&stepid=<STEP_ID>&convert=false
HTTP Method
GET
Parameters
| Parameter | Data Type | Optional/Required | Default Value | Description |
| giid | string | required | none | global interaction identifier ( GIID) |
| stepid | string | required | none | interaction step ID |
| convert | boolean | optional | "true" | "true" means convert sound data to PCM; "false" means leave as stored - GSM |
Body
Empty
Response
Content of audio file