transcribeCallRecording¶

Request Method: POST

Description: Transcribes one or more recorded Calls.

URL: https://api.iovox.com:444/Calls?v=3&method=transcribeCallRecording

The following parameters can be sent in the querystring:

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES

Request Example¶

Payload¶

The following XML payload must be sent with a transcribeCallRecording request:

<?xml version="1.0" encoding="utf-8"?>

<request>
    <calls>
        <call>
            <callback_url>http://yourdomain.com/transcription.php</callback_url>
            <id>51515151</id>
            <record_label>callRecording</record_label>
        </call>
        <call>
            ...
        </call>
    </calls>
</request>

Payload Description¶

Node Name	Description	Default Value	Data Type	Mandatory
callback_url	The URL we will hit once the Transcription progress is finished.		STRING	NO
id	The Call ID you want to be transcribed.		INTEGER	YES
record_label	Specifies which of the recordings of a call should be transcribed. There are multiple recordings per call possible.	callRecording	STRING	NO

Result¶

Error Result¶

HTTP Code	Error String	Resolution
400	API Version Empty	Add a value for the v parameter in the query string
400	API Version Invalid	Correct v parameter
400	Request Method must be GET. x attempted	Switch request method x to GET
400	The specified call does not have a recording	Change the id parameter to a call ID that has a recording associated
400	The specified Call ID does not exist	Change the id parameter to an existing call ID
400	Call ID not an integer	Remove non-numerics from id
400	Call ID Empty	Add a value for the id parameter in the query string
500	Internal Server Error	Retry later

Success Result¶

HTTP/1.1 204 No Content

Callback¶

We can send you the transcription from the moment it is finished. Transcribing a call can take up to half an hour.

The callback post is as follows:

<?xml version="1.0" encoding="utf-8"?>

<response>
    <call>
        <id>54545454</id>
        <transcription>Hello, hello? I think you have the wrong number. Excuse me, have a nice day. Have a nice day sir.</transcription>
        <record_label>callRecording</record_label>
    </call>
</response>

Callback XML Description¶

Node Name	Description	Data Type
id	The Call ID of the Call which was transcribed	INTEGER
transcription	The result of the transcription.	STRING
record_label	The record label of the Recording which was transcribed	STRING