Studio 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

DetailsValue
Authentication MethodDigest
Username (Email)e.g. youraccount@email.com
Password (Secret Key)e.g. 9711f25f4f46bc88
RealmPlease enter your email and secret_key.
Nonce1
AlgorithmMD5
qopauth
Nonce count1
Client Nonce12345
OpaqueLeave blank

Parameters

KeyRequired?Value
apikeyREQUIREDExample: 122d5c44649cce93e24be0990c039c8b
formatOPTIONALdesired response format
json (default) or xml

Response - Success

Response Code
CodeDescription
200The 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

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_API_KEY
INVALID_FORMAT
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_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

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALdesired response format
json (default) or xml
typeOPTIONALIVR (default), SMS, WORKFLOW, ALL

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

List One

API URL/v1/script/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Prompt

List All

API URL/v1/prompt/list-all/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

List One

API URL/v1/prompt/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idOPTIONALPrompt ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Update TTS

API URL/v1/prompt/update-tts/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idREQUIREDPrompt ID
tts_voice_idREQUIREDTTS Voice ID
prompt_ttsREQUIREDPROMPT TTS Value
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Update Audio

API URL/v1/prompt/update-audio/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
prompt_idREQUIREDPrompt ID
tts_voice_idREQUIREDTTS Voice ID
audio_fileREQUIREDthe audio file data
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Get Audio File

API URL/v1/prompt/get-audio-file/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
audio_fileREQUIREDthe audio file data
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Variable

List All

API URL/v1/variable/list-all/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

List One

API URL/v1/variable/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
variable_idREQUIREDvariable ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Update Value

API URL/v1/variable/update-value/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
variable_idREQUIREDVariable ID
valueREQUIREDValue
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Snapshot

List All

API URL/v1/snapshot/list-all/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

List One

API URL/v1/snapshot/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
snapshot_idREQUIREDsnapshot ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Export Image

API URL/v1/snapshot/export-image/
HTTP Method: POST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
snapshot_idREQUIREDsnapshot ID
script_idREQUIREDscript ID
widthOPTIONALwidth of image
heightOPTIONALheight of image
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
I
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Call Log

List All

API URL/v1/log/list-all/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
script_idREQUIREDscript ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Datastore

List All

API URL: /v1/datastore/list-all/
HTTP Method: POST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReason
400NO_DATANo datastores found
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED

List One

API URL/v1/datastore/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
formatOPTIONALjson (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

List All Rows

API URL/v1/datastore/list-all-rows/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

List One Row

API URL/v1/datastore/list-one-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datatstore_idREQUIREDdatastore ID
data_idREQUIREDdata ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

List Date Range

API URL/v1/datastore/list-date-range/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
start_dateREQUIREDStart date in the format of "yyyy-mm-dd H:m:s"
end_dateREQUIREDEnd date in the format of "yyyy-mm-dd H:m:s"
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Add Row

API URL/v1/datastore/add-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
dataREQUIREDData, Array of data to be inserted, e.g. data[column_name]="value", data[audio_column_name]="value"
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Update Row

API URL/v1/datastore/update-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDdata row ID for update
dataREQUIREDData, Array of data to be updated, e.g. data[column_name]="value", data[audio_column_name]="value"
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Delete Row

API URL/v1/datastore/delete-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Delete Row Range

API URL/v1/datastore/delete-row-range/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idsREQUIREDData ids, Array of data to be inserted, e.g. data_ids[data_id]. Please note this is limited to 100 rows
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Update Value

API URL/v1/datastore/update-value/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Get Value

API URL/v1/datastore/get-value/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Upload Audio

API URL/v1/datastore/upload-audio/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
audio_fileREQUIREDthe audio file data
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Delete Audio

API URL/v1/datastore/delete-audio/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Get Audio File

API URL/v1/datastore/get-audio-file/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
data_idREQUIREDData ID
column_nameREQUIREDColumn Name
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

API URL/v1/datastore/search/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
datastore_idREQUIREDdatastore ID
filtersREQUIREDArray 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.
formatOPTIONALdesired response format
json (default) or xml
OperatorDescriptionExample
=Equal tofilters[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 withCOLUMN_NAME =% a
Find any value that starts with 'a'
%=Ends withCOLUMN_NAME_ %= a
Find any value that ends with 'a'
%=%Contains valueCOLUMN_NAME %=% a
FInd any value that contains 'a'
!%Not start with
%!Not end with
%!%Not contain value
REGEXPMySQL format regular expressionCOLUMN_NAME REGEXP '^.{10}$'

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
400NO_DATANo data available
401UNAUTHORIZEDUNAUTHORIZED

Workflow

Run

API URL/v1/workflow/run/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
workflow_idREQUIREDworkflow ID
formatOPTIONALdesired response format
json (default) or xml
passed_parameters OPTIONAL These are the variables created in the workflow script as Passed ### Parameters. All passed ### Parameters are to be listed separately as key value pairs.

customer_name=John employee_number=1234

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENot available

Update Workflow

API URL/v1/workflow/update/
HTTP MethodPOST

Description You can either do a full or partial update by sending the below ### Parameters as needed.

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
workflow_idREQUIREDWorkflow ID
nameOPTIONALName of workflow
statusOPTIONALThe status of the workflow Supported values are active and inactive
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_SCRIPT_ID
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENot available

Formtype

List All

API URL/v1/formtype/list-all/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENot available

List One

API URL/v1/formtype/list-one/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
formatOPTIONALjson (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENot available

List All Rows

API URL/v1/formtype/list-all-rows/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENot available

List One Row

API URL/v1/formtype/list-one-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
dtmfREQUIREDDTMF Value
formatOPTIONALjson (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE

Update Value

API URL/v1/formtype/update-row/
HTTP MethodPOST

Parameters

KeyRequired?Value
tokenREQUIREDUse API auth/get-token to get the token
formtype_idREQUIREDformtype ID
dtmfREQUIREDDTMF Value
column_nameREQUIREDColumn Name
column_valueREQUIREDColumn Value
formatOPTIONALdesired response format
json (default) or xml

Response - Success

CodeDescription
200OK

Response - Error

CodeDescriptionReasons
400ERRORINVALID_HTTP_METHOD
INVALID_FORMAT
INVALID_TOKEN
INVALID_VALUE
401UNAUTHORIZEDUNAUTHORIZED
503NOT_AVAILABLENOT_AVAILABLE