From Bright Pattern Documentation
(Updated via BpDeleteTranslateTags script) |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= Get File = | = Get File = | ||
Gets the audio file of a recording. | Gets the audio file of a recording. | ||
| Line 5: | Line 5: | ||
== Request == | == Request == | ||
=== URL === | === URL === | ||
| − | http[s]://<host>// | + | http[s]://<host>/configapi/v2/recordings/audio?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 | ||
|- | |- | ||
| Line 30: | Line 33: | ||
| boolean | | boolean | ||
| required | | required | ||
| − | | "true" | + | | "true" |
| + | | "true" means convert sound data to PCM; "false" means leave as stored - GSM | ||
|} | |} | ||
| Line 38: | Line 42: | ||
== Response == | == Response == | ||
Content of audio file | Content of audio file | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:32, 29 May 2024
• 5.2
Get File
Gets the audio file of a recording.
Request
URL
http[s]://<host>/configapi/v2/recordings/audio?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 | required | "true" | "true" means convert sound data to PCM; "false" means leave as stored - GSM |
Body
Empty
Response
Content of audio file