Studio 6 API Documentation
Introduction
URL / Location
Each Studio POP and instance is addressed by separate URL, in the same was as Studio Portal access. The specific URL can be found from Settings
| API Documentation
within Studio
Authorization - Web Configurator
Studio APIs are by default disabled for each entity and must be enabled prior to use. Navigate to Settings
| Web Configurator
and set Configurable for the relevant task. Then select
this task and for each entity set the Configurable
property as desired. CLick the group icon if user level authorisation is desired.
If write API requests are made to entities that are not configurable or are read-only (for the authenticating user) then all requests will return a 403 FORBIDDEN
response. Similarly, read API requests to entities that are not configurable (for the authenticating user) will also receive a 403 FORBIDDEN
response.
Authentication - Tokens
In general (i.e. other than the webhook style operations), users must obtain a unique token and include it in the body for all API calls. Tokens expire every 15 minutes.
Token requests performed within Studio (via the Integration node) only require the Username, Password and API Key
API URL:/v1/auth/get-token/
HTTP Method:POST
HTTP Authentication Details
Details | Value |
---|---|
Authentication Method | Digest |
Username (Email) | e.g. youraccount@email.com |
Password (Secret Key) | e.g. 9711f25f4f46bc88 |
Realm | Please enter your email and secret_key. |
Nonce | 1 |
Algorithm | MD5 |
qop | auth |
Nonce count | 1 |
Client Nonce | 12345 |
Opaque | Leave blank |
Parameters
Key | Required? | Value |
---|---|---|
apikey | REQUIRED | Example: 122d5c44649cce93e24be0990c039c8b |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Response Code
Code | Description |
---|---|
200 | The Token will be returned. The Token is required for all other api requests. e.g. b4b25010795cf8507543f739739678bdd54c6262 Note: the token will expire after 15 minutes |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_API_KEY INVALID_FORMAT |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Requests
Encryption
All requests must be sent using HTTPS with TLS 1.2 or higher. Please make sure your developer tools support this version of TLS as older versions or SSL are not supported for security reasons.
Body
Studio accepts parameters supplied either as form-data or x-www-form-urlencoded.
Where the documentation refers to arrays, the parameter name should be generalised as parameter[index]
, and each of the multiple values sent as parameter[0]
, parameter[1]
etc. If the array is itself a list of objects, they are can be supplied as CGI parameters with names of form parameter[index][property]
Task
List All
API URL/v1/script/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
format | OPTIONAL | desired response format json (default) or xml |
type | OPTIONAL | IVR (default), SMS , WORKFLOW , ALL |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
List One
API URL/v1/script/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Prompt
List All
API URL/v1/prompt/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
List One
API URL/v1/prompt/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
prompt_id | OPTIONAL | Prompt ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Update TTS
API URL/v1/prompt/update-tts/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
prompt_id | REQUIRED | Prompt ID |
tts_voice_id | REQUIRED | TTS Voice ID |
prompt_tts | REQUIRED | PROMPT TTS Value |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Update Audio
API URL/v1/prompt/update-audio/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
prompt_id | REQUIRED | Prompt ID |
tts_voice_id | REQUIRED | TTS Voice ID |
audio_file | REQUIRED | the audio file data |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Get Audio File
API URL/v1/prompt/get-audio-file/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
audio_file | REQUIRED | the audio file data |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Variable
List All
API URL/v1/variable/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
List One
API URL/v1/variable/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
variable_id | REQUIRED | variable ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Update Value
API URL/v1/variable/update-value/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
variable_id | REQUIRED | Variable ID |
value | REQUIRED | Value |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Snapshot
List All
API URL/v1/snapshot/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
List One
API URL/v1/snapshot/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
snapshot_id | REQUIRED | snapshot ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Export Image
API URL/v1/snapshot/export-image/
HTTP Method: POST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
snapshot_id | REQUIRED | snapshot ID |
script_id | REQUIRED | script ID |
width | OPTIONAL | width of image |
height | OPTIONAL | height of image |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID I |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Call Log
List All
API URL/v1/log/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
script_id | REQUIRED | script ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Datastore
List All
API URL: /v1/datastore/list-all/
HTTP Method: POST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reason |
---|---|---|
400 | NO_DATA | No datastores found |
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
List One
API URL/v1/datastore/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
format | OPTIONAL | json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
List All Rows
API URL/v1/datastore/list-all-rows/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
List One Row
API URL/v1/datastore/list-one-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datatstore_id | REQUIRED | datastore ID |
data_id | REQUIRED | data ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
List Date Range
API URL/v1/datastore/list-date-range/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
start_date | REQUIRED | Start date in the format of "yyyy-mm-dd H:m:s" |
end_date | REQUIRED | End date in the format of "yyyy-mm-dd H:m:s" |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Add Row
API URL/v1/datastore/add-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data | REQUIRED | Data, Array of data to be inserted, e.g. data[column_name]="value", data[audio_column_name]="value" |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Update Row
API URL/v1/datastore/update-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | data row ID for update |
data | REQUIRED | Data, Array of data to be updated, e.g. data[column_name]="value", data[audio_column_name]="value" |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Delete Row
API URL/v1/datastore/delete-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Delete Row Range
API URL/v1/datastore/delete-row-range/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | Datastore ID |
start_data_id | REQUIRED | The beginning Data ID of the range. The begin value is included. |
end_data_id | REQUIRED | The end Data ID of the range. The end value is included. |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Update Value
API URL/v1/datastore/update-value/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
column_name | REQUIRED | Column Name |
column_value | REQUIRED | Column Value |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Get Value
API URL/v1/datastore/get-value/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
column_name | REQUIRED | Column Name |
column_value | REQUIRED | Column Value |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Upload Audio
API URL/v1/datastore/upload-audio/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
column_name | REQUIRED | Column Name |
audio_file | REQUIRED | the audio file data |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Delete Audio
API URL/v1/datastore/delete-audio/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
column_name | REQUIRED | Column Name |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Get Audio File
API URL/v1/datastore/get-audio-file/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
data_id | REQUIRED | Data ID |
column_name | REQUIRED | Column Name |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Search
API URL/v1/datastore/search/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
datastore_id | REQUIRED | datastore ID |
filters | REQUIRED | Array of objects which MUST contain the column_name, operator and value. i.e. filters[0][column_name] = 'name', filters[0][operator] = '=', filters[0][value] = 'value'; filters[1][column_name] = ... See below for supported operators. |
format | OPTIONAL | desired response format json (default) or xml |
Operator | Description | Example |
---|---|---|
= | Equal to | filters[0][column_name] = COLUMN_NAME filters[0][operator] = = filters[0][value] = abc |
!= | Not equal to | |
> | Greater than | |
< | Less than | |
>= | Greater than or equal to | |
<= | Less than or equal to | |
=% | Start with | COLUMN_NAME =% a Find any value that starts with 'a' |
%= | Ends with | COLUMN_NAME_ %= a Find any value that ends with 'a' |
%=% | Contains value | COLUMN_NAME %=% a FInd any value that contains 'a' |
!% | Not start with | |
%! | Not end with | |
%!% | Not contain value | |
REGEXP | MySQL format regular expression | COLUMN_NAME REGEXP '^.{10}$' |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
400 | NO_DATA | No data available |
401 | UNAUTHORIZED | UNAUTHORIZED |
Workflow
Run
API URL/v1/workflow/run/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
workflow_id | REQUIRED | workflow ID |
format | OPTIONAL | desired response format json (default) or xml |
These are the variables created in the workflow script as Passed ### Parameters. All passed ### Parameters are to be listed separately as key value pairs.
passed_parameters OPTIONAL customer_name=John employee_number=1234
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | Not available |
Update Workflow
API URL/v1/workflow/update/
HTTP MethodPOST
You can either do a full or partial update by sending the below ### Parameters as needed.
Description Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
workflow_id | REQUIRED | Workflow ID |
name | OPTIONAL | Name of workflow |
status | OPTIONAL | The status of the workflow Supported values are active and inactive |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_SCRIPT_ID |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | Not available |
Formtype
List All
API URL/v1/formtype/list-all/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | Not available |
List One
API URL/v1/formtype/list-one/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
formtype_id | REQUIRED | formtype ID |
format | OPTIONAL | json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | Not available |
List All Rows
API URL/v1/formtype/list-all-rows/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
formtype_id | REQUIRED | formtype ID |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | Not available |
List One Row
API URL/v1/formtype/list-one-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
formtype_id | REQUIRED | formtype ID |
dtmf | REQUIRED | DTMF Value |
format | OPTIONAL | json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |
Update Value
API URL/v1/formtype/update-row/
HTTP MethodPOST
Parameters
Key | Required? | Value |
---|---|---|
token | REQUIRED | Use API auth/get-token to get the token |
formtype_id | REQUIRED | formtype ID |
dtmf | REQUIRED | DTMF Value |
column_name | REQUIRED | Column Name |
column_value | REQUIRED | Column Value |
format | OPTIONAL | desired response format json (default) or xml |
Response - Success
Code | Description |
---|---|
200 | OK |
Response - Error
Code | Description | Reasons |
---|---|---|
400 | ERROR | INVALID_HTTP_METHOD INVALID_FORMAT INVALID_TOKEN INVALID_VALUE |
401 | UNAUTHORIZED | UNAUTHORIZED |
503 | NOT_AVAILABLE | NOT_AVAILABLE |