From Bright Pattern Documentation
Jump to: navigation, search
(Created page with "<translate> = Get File = Gets the audio file of a recording. == Request == === URL === http[s]://<host>/admin/ws/t/<tenant_url>/recordings/audio?giid=<GIID>&stepid=<stepId>...")
 
Line 5: Line 5:
 
== Request ==
 
== Request ==
 
=== URL ===
 
=== URL ===
  http[s]://<host>/admin/ws/t/<tenant_url>/recordings/audio?giid=<GIID>&stepid=<stepId>
+
  http[s]://<host>//admin/ws/t/<tenant.url>/recordings/audio?giid=<GIID>&stepid=<STEP_ID>&convert=false
 +
 
 +
=== HTTP Method ===
 +
GET
  
 
=== Parameters ===
 
=== Parameters ===
Line 22: Line 25:
 
| string
 
| string
 
| required
 
| required
| step ID of the recording (i.e., the segment of the recording)
+
| interaction step ID
 +
|-
 +
| convert
 +
| boolean
 +
| required
 +
| "true": covert sound data to PCM; "false": left as stored - GSM (default is true)  
 
|}
 
|}
=== HTTP Method ===
 
GET
 
  
 
=== Body ===
 
=== Body ===
Line 31: Line 37:
  
 
== Response ==
 
== Response ==
Audio file (WAV)
+
Content of audio file
 +
 
 +
 
 +
 
  
=== Response Codes ===
 
{|border="1" style="border-collapse:collapse" cellpadding="5"
 
| '''Code'''
 
| '''Description'''
 
|-
 
| 200
 
| Success
 
|-
 
| 401
 
| Authentication failed
 
|-
 
| 403
 
| User authenticated, but does not have sufficient privileges
 
|-
 
| 404
 
| File not found
 
|}
 
  
  
 
</translate>
 
</translate>

Revision as of 00:19, 15 November 2018

• 3.18

Contents

Get File

Gets the audio file of a recording.

Request

URL

http[s]://<host>//admin/ws/t/<tenant.url>/recordings/audio?giid=<GIID>&stepid=<STEP_ID>&convert=false

HTTP Method

GET

Parameters

Parameter Data Type Optional/Required Description
giid string required global interaction identifier ( GIID)
stepid string required interaction step ID
convert boolean required "true": covert sound data to PCM; "false": left as stored - GSM (default is true)

Body

Empty

Response

Content of audio file



< Previous | Next >