Latest revision as of 22:06, 13 December 2018

• 3.18

Get File

Gets the audio file of a recording.

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

GET

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

Empty

Content of audio file

@@ Line 5: / Line 5: @@
 == Request ==
 === URL ===
-  http[s]://<host>/admin/ws/t/<tenant_url>/recordings/audio?giid=<GIID>&stepid=<stepId>
+  http[s]://<host>/admin/ws/t/<tenant.url>/recordings/metadata?giid=<GIID>&stepid=<STEP_ID>&convert=false
+=== HTTP Method ===
+GET
 === Parameters ===
@@ Line 12: / Line 15: @@
 | '''Data Type'''
 | '''Optional/Required'''
+| '''Default Value'''
 | '''Description'''
 |-
@@ Line 17: / Line 21: @@
 | string
 | required
+| none
 | global interaction identifier ([[Reporting-reference-guide/GlobalInteractionIdentifier |  GIID]])
 |-
@@ Line 22: / Line 27: @@
 | string
 | required
-| step ID of the recording (i.e., the segment of the recording)
+| none
+| interaction step ID
+|-
+| convert
+| boolean
+| optional
+| "true"
+| "true" means convert sound data to PCM; "false" means leave as stored - GSM
 |}
-=== HTTP Method ===
-GET
 === Body ===
@@ Line 31: / Line 41: @@
 == 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>