Calling the VoiceCloud Human Voice to text API
Access to API Function Calls
Developers will have access to our API function calls which allows you to submit mp3 or wav files to our system. The audio files you submit to us must be hosted on an http(s) server that can be accessed by our machines. Once the API call is made, our servers will fetch the audio file and submit it to our queuing system to be transcribed by our agents. This API is an asynchronous API so the first step is sending the data, second step is an application on your end receiving the data once completed.
Step 1: Sending your request to VoiceCloud
http://voicecloudURL/api?
action=sendfile
&username=youruserid
&devkey=abc123
&idtype=username
&fileurl=http://yourserver/file.mp3
&filetype=mp3
&callerid=18005551212 (optional)
&metadata= (optional)
&customcallback= (optional)
Results:
<?xml version=”1.0″ encoding=”ISO-8859-1″?>
<vcapi>
<action>sendfile</action>
<transactionuid>4760</transactionuid>
</vcapi>
- transactionuid : A unique ID number so your application can keep track and identify which audio was transcribed when we return the text back to your server.
- metadata : Contains any data that you want sent back to your application. So if you send metadata=MYID, we’ll send back metadata=MYID
- customcallback : You can override the default sendbackURL with the URL of your choice
Step 2: Receiving results from VoiceCloud
After the transcription process has completed, the resulting transcribed text and tranactionuid will be POSTed to your URL as name=value pairs. You will need to supply us ahead of time with the URL to the application on your end.
Data Received to your application:
transactionuid : Unique ID number that was received in step 1
transcribed_text : Transcribed text results