Quicktate XML-RPC API

Important: The XML-RPC API is now deprecated. This API will no longer be updated (except in the case of bugfixes) and will be officially discontinued on December 1, 2013. Please consider switching to the RESTful API for future development.

Our legacy API is powered by the XML-RPC protocol. Examples on this page will be provided for PHP, but XML-PRC libraries are available for every mainstream programming language. A few example libraries are:

• PHP - XML-RPC for PHP
• Ruby - xmlrpc4r
• Java - Apache XML-RPC
• Python - XML-RPC Lib
• ASP.NET - XML-RPC.net

Quicktate's XML-RPC API is hosted at https://api.quicktate.com/api/xml-rpc on port 443. All parameters are submitted as an array rather than individually. See the examples for each of the different commands to understand how to properly submit requests to the APIs.

Methods

The Quicktate XML-RPC API has a single, primary namespace of job.

job.submit

This command submits an audio file into our system for transcription, and returns a unique Job ID which you can use to check the status of the submitted job.

Input Parameters

The following are the input parameters taken for the XML-RPC API. Those which are marked with a red asterisk are required. All others are optional. Note that between audiodata and audiourl, at least one of those parameters are required, but not both.

• user (string) - your username
• key (string) - your API key, obtain this by checking "I'm a developer" during the Quicktate signup process
• audiodata (string) - Base 64 encoded audio file (or use audiourl)
• audiourl (string) - URL to the audio file you would like to be transcribed (or use audiodata)
• filetype (string) - We currently support "wav" or "mp3"
• language_id (int) - 1 for English, 2 for Spanish
• metadata (string) - Block of text you would like to be posted back to you along with the completed job
• callbackmethod (string) - Supported values include HTTPPOST, XMLRPC, RESTPOST, or EMAIL
• callbackdest (string) - If XMLRPC, HTTPPOST, or RESTPOST, this will be the URL you want the results to be sent to (SSL recommended!). If EMAIL, specify the destination email address.

Return Parameters

The following parameters are returned on a successful job submission:

• job_id (int)

PHP Example:

job.status

Checks the status of a submitted job, returning the partial transcription if the job is still being processed, and the full transcription if the job is complete.

Input Parameters

The following are the input parameters taken for the XML-RPC API. Those which are marked with a red asterisk are required. All others are optional.

• user (string) - your username
• key (string) - your API key
• job_id (int) - the value returned when you submitted the job

Return Parameters

If the requested job_id was found and you are authorized to access it, the following parameters will be returned:

• status (int) - (0 = unassigned, 1 = currently being transcribed, 2 = complete, 3 = timed out)
• result (str) - full text transcription result, partial transcription if result has status < 2
• metadata (string) - the metadata you submitted
• datetime_submitted (string) - Date when the request was submitted (YYYY-MM-DD HH:mm:SS)
• datetime_completed (string) - Date when the request was completed (YYYY-MM-DD HH:mm:SS)

job.cancel

Cancels an unassigned transcription. Can only be executed when the transcription request is still pending.

Input Parameters

The following are the input parameters taken for the XML-RPC API. Those which are marked with a red asterisk are required. All others are optional.

• user (string) - your username
• key (string) - your account's API key
• job_id (int) - the ID of the job you would like to cancel

Return Parameters

• result (str) - status message indicating if the job was cancelled
• resultcode (int) - 1 if the job was successfully cancelled