0% found this document useful (0 votes)

39 views157 pages

VoxUCM-1.0.1 API

The Vox UCM API document version 1.0.1 outlines the API's functionalities for mobile dialer and third-party GUI integration, including user authentication, managing forwarding rules, and handling extensions. It provides detailed instructions on making API requests, including required parameters and expected responses, as well as examples of valid and invalid requests. The document serves as a comprehensive guide for developers to implement and utilize the Vox UCM services effectively.

Uploaded by

Mohsin Syed

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

39 views157 pages

VoxUCM-1.0.1 API

Uploaded by

Mohsin Syed

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 157

cg4YpdvyCsnr

Vox UCM
V-1.0.1
API Document

Version 1.0.1

Author – VoxValley
VOXVALLEY
Contents
Introduction .................................................................................................................................... 5
Mobile Dialer and Third party GUI integration API’s ................................................................... 5
API user Authentication ............................................................................................................... 6
Authorize API User request ..................................................................................................... 6
Inactive Tenant......................................................................................................................... 6
Manage Forwarding Rules .......................................................................................................... 7
Valid request example ............................................................................................................. 7
Disable Call forwarding ............................................................................................................ 8
Invalid request examples ......................................................................................................... 8
Extension ..................................................................................................................................... 9
Country Dropdown List ...........................................................................................................11
Ring Duration Dropdown List................................................................................................. 13
NAT DropdownList ................................................................................................................. 13
Extension Failure DropdownList ............................................................................................ 14
Insecure DropdownList .......................................................................................................... 15
Extension listing request ........................................................................................................ 15
Allowed codecs Dropdown List .............................................................................................. 16
Extension DropdownList ........................................................................................................ 16
Department DropdownList .................................................................................................... 16
Music on hold Dropdown List ................................................................................................ 17
Voicemail DropdownList ........................................................................................................ 17
Pickup group Dropdown List .................................................................................................. 18
DTMF mode Dropdown List ................................................................................................... 18
Follow Me Dropdown List ...................................................................................................... 18
Holiday Dropdown List ........................................................................................................... 19
Media Re-Invite Dropdown List ............................................................................................. 19
Fetch Extension Limit ............................................................................................................. 19
Add Extension ........................................................................................................................ 20
Update Extension................................................................................................................... 63
Ring Group ................................................................................................................................. 67
Ring Group listing................................................................................................................... 68
Ring Duration Dropdown List................................................................................................. 68

Voxucs1.0.1 API 1
VOXVALLEY
Add Ring Group ...................................................................................................................... 69
Ring Group Failure Dropdown List ......................................................................................... 73
Below request examples of Ring Group Failure list. ............................................................ 73
IVR Dropdown List ................................................................................................................. 74
Update Ring Group ................................................................................................................ 75
Ring Group Failure Dropdown List ......................................................................................... 78
Voice Mail Dropdown List ...................................................................................................... 79
Add Extension for Ring Group ............................................................................................... 80
Ring Group Extension Dropdown List .................................................................................... 81
Delete Extension of Ring Group ............................................................................................. 82
Delete Ring Group.................................................................................................................. 83
Voice Mail .................................................................................................................................. 84
Add Voice Mail ....................................................................................................................... 85
Update Voice Mail ................................................................................................................. 90
Delete Voice Mail ................................................................................................................... 93
Voice Mail Mapped Extensions.............................................................................................. 95
Queues ...................................................................................................................................... 95
Queues listing request ........................................................................................................... 96
Add Queues ........................................................................................................................... 97
Queue MOH Dropdown List ................................................................................................ 100
Queue Announcement Dropdown List ................................................................................ 102
Queue Strategy Dropdown List ............................................................................................ 104
Queue Weight Dropdown List ............................................................................................. 104
Update Queue ..................................................................................................................... 105
Queue Agent Map................................................................................................................. 111
Extension drop down List .....................................................................................................112
Penalty drop down List .........................................................................................................113
Delete Queue ........................................................................................................................115
Conference ...............................................................................................................................116
Conference listing request ....................................................................................................117
Add Conference ....................................................................................................................118
Update Conference .............................................................................................................. 127
GET Sound List ....................................................................................................................... 136

Voxucs1.0.1 API 2
VOXVALLEY
Sounds Dropdown List ............................................................................................................ 136
IVR .......................................................................................................................................... 136
Add IVR .............................................................................................................................. 137
IVR Retry Dropdown List ................................................................................................... 140
IVR Sounds Dropdown List ................................................................................................ 141
IVR DTMF Wait Time Dropdown List ............................................................................... 142
Add IVR request with valid data ......................................................................................... 142
Update IVR .......................................................................................................................... 142
IVR Retry Dropdown List ................................................................................................... 145
IVR Sounds Dropdown List ................................................................................................ 146
IVR DTMF Wait Time Dropdown List ............................................................................... 147
Add IVR Option .................................................................................................................. 148
IVR Destination App Dropdown List .................................................................................. 150
IVR Extension Destination number Dropdown List ........................................................... 151
IVR Announcement Destination number Dropdown List ................................................... 151
IVR Destination number Dropdown List ............................................................................ 152
IVR Voice mail Destination number Dropdown List .......................................................... 152
IVR Conference Destination number Dropdown List ......................................................... 152
IVR Ring group Destination number Dropdown List ......................................................... 153
IVR Queues Destination number Dropdown List ............................................................... 153
Delete IVR ........................................................................................................................... 154
GET Extension ........................................................................................................................ 155
Features Dropdown list .............................................................. Error! Bookmark not defined.
Country Dropdown List ............................................................. Error! Bookmark not defined.
Ring Duration Dropdown List.................................................... Error! Bookmark not defined.
Nat Dropdown List ..................................................................... Error! Bookmark not defined.
Allowed codecs Dropdown List ................................................. Error! Bookmark not defined.
Department Dropdown List ........................................................ Error! Bookmark not defined.
Music on hold Dropdown List ................................................... Error! Bookmark not defined.
Pickup group Dropdown List ..................................................... Error! Bookmark not defined.
DTMF mode Dropdown List...................................................... Error! Bookmark not defined.
Media Re-Invite Dropdown List ................................................ Error! Bookmark not defined.
Holiday Dropdown List .............................................................. Error! Bookmark not defined.
Follow Me Dropdown List ......................................................... Error! Bookmark not defined.
Queue Strategy Dropdown List .................................................. Error! Bookmark not defined.

Voxucs1.0.1 API 3
VOXVALLEY
Queue Weight Dropdown List .................................................... Error! Bookmark not defined.
Announcement Dropdown List .................................................. Error! Bookmark not defined.
IVR Dropdown List.................................................................... Error! Bookmark not defined.
Voice mail Dropdown List ......................................................... Error! Bookmark not defined.
Conference Dropdown List ........................................................ Error! Bookmark not defined.
Ring group Dropdown List ........................................................ Error! Bookmark not defined.
Queues Dropdown List............................................................... Error! Bookmark not defined.
Extension Failure Dropdown List .............................................. Error! Bookmark not defined.
Ring Group Failure Dropdown List ........................................... Error! Bookmark not defined.
IVR Destination App Dropdown List......................................... Error! Bookmark not defined.

Voxucs1.0.1 API 4
VOXVALLEY
Introduction
This document provides the application programming interface request and response information
about the Vox UCM services.

Mobile Dialer and Third party GUI integration API’s

Vox UCM API is a web based API, which is accessed through the HTTP request. These API’s are used for
mobile applications development and third party website integration. The sender can send a request
with post parameters and API provides a response in JSON format.
Complete InPut Array always needs to sends using “request” parameter, below is PHP sample code for
“API” request. The response is defined in the OutPut section.

EVERY REQUEST WILL REQUIRE ‘APIUSER’ AND ‘APISECRET’ PARAMETER BUT FOR SECTION AS
FORWARDING ONLY ‘SIPUSER’ PARAMETER IS ALSO REQUIRED WHICH ARE USED FOR REQUEST
AUTHENTICATION. APIUSER IS TENANT API USER’S API USERNAME and SIPUSER IS EXTENSION
USERNAME. SO NEED TO CREATE ONE API USER UNDER TENANTAND USE SAME FOR API
AUTHENTICATION. IF APIUSER or SIPUSER DOES NOT EXIST IN SYSTEM THEN SYSTEM WILL NOT ALLOW
EXECUTING ANY REQUEST.

Complete InPut Array always needs to send using “request” parameter, below is PHP sample code for
“Forwarding” request and response

<?php

// SAMPLE REQUEST need to build in Array and encode in json format

$postdata= json_encode(Array('APIUSER' => '2_apiuser',
'APIPASSWORD' => MD5('123456'),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '46547612', 'NO_ANSWER' => '0123456', 'ALLWAYS'
=> '10000')));
// initiate curl
$ch = curl_init();
// Set SERVER API URL
curl_setopt($ch, CURLOPT_URL,'http://182.72.244.85/api/api.php');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS,'request ='.$postdata);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$server_output = curl_exec ($ch);
curl_close ($ch);
// Response
print_r($server_output);
?>

Voxucs1.0.1 API 5
VOXVALLEY
API user Authentication
API user authentication request is helping to verify API login user and password are valid or not. But for
forwarding request SIP user is also considered to verify as valid or not.

APIUSER holds data separated by underscore (“_”), where prefix of it is Tenant Id and Tenant API Users -
API Username as suffix
SIPUSER holds data separated by underscore (“_”), where prefix of it is Tenant Id and Tenant Extension
as suffix

Request for valid API user and password.

Response Parameters

STATUS – This is response status such as “SUCCESS” or “FAILD”.

DATA - DATA holds MESSAGE of processed request.
MESSAGE - processed request status message.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '2_apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'AUTHAPIUSER',
'ACTION' => 'AUTHAPIUSER');
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Authentication Success"}}

Authorize API User request

Following request example of invalid API user or password.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => ''2_apiuser',
'APIPASSWORD' => '1234561',
'SECTION' => 'AUTHAPIUSER',
'ACTION' => 'AUTHAPIUSER');
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Authentication failed"}}

Inactive Tenant
Following request example of the inactive tenant.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '2_apiuser',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 6
VOXVALLEY
'SECTION' => 'AUTHAPIUSER',
'ACTION' => 'AUTHAPIUSER');
OutPut {"STATUS":"FAILD","DATA":{"MESSAGE":"Tenant User is not active"}}

Manage Forwarding Rules

Enables forwarding rules for Extensions.

Forwarding request SECTION and ACTION parameters should be as 'FORWARDING' and 'NORMAL'.
Below has defined forwarding configuration parameters which are required for processing the
forwarding request.

APIUSER - Tenant Panel API Users API Username.

APIPASSWORD - Tenant Panel API Users API Secret.
SIPUSER - Tenant Panel Extensions Username.
FW_ENABLE - ‘1’ to enable Forwarding and ‘0’ to disable Forwarding for Extensions
ON_BUSY - Destination Extension Number.
NO_ANSWER - Destination Extension Number.
ALLWAYS - Destination Extension Number.

If Destination Number exist under requested Tenant, then the destination number will be stored as
“EXTENSION” number. If it doesn’t exist, then the destination number will be “EXTERNAL” number.

Valid request example

Below is valid request example.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '465476',
'NO_ANSWER' => '0123456', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"SUCCESS","DATA":{"FW_ENABLE":"1","ON_BUSY":"465476","N
O_ANSWER":"0123456","ALLWAYS":"10000","MESSAGE":""}}

Request with at least one or two valid Call Type parameter values such as ON_BUSY, NO_ANSWER and
ALLWAYS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 7
VOXVALLEY
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '46547612',
'NO_ANSWER' => '', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"SUCCESS","DATA":{"FW_ENABLE":"1","ON_BUSY":"46547612","
NO_ANSWER":"","ALLWAYS":"10000","MESSAGE":""}}

Disable Call forwarding

Request with FW_ENABLE parameter equal to “0” (disable forwarding for extension).

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '0', 'ON_BUSY' => '46547612',
'NO_ANSWER' => '0123456', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"SUCCESS","DATA":{"FW_ENABLE":"0","MESSAGE":"Forwarding
disabled successfully."}}

Invalid request examples

Below is invalid request an example of invalid SECTION parameter.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDINGXXXX',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '465476',
'NO_ANSWER' => '0123456', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"SECTION does not exist"}}

Below is invalid request example of the invalid ACTION parameter.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 8
VOXVALLEY
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMALXXXX',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '465476',
'NO_ANSWER' => '0123456', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ACTION does not exist"}}

Below is invalid request example of an invalid FW_ENABLE parameter.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '', 'ON_BUSY' => '465476',
'NO_ANSWER' => '0123456', 'ALLWAYS' => '10000'));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FW_ENABLE is not valid"}}

Below is invalid request example of invalid Call Type parameter values such as ON_BUSY, NO_ANSWER
and ALLWAYS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => 'apiuser',
‘APIPASSWORD’ => MD5(‘123456’),
'SIPUSER' => '2_159951',
'SECTION' => 'FORWARDING',
'ACTION' => 'NORMAL',
'DATA' => Array('FW_ENABLE' => '1', 'ON_BUSY' => '', 'NO_ANSWER' => '',
'ALLWAYS' => ''));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Call Type is not valid"}}

Extension

Extension request SECTION parameter should be as 'EXTENSION'. Below are extension configuration
parameters which are required for processing the extension request.

Voxucs1.0.1 API 9
VOXVALLEY
Request Parameters:

EXTENSIONID - Extension Id accepts only integer values

FULLNAME - Extensions full name
EXTENSION - Extensions username without tenant id as prefix
PASSWORD - Extensions Password
CALLERIDEXTERNAL - Extensions External CallerId
MAXCALLS - Extensions MAXCALLS limit accepts only integers
DENY - Extensions DENY with "0.0.0.0/0.0.0.0" as default value.
PERMIT - Extensions PERMIT with "0.0.0.0/0.0.0.0" as default value.
NAT - Extensions NAT accepting Nat Dropdown List key as input.
DTMFMODE - Extensions DTMF Mode accepting DTMF mode Dropdown List key as input.
MEDIAREINVITE - Extensions Media Re-Invitee accepting Media Re-Invite Dropdown List key as input.
INSECURE - Extensions Insecure accepting Insecure Dropdown List key as input.
ALLOWEDCODECS - Extensions Allowed codecs accepting Allowed codecs Dropdown List key or value as
input.
REPLACECLINAME - Extensions Replace CLI Name accepts "no" or "yes" as input.
DISABLEEXTPANELCONFIGURATION - Extensions Disable Ext Panel Configuration accepts "disable" or
"enable" as input.
ALLOWREMOTERINGING - Extensions Allow Remote Ringing accepts "no" or "yes" as input.
RINGDURATION - Extensions Ring Duration accepting Ring Duration Dropdown List key as input.
FAILURE - Extensions Failure accepting Extension Failure Dropdown List key as input.
FAILUREAPPNOID - Extensions FAILUREAPPNOID accepting Extension Dropdown List key as input when
FAILURE="EXTENSION", Ring group Dropdown List key as input when FAILURE="RINGGROUP" etc.....
STATUS - Extensions status accepting 1 or 0 as input.
COUNTRYID - Extensions Country accepting Country Dropdown List key as input.
DEPARTMENTID - Extensions Department accepting Department Dropdown List key as input.
MUSICONHOLDID - Extensions Music on Hold accepting Music on hold Dropdown List key as input.
VOICEMAIL- Extensions Voice mail option accepting 1 or 0 as input.
VOICEMAILID - Extensions Voice mail Name accepting Voice mail Dropdown List key as input.
EXTBALANCEOPTION - Extensions Use Extension Balance accepting 1 or 0 as input.
CREDIT - Extensions Balance accepting input greater than 0(integer only).
PICKUPGROUP - Extensions Pickup Group accepting Pickup Group Dropdown List key as input.
HOLIDAYFALG - Extensions Holiday option accepting 1 or 0 as input.
HOLIDAYID - Extensions Holiday Name accepting Holiday Dropdown List key as input.
PHONENUMBER - Extensions Phone number
EMAILID - Extensions Email Id
ADDRESS - Extensions Address
FOLLOWME - Extensions Follow Me accepting Follow Me Dropdown List key as input.

Response Parameters:

RESULTLIST - Holding all added Extensions data

EXTENSIONID - Extension Id
NAME - Extensions full name
USERNAME - Extension Username
PASSWORD - Extension Password.

Voxucs1.0.1 API 10
VOXVALLEY
Country Dropdown List

Following request an example of Country list.

Here DATA RESULTLIST contains country id as key and country name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'COUNTRYDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"Afghanistan","2":"Alban
ia","3":"Algeria","4":"American
Samoa","5":"Andorra","6":"Angola","7":"Anguilla","8":"Antarctica","9":"An
tigua And
Barbuda","10":"Argentina","11":"Armenia","12":"Aruba","13":"Australia","
14":"Austria","15":"Azerbaijan","16":"Bahamas","17":"Bahrain","18":"Ban
gladesh","19":"Barbados","20":"Belarus","21":"Belgium","22":"Belize","23
":"Benin","24":"Bermuda","25":"Bhutan","26":"Bolivia","27":"Bosnia And
Herzegovina","28":"Botswana","30":"Brazil","31":"British Indian Ocean
Territory","32":"Brunei Darussalam","33":"Bulgaria","34":"Burkina
Faso","35":"Burundi","36":"Cambodia","37":"Cameroon","38":"United
States","39":"Cape Verde","40":"Cayman Islands","41":"Central African
Republic","42":"Chad","43":"Chile","44":"China","45":"Christmas
Island","46":"Cocos (Keeling)
Islands","47":"Colombia","48":"Comoros","49":"Congo","50":"Congo, The
Democratic Republic Of The","51":"Cook Islands","52":"Costa
Rica","54":"Croatia","55":"Cuba","56":"Cyprus","57":"Czech
Republic","58":"Denmark","59":"Djibouti","60":"Dominica","61":"Dominic
an Republic","62":"Ecuador","63":"Egypt","64":"El
Salvador","65":"Equatorial
Guinea","66":"Eritrea","67":"Estonia","68":"Ethiopia","69":"Falkland
Islands (Malvinas)","70":"Faroe
Islands","71":"Fiji","72":"Finland","73":"France","74":"French
Guiana","75":"French Polynesia","76":"French Southern
Territories","77":"Gabon","78":"Gambia","79":"Georgia","80":"Germany","
81":"Ghana","82":"Gibraltar","83":"Greece","84":"Greenland","85":"Grena
da","86":"Guadeloupe","87":"Guam","88":"Guatemala","89":"Guinea","90
":"Guinea-Bissau","91":"Guyana","92":"Haiti","95":"Honduras","96":"Hong
Kong","97":"Hungary","98":"Iceland","99":"India","100":"Indonesia","101"
:"Iran, Islamic Republic
Of","102":"Iraq","103":"Ireland","104":"Israel","105":"Italy","106":"Jamaic
a","107":"Japan","108":"Jordan","109":"Kazakhstan","110":"Kenya","111":

Voxucs1.0.1 API 11
VOXVALLEY
"Kiribati","112":"Korea, Democratic People's Republic Of","113":"Korea,
Republic of","114":"Kuwait","115":"Kyrgyzstan","116":"Lao People's
Democratic
Republic","117":"Latvia","118":"Lebanon","119":"Lesotho","120":"Liberia",
"121":"Libyan Arab
Jamahiriya","122":"Liechtenstein","123":"Lithuania","124":"Luxembourg","
125":"Macao","126":"Macedonia, The Former Yugoslav Republic
Of","127":"Madagascar","128":"Malawi","129":"Malaysia","130":"Maldive
s","131":"Mali","132":"Malta","133":"Marshall
islands","134":"Martinique","135":"Mauritania","136":"Mauritius","137":"
Mayotte","138":"Mexico","139":"Micronesia, Federated States
Of","140":"Moldova, Republic
Of","141":"Monaco","142":"Mongolia","143":"Montserrat","144":"Morocc
o","145":"Mozambique","146":"Myanmar","147":"Namibia","148":"Nauru
","149":"Nepal","150":"Netherlands","151":"Netherlands
Antilles","152":"New Caledonia","153":"New
Zealand","154":"Nicaragua","155":"Niger","156":"Nigeria","157":"Niue","1
58":"Norfolk Island","159":"Northern Mariana
Islands","160":"Norway","161":"Oman","162":"Pakistan","163":"Palau","1
64":"Palestinian Territory, Occupied","165":"Panama","166":"Papua New
Guinea","167":"Paraguay","168":"Peru","169":"Philippines","171":"Poland
","172":"Portugal","173":"Puerto
Rico","174":"Qatar","175":"Reunion","176":"Romania","177":"Russian
Federation","178":"Rwanda","179":"SaINT Helena","180":"SaINT Kitts And
Nevis","181":"SaINT Lucia","182":"SaINT Pierre And
Miquelon","183":"SaINT Vincent And The
Grenadines","184":"Samoa","185":"San Marino","186":"Sao Tome and
Principe","187":"Saudi
Arabia","188":"Senegal","189":"Seychelles","190":"Sierra
Leone","191":"Singapore","192":"Slovakia","193":"Slovenia","194":"Solom
on Islands","195":"Somalia","196":"South Africa","198":"Spain","199":"Sri
Lanka","200":"Sudan","201":"Suriname","203":"Swaziland","204":"Sweden
","205":"Switzerland","206":"Syrian Arab Republic","207":"Taiwan,
Republic of China","208":"Tajikistan","209":"Tanzania, United Republic
Of","210":"Thailand","211":"Timor-
Leste","212":"Togo","213":"Tokelau","214":"Tonga","215":"Trinidad And
Tobago","216":"Tunisia","217":"Turkey","218":"Turkmenistan","219":"Tur
ks And Caicos
Islands","220":"Tuvalu","221":"Uganda","222":"Ukraine","223":"United
Arab Emirates","224":"United
Kingdom","227":"Uruguay","228":"Uzbekistan","229":"Vanuatu","230":"Ve
nezuela","231":"Vietnam","232":"Virgin Islands, British","233":"Virgin
Islands, U.S.","234":"Wallis And
Futuna","236":"Yemen","238":"Zambia","239":"Zimbabwe","240":"Cote

Voxucs1.0.1 API 12
VOXVALLEY
d'Ivoire","241":"Aland Inland","248":"Guernsey","249":"Isle of
Man","250":"Jersey","252":"Montenegro, Republic of","253":"Serbia,
Republic of","254":"india mobile 4","255":"india mobile1"},"MESSAGE":""}}

Ring Duration Dropdown List

Request for Ring duration list.

Here DATA -> RESULTLIST contains ring duration as key and ring duration display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGDURATIONDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"10":"10 Sec","20":"20
Sec","30":"30 Sec","40":"40 Sec","60":"60 Sec","90":"90 Sec","120":"120
Sec","180":"180 Sec"},"MESSAGE":""}}

NAT Dropdown List

Below request examples of Nat list.

Here DATA -> RESULTLIST contains NAT as key and NAT Display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'NATDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"yes":"Yes","no":"No","neve
r":"Never","force_rport":"force_rport","comedia":"comedia","auto_force_
rport":"auto_force_rport","auto_comedia":"auto_comedia","force_rport,c
omedia":"force_rport,comedia"},"MESSAGE":""}}

Below request examples of invalid INSECURE

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 13
VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "55",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"INSECURE is not valid"}}

Extension Failure Dropdown List

Below request examples of Extension Failure list.

Here DATA -> RESULTLIST contains failure as key and failure display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 14
VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSIONFAILOVER',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"HANGUP":"HANGUP","EXTE
NSION":"EXTENSION","RINGGROUP":"RINGGROUP","ANNOUNCEMENT":"
ANNOUNCEMENT","EXTERNAL":"EXTERNAL","VOICEMAIL":"VOICEMAIL"},"
MESSAGE":""}}

Insecure Dropdown List

Below request examples of insecure list.

Here DATA -> RESULTLIST contains Insecure as key and insecure display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'INSECUREDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"no":"No","yes":"Yes","invit
e":"Invite","port":"Port","invite,port":"Invite & Port"},"MESSAGE":""}}

Extension listing request

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"EXTENSIONID":"2","NAME":
"ext1","EXTENSION":"147147","USERNAME":"1_147147","PASSWORD":"1
23456"},{"EXTENSIONID":"19","NAME":"1234","EXTENSION":"1234","USER
NAME":"1_1234","PASSWORD":"123456"},{"EXTENSIONID":"16","NAME":"
ext3","EXTENSION":"369369","USERNAME":"1_369369","PASSWORD":"12
3456"},{"EXTENSIONID":"28","NAME":"896547","EXTENSION":"896547","U
SERNAME":"1_896547","PASSWORD":"123123"},{"EXTENSIONID":"29","NA
ME":"dsdad","EXTENSION":"12345","USERNAME":"1_12345","PASSWORD
":"123456"},{"EXTENSIONID":"23","NAME":"dddd","EXTENSION":"cccvv","
USERNAME":"1_cccvv","PASSWORD":"123456"},{"EXTENSIONID":"22","NA
ME":"extensiontest","EXTENSION":"Testextension","USERNAME":"1_Testex
tension","PASSWORD":"123456"},{"EXTENSIONID":"20","NAME":"Extensio

Voxucs1.0.1 API 15
VOXVALLEY
n8547","EXTENSION":"8547","USERNAME":"1_8547","PASSWORD":"12345
6"},{"EXTENSIONID":"17","NAME":"ext8","EXTENSION":"789456","USERNA
ME":"1_789456","PASSWORD":"123456"},{"EXTENSIONID":"12","NAME":"
ext2","EXTENSION":"159951","USERNAME":"1_159951","PASSWORD":"12
3456"}],"MESSAGE":""}}

Allowed codecs Dropdown List

Below request examples of Allowed codecs list.

Here DATA -> RESULTLIST contains Allowed codecs key and value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'ALLOWEDCODECSDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"ulaw":"ulaw","alaw":"alaw"
,"g729":"g729","g723.1":"g723.1","gsm":"gsm","h261":"h261","h263":"h2
63","h263p":"h263p","h264":"h264"},"MESSAGE":""}}

Extension DropdownList

Below request examples of Extension list.

Here DATA -> RESULTLIST contains extension I'd as key and extension display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSIONDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"147147
(ext1)","12":"159951 (ext2)","16":"369369 (ext3)","17":"789456
(ext8)","19":"1234 (1234)","20":"8547
(Extension8547)","22":"Testextension (extensiontest)","23":"cccvv
(dddd)","28":"896547 (896547)","29":"12345 (dsdad)","43":"gsdfgsdfg
(xyxyx)","45":"123456987 (xxx)"},"MESSAGE":""}}

Department DropdownList

Below request examples of Department list.

Voxucs1.0.1 API 16
VOXVALLEY

Here DATA -> RESULTLIST contains department Id as key and department display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'DEPARTMENTDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"Testdepartment"},"MES
SAGE":""}}

Music on hold Dropdown List

Below request examples of Music on hold list.

Here DATA -> RESULTLIST contains Music on hold I'd as key and Music on hold display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'MOHDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"5":"frdas","6":"hhhh","3":"
Moh457","2":"mohtest"},"MESSAGE":""}}

Voicemail Dropdown List

Below request examples of Voicemail list.

Here DATA -> RESULTLIST contains Voicemail Id as key and Voicemail display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAINDROPDOWN',

'ACTION' => 'LIST');

OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"1234","3":"159951","6"
:"sss","7":"fffff"},"MESSAGE":""}}

Voxucs1.0.1 API 17
VOXVALLEY
Pickup group Dropdown List

Below request examples of pickup group list.

Here DATA -> RESULTLIST contains pickup group I'd as key and pickup group display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'PICKUPGROUPDROPDOWN',

'ACTION' => 'LIST');

OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"dfgsdfgsdf","3":"ggghhj
","1":"Testpickupgroup"},"MESSAGE":""}}

DTMF mode Dropdown List

Below request examples of DTMF mode list.

Here DATA -> RESULTLIST contains DTMF mode with key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'DTMFMODEDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"inband":"inband","rfc2833"
:"rfc2833","shortinfo":"shortinfo","auto":"auto","info":"info"},"MESSAGE":
""}}

Follow Me Dropdown List

Below request examples of Follow Me list.

Here DATA -> RESULTLIST contains Follow Me as key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'FOLLOWMEDROPDOWN',

Voxucs1.0.1 API 18
VOXVALLEY
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"FOLLOWME":"FOLLOW
ME","FORWARDING":"FORWARDING"},"MESSAGE":""}}

Holiday Dropdown List

Below request examples of Holiday list.

Here DATA -> RESULTLIST contains Holiday Id as key and Holiday display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'HOLIDAYDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"testholidayname"},"ME
SSAGE":""}}

Media Re-Invite Dropdown List

Below request examples of Media Re-Invite list.

Here DATA -> RESULTLIST contains Media Re-Invite with key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'MEDIAREINVITEDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"yes":"yes","no":"no","nona
t":"nonat","update":"update"},"MESSAGE":""}}

Fetch Extension Limit

Below request examples to fetch remaining Extension LIMIT.

If remaining extension limit is zero

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '36_user1',

Voxucs1.0.1 API 19
VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'GETEXTENSIONLIMIT');
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Remaining Extensions Limit is
0."}}

If remaining extension limit is not zero

Add Extension

Below request examples of empty EXTENSION parameter value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",

Voxucs1.0.1 API 20
VOXVALLEY
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION is not valid"}}

Below request examples of less than 3 characters EXTENSION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "12",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",

Voxucs1.0.1 API 21
VOXVALLEY
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION must consist of at
least 3 characters."}}

Below request examples of more than 30 characters EXTENSION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "123698521478963258794526897542568",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",

Voxucs1.0.1 API 22
VOXVALLEY
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION must not exceed
more than 30 characters."}}

Below request examples of duplicate EXTENSION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "159951",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",

Voxucs1.0.1 API 23
VOXVALLEY
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION must contain a
unique value."}}

Below request examples of empty PASSWORD.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "12457888",
"PASSWORD" => "",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",

Voxucs1.0.1 API 24
VOXVALLEY
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PASSWORD is not valid"}}

Below request examples of less than 6 characters PASSWORD.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "15995189",
"PASSWORD" => "1245",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",

Voxucs1.0.1 API 25
VOXVALLEY
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PASSWORD must consist of at
least 6 characters."}}

Below request examples of more than 20 characters PASSWORD.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "15995189",
"PASSWORD" => "12345678996325897845123654",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",

Voxucs1.0.1 API 26
VOXVALLEY
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PASSWORD must not exceed
more than 20 characters."}}

Below request examples of empty FULLNAME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FULLNAME is not valid"}}

Voxucs1.0.1 API 27
VOXVALLEY

Below request examples of less than 3 characters FULLNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xx",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FULLNAME must consist of at
least 3 characters."}}

Below request examples of more than 30 characters FULLNAME

Voxucs1.0.1 API 28
VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" =>
"xxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyxyyyx",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FULLNAME must not exceed
more than 30 characters."}}

Below request examples of empty COUNTRYID.

Voxucs1.0.1 API 29
VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"COUNTRY is not valid"}}

Below request examples of invalid COUNTRYID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 30
VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "0",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"COUNTRYID is not valid"}}

Below request examples of empty RINGDURATION

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',

Voxucs1.0.1 API 31
VOXVALLEY
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGDURATION is not valid"}}

Below request examples of invalid RINGDURATION

Voxucs1.0.1 API 32
VOXVALLEY
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "0",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGDURATION is not valid"}}

Below request examples of invalid NAT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "55",

Voxucs1.0.1 API 33
VOXVALLEY
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"NAT is not valid"}}

Below request examples of invalid FAILURE

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",

Voxucs1.0.1 API 34
VOXVALLEY
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUwwP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILURE is not valid"}}

Below request examples of invalid FAILUREAPPNOID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

Voxucs1.0.1 API 35
VOXVALLEY
"FAILUREAPPNOID" => "342222222",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILUREAPPNOID is not valid"}}

Below request examples of invalid ALLOWEDCODECS

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaaaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",

Voxucs1.0.1 API 36
VOXVALLEY
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ALLOWEDCODECS is not valid"}}

Below request examples of invalid PHONENUMBER.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",
"FAILUREAPPNOID" => "12",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",

Voxucs1.0.1 API 37
VOXVALLEY
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "fgdfhdf",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PHONENUMBER allows
numeric."}}

Below request examples of invalid PHONENUMBER which contains more than 15 digits

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",
"FAILUREAPPNOID" => "12",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",

Voxucs1.0.1 API 38
VOXVALLEY
"PHONENUMBER" => "913698526478965325",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PHONENUMBER must not
exceed more than 15 digits."}}

Below request examples of invalid EMAILID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",
"FAILUREAPPNOID" => "12",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "xyxyyx"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EMAILID is not valid"}}

Voxucs1.0.1 API 39
VOXVALLEY
Below request examples of invalid DEPARTMENTID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "9",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DEPARTMENTID is not valid"}}

Below request examples of invalid MUSICONHOLD.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 40
VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "999",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DEPARTMENTID is not valid"}}

Below request examples of invalid VOICEMAIL (VOICEMAIL can be either 1 or 0).

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',

Voxucs1.0.1 API 41
VOXVALLEY
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "2",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAIL is not valid"}}

request with empty VOICEMAILID and VOICEMAIL is set as 1

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",

Voxucs1.0.1 API 42
VOXVALLEY
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "1",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid"}}

Below request examples of invalid VOICEMAILID and VOICEMAIL are set as 1.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",

Voxucs1.0.1 API 43
VOXVALLEY
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "1",
"VOICEMAILID" => "56666",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid"}}

Below request examples of invalid EXTBALANCEOPTION (EXTBALANCEOPTION can be either 1 or 0.)

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",

Voxucs1.0.1 API 44
VOXVALLEY
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "2",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTBALANCEOPTION is not
valid"}}

Below request examples of empty CREDIT and EXTBALANCEOPTION are set as 1.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",

Voxucs1.0.1 API 45
VOXVALLEY
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "1",
"CREDIT" => "",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CREDIT is not valid"}}

Below request examples of invalid CREDIT and EXTBALANCEOPTION are set as 1.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",

Voxucs1.0.1 API 46
VOXVALLEY
"EXTBALANCEOPTION" => "1",
"CREDIT" => "-1",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CREDIT is not valid"}}

Below request examples of invalid CREDIT and EXTBALANCEOPTION are set as 1.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "1",
"CREDIT" => "fgdfgd",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",

Voxucs1.0.1 API 47
VOXVALLEY
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CREDIT allows numeric."}}

Below request examples of invalid CREDIT with more than 10 digits and EXTBALANCEOPTION are set as
1.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",

"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "1",
"CREDIT" => "100000000000",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));

Voxucs1.0.1 API 48
VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CREDIT must not exceed more
than 10 digits."}}

Below request examples of empty MAXCALLS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "xyz123",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXCALLS is not valid"}}

Below request examples of invalid MAXCALLS containing more than 8 digits.

Voxucs1.0.1 API 49
VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "xyz123",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "8521457896",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXCALLS must not exceed
more than 8 digits."}}

Below request examples of invalid MAXCALLS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 50
VOXVALLEY
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "xyz123",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "aaaaaa",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXCALLS allows numeric."}}

Below request examples of invalid MAXCALLS.

Voxucs1.0.1 API 51
VOXVALLEY
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "-1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXCALLS is not valid"}}

Below request examples of invalid PICKUPGROUP.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",

Voxucs1.0.1 API 52
VOXVALLEY
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "EXTENSION",

"FAILUREAPPNOID" => "12",

"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "2",
"MUSICONHOLDID" => "2",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "ssss",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PICKUPGROUP is not valid"}}

Below request examples of invalid DTMFMODE.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc283223",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),

Voxucs1.0.1 API 53
VOXVALLEY
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DTMFMODE is not valid"}}

Below request examples of invalid MEDIAREINVITE.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "ye2s",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",

Voxucs1.0.1 API 54
VOXVALLEY
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MEDIAREINVITE is not valid"}}

Below request examples of invalid HOLIDAYFALG

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",

Voxucs1.0.1 API 55
VOXVALLEY
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "2",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"HOLIDAYFALG is not valid"}}

Below request examples of invalid HOLIDAYID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",

Voxucs1.0.1 API 56
VOXVALLEY
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "1",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"HOLIDAYID is not valid"}}

Below request examples of invalid HOLIDAYFALG (it should be 1 or 0).

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "2",
"HOLIDAYID" => "",
"PHONENUMBER" => "",

Voxucs1.0.1 API 57
VOXVALLEY
"EMAILID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"HOLIDAYFALG is not valid"}}

Below request examples of invalid FOLLOWME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568999",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"FOLLOWME"=>"sdfasdfasf"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FOLLOWME is not valid"}}

Below add extension request examples, when Tenant limit is “Zero” or reached max extension limit.

Voxucs1.0.1 API 58
VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '36_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyz",
"EXTENSION" => "566666",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "60",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "1",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Reached Max. Extensions
Limit."}}

Below request examples to add an extension with invalid VEDIOSUPPORT ( VEDIOSUPPORT will accept
1/0).

Voxucs1.0.1 API 59
VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568992",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO",
"VEDIOSUPPORT"=>"5"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VEDIOSUPPORT is not valid"}}

Below request examples to add an extension with invalid TAPIACCOUNT( TAPIACCOUNT will accept
1/0) .

Type Detail

Voxucs1.0.1 API 60
VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568992",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO",
"VEDIOSUPPORT"=>"1",
"TAPIACCOUNT"=>"5"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"TAPIACCOUNT is not valid"}}

Below request examples to add an extension with same DENY and PERMIT except for "0.0.0.0/0.0.0.0"

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 61
VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568992",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.9",
"PERMIT" => "0.0.0.0/0.0.0.9",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO",
"VEDIOSUPPORT"=>"1",
"TAPIACCOUNT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DENY and PERMIT should not
be same except for '0.0.0.0\/0.0.0.0'."}}

Below request examples to add an extension with valid data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 62
VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'ADD',
'DATA' => Array("FULLNAME" => "xyzy",
"EXTENSION" => "568992",
"PASSWORD" => "123456",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"CREDIT" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"FOLLOWME"=>"NO",
"VEDIOSUPPORT"=>"1",
"TAPIACCOUNT"=>"1"));
OutPut {"STATUS":"SUCCESS","DATA":{"EXTENSIONID":"66","USERNAME":"1_568
992","PASSWORD":"123456","MESSAGE":"Extension Details has been
inserted successfully."}}

Update Extension

Below request examples to update extension with valid data..

Voxucs1.0.1 API 63
VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'EDIT',
'DATA' => Array("EXTENSIONID"=>"66",
"FULLNAME" => "xyzy",
"EXTENSION" => "5689913",
"CALLERIDEXTERNAL" => "",
"MAXCALLS" => "1",
"TAPIACCOUNT" =>"0",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"VEDIOSUPPORT"=>"1"));
OutPut {"STATUS":"SUCCESS","DATA":{"EXTENSIONID":"66","USERNAME":"1_568
9913","MESSAGE":"Extension Details has been updated successfully."}}

Below request examples of extension update with the address.

Type Detail

Voxucs1.0.1 API 64
VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'EDIT',
'DATA' => Array("EXTENSIONID"=>"65",
"ADDRESS"=>"xyxyyxyyxyxyxyx"));
OutPut {"STATUS":"SUCCESS","DATA":{"EXTENSIONID":"65","USERNAME":"1_568
991","MESSAGE":"Extension Details has been updated successfully."}}

Below request examples of empty extension.

OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION is not valid"}}

Below request examples of invalid EXTENSIONID.

OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Below request examples of duplicate EXTENSION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'EDIT',

Voxucs1.0.1 API 65
VOXVALLEY
'DATA' => Array("EXTENSIONID"=>"656",
"EXTENSION"=>"user671"));

OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSION must contain a

unique value."}}

Below request examples with same DENY and PERMIT except for "0.0.0.0/0.0.0.0"

OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DENY and PERMIT should not

be same except for '0.0.0.0\/0.0.0.0'."}}

Below request examples of valid update extension data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'EDIT',
'DATA' => Array("EXTENSIONID"=>"65",
"FULLNAME" => "x1yzy",
"EXTENSION" => "5689913",
"CALLERIDEXTERNAL" => "25455",
"MAXCALLS" => "1",
"TAPIACCOUNT" =>"0",
"DENY" => "0.0.0.0/0.0.0.0",
"PERMIT" => "0.0.0.0/0.0.0.0",
"NAT" => "no",
"DTMFMODE" => "rfc2833",
"MEDIAREINVITE" => "yes",
"INSECURE" => "no",
"ALLOWEDCODECS" => array("ulaw", "alaw"),
"REPLACECLINAME" => "no",

Voxucs1.0.1 API 66
VOXVALLEY
"DISABLEEXTPANELCONFIGURATION" => "disable",
"ALLOWREMOTERINGING" => "no",
"RINGDURATION" => "10",
"FAILURE" => "HANGUP",
"FAILUREAPPNOID" => "",
"STATUS" => "1",
"COUNTRYID" => "3",
"DEPARTMENTID" => "",
"MUSICONHOLDID" => "",
"VOICEMAIL" => "0",
"VOICEMAILID" => "",
"EXTBALANCEOPTION" => "0",
"PICKUPGROUP" => "",
"HOLIDAYFALG" => "0",
"HOLIDAYID" => "",
"PHONENUMBER" => "",
"EMAILID" => "",
"ADDRESS"=>"",
"VEDIOSUPPORT"=>"1",
"FOLLOWME"=>"FORWARDING"));
OutPut {"STATUS":"SUCCESS","DATA":{"EXTENSIONID":"65","USERNAME":"1_568
9913","MESSAGE":"Extension Details has been updated successfully."}}

Ring Group

Ring Group request SECTION parameters should be as 'RINGGROUP'.

RINGGROUPID - Ring group id accepts the only integer

RINGGROUPNAME - Ring Group Name allows alphanumeric and underscore. Should not start with an
underscore.
RINGGROUPDESCRIPTION - Ring Group Description
RINGDURATION - Ring Duration accepting Ring Duration Dropdown List key as input.
CLIPREFIX - CLI Prefix
RECORDING - Ring Group Recording accepting 1 or 0 as input.
FAILOVERAPP - Failure accepting Ring Group Failure Dropdown List key as input.
FAILOVERAPPNOID - Ring Group FAILOVERAPPNOID accepting Extension Dropdown List key as input
when FAILOVERAPP="EXTENSION", Ring group Dropdown List key as input when
FAILOVERAPP="RINGGROUP" etc.....

Response Parameters
RESULTLIST - Holding all added Ring group data
RINGGROUPID - Ring group id accepts the only integer

Voxucs1.0.1 API 67
VOXVALLEY
NAME - Ring group name
DESCRIPTION - Ring Group Description
RINGTIME - Ring Duration
CLIPREFIX - CLI Prefix
FAILOVERAPP - Ring Group Failure Dropdown List value will be displayed
FAILOVERAPPNUMBER - Display of Extension name and Extension Full Name in bracket like Extension
Name (Extension Full Name)
EXTENSION - Mapped Extensions to Ring group contains EXTENSIONNAME, NAME, and EXTENSIONID
EXTENSIONNAME - Extension Name without tenant id and underscore as Prefix
NAME - Extension Full Name
EXTENSIONID - Extension Id

Ring Group listing

Below request examples of Ring group listing along with Extensions.

EXTENSION contains all the extensions mapped to a corresponding ring group.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '33_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"RINGGROUPID":"35","NAM
E":"343434","DESCRIPTION":"dfgsdfgsdfg","CLIPREFIX":"","RINGTIME":"30"
,"FAILOVERAPP":"HANGUP","FAILOVERAPPNUMBER":"","EXTENSION":[{"EX
TENSIONNAME":"234444","NAME":"XYXYXYX","EXTENSIONID":"44"}]}],"M
ESSAGE":""}}

Ring group listing with empty data

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '13_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'LIST');
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"No Data."}}

Ring Duration Dropdown List

Below request examples of Ring duration list.

Voxucs1.0.1 API 68
VOXVALLEY

Here DATA -> RESULTLIST contains ring duration as key and ring duration display name as value.

Add Ring Group

Below examples of Add Ring group request with empty RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "123456",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME is not
valid"}}

Below examples of Add Ring group request with invalid RINGGROUPNAME.

Voxucs1.0.1 API 69
VOXVALLEY
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME allows alpha
numeric and Underscore. Should not start with Underscore."}}

Below examples of Add Ring group request with less than 4 characters RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "x",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "123456",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must consist
of at least 4 characters."}}

Below examples of Add Ring group request with more than 20 characters RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "x565555555248hhhhshhhh",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "123456",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must not
exceed more than 20 characters."}}

Below examples of Add Ring group request with duplicate RINGGROUPNAME

Voxucs1.0.1 API 70
VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "5689913",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "123456",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must
contain a unique value."}}

Below examples of Add Ring group request with invalid RINGGROUPDESCRIPTION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "5689913",
"RINGGROUPDESCRIPTION" => "5689793@##",
"RINGDURATION" => "123456",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPDESCRIPTION
allows only alphanumeric space,dot(.) and _"}}

Below examples of Add Ring group request with empty RINGDURATION.

Voxucs1.0.1 API 71
VOXVALLEY
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGDURATION is not valid"}}

Below examples of Add Ring group request with invalid RINGDURATION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "344444",
"CLIPREFIX" => "",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGDURATION is not valid"}}

Add Ring group request with invalid CLIPREFIX and valid RINGDURATION holding the key of the above
Dropdown list.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "$242424",
"RECORDING" => "0",
"FAILOVERAPP" => "HANGUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CLIPREFIX allows only
alphanumeric space,dot(.) and _"}}

Voxucs1.0.1 API 72
VOXVALLEY

Below request examples of add Ring Group with invalid FAILOVERAPP.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "242424",
"RECORDING" => "0",
"FAILOVERAPP" => "HAN11GUP",
"FAILOVERAPPNOID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILOVERAPP is not valid"}}

Ring Group Failure Dropdown List

Below request examples of Ring Group Failure list.

Here DATA -> RESULTLIST contains failure as key and failure display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUPFAILOVER',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"HANGUP":"HANGUP","EXTE
NSION":"EXTENSION","RINGGROUP":"RINGGROUP","ANNOUNCEMENT":"
ANNOUNCEMENT","IVR":"IVR","VOICEMAIL":"VOICEMAIL"},"MESSAGE":""
}}

request to add Ring Group with invalid FAILOVERAPPNOID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',

Voxucs1.0.1 API 73
VOXVALLEY
'DATA' => Array("RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "1245",
"RECORDING" => "0",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "sdfsd"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILOVERAPPNOID is not
valid"}}

IVR Dropdown List

Below request examples of IVR list.

Here DATA -> RESULTLIST contains IVR-Id as key and IVR display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVRDROPDOWN',

'ACTION' => 'LIST');

OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"sampleimnjn","3":"sam
pleivr2","4":"sampleivrthree"},"MESSAGE":""}}

request to add Ring Group with valid data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADD',
'DATA' => Array("RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "1245",
"RECORDING" => "0",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"32","MESSAGE":"Ring
Group data has been created successfully."}}

Voxucs1.0.1 API 74
VOXVALLEY
Update Ring Group

request to update Ring Group without RINGGROUPID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array(
"RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "1245",
"RECORDING" => "0",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPID is not valid."}}

Request to update Ring Group with invalid RINGGROUPID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"342",
"RINGGROUPNAME" => "xyxyxy5689793",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "1245",
"RECORDING" => "0",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPID is not valid."}}

request to update Ring Group with empty RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 75
VOXVALLEY
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME is not
valid"}}

request to update Ring Group with duplicate RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "5689913",
"RINGGROUPDESCRIPTION" => "5689793",
"RINGDURATION" => "10",
"CLIPREFIX" => "1245",
"RECORDING" => "0",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must
contain a unique value."}}

request to update Ring Group with invalid RINGGROUPNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "xy####zy",
"RINGGROUPDESCRIPTION" => "5689793",
"FAILOVERAPP" => "IVR",
"FAILOVERAPPNOID" => "6"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME allows alpha
numeric and Underscore. Should not start with Underscore."}}

Voxucs1.0.1 API 76
VOXVALLEY
Update Ring group request with RINGGROUPNAME containing less than 4 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "1",
"RINGGROUPDESCRIPTION" => "5689793"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must consist
of at least 4 characters."}}

Update Ring group request with RINGGROUPNAME containing more than 20 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "x565555555248hhhhshhhh"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPNAME must not
exceed more than 20 characters."}}

request to update Ring Group with valid RINGGROUPDESCRIPTION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPDESCRIPTION" => "568979sdfsdfsd3"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"34","MESSAGE":"Ring
Group data has been updated successfully."}}

request to update Ring Group with invalid FAILOVERAPP.

Type Detail

Voxucs1.0.1 API 77
VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"FAILOVERAPP" => "ss",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILOVERAPP is not valid"}}

Ring Group Failure Dropdown List

request for Ring Group Failure list.

Here DATA -> RESULTLIST contains failure as key and failure display name as value.

request to update Ring Group with invalid FAILOVERAPPNOID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"FAILOVERAPP" => "VOICEMAIL",
"FAILOVERAPPNOID" => "211"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"FAILOVERAPPNOID is not
valid"}}

Voxucs1.0.1 API 78
VOXVALLEY
Voice Mail Dropdown List

request for Voice Mail list.

Here DATA -> RESULTLIST contains Voice Mail Id as key and Voice Mail display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVRDROPDOWN',

'ACTION' => 'LIST');

OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"1234","3":"159951","6"
:"sss","7":"fffff"},"MESSAGE":""}

request to add Ring Group with valid FAILOVERAPP and FAILOVERAPPNOID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"FAILOVERAPP" => "VOICEMAIL",
"FAILOVERAPPNOID" => "2"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"34","MESSAGE":"Ring
Group data has been updated successfully."}}

request to add Ring Group with valid data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EDIT',
'DATA' => Array("RINGGROUPID"=>"34",
"RINGGROUPNAME" => "xyxyxy56",
"RINGGROUPDESCRIPTION" => "5689791xyz",
"RINGDURATION" => "60",
"CLIPREFIX" => "",
"RECORDING" => "1",

Voxucs1.0.1 API 79
VOXVALLEY
"FAILOVERAPP" => "VOICEMAIL",
"FAILOVERAPPNOID" => "6"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"34","MESSAGE":"Ring
Group data has been updated successfully."}}

Add Extension for Ring Group

request to add Extension for Ring Group without RINGGROUPID

request to add Extension for Ring Group with invalid RINGGROUPID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADDEXTENSION',
'DATA' => Array("RINGGROUPID"=>"324",
"EXTENSION"=>"8"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPID is not valid."}}

request to add Extension for Ring Group with invalid EXTENSIONID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADDEXTENSION',
'DATA' => Array("RINGGROUPID"=>"34",
"EXTENSIONID"=>"84444"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Voxucs1.0.1 API 80
VOXVALLEY
request to add Extension for Ring Group with invalid EXTENSIONID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADDEXTENSION',
'DATA' => Array("RINGGROUPID"=>"34",
"EXTENSIONID"=>"84444"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Ring Group Extension Dropdown List

Request for Ring Group Extension list.

Here DATA -> RESULTLIST contains unmapped extensions with Extension I'd as key and Extension display
name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'EXTENSIONDROPDWON',
'DATA' => Array("RINGGROUPID"=>"34"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"34","RESULTLIST":{"12":"
159951 (ext2) ","16":"369369 (ext3) ","17":"789456 (ext8) ","19":"1234
(1234) ","20":"8547 (Extension8547) ","22":"Testextension (extensiontest)
","23":"cccvv (dddd) ","28":"896547 (896547) ","29":"12345 (dsdad)
","43":"gsdfgsdfg (xyxyx) ","45":"123456987 (xxx) ","46":"xyzabc (xyzabc)
","47":"xycredit (xycredit) ","65":"5689913 (x1yzy) ","67":"568993 (xyzy)
","68":"56891493 (xyzy) "},"MESSAGE":""}}

request to add Extension for Ring Group with valid EXTENSIONID.

Voxucs1.0.1 API 81
VOXVALLEY
"EXTENSIONID"=>"12"));
OutPut {"STATUS":"SUCCESS","DATA":{"RINGGROUPID":"34","EXTENSION":"15995
1 (ext2) ","MESSAGE":"Extension has been added successfully."}}

request to add Extension for Ring Group with the same EXTENSIONID again.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'ADDEXTENSION',
'DATA' => Array("RINGGROUPID"=>"34",
"EXTENSIONID"=>"12"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Delete Extension of Ring Group

request to delete Extension of Ring Group.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETEEXTENSION',
'DATA' => Array("RINGGROUPID" => "34",
"EXTENSIONID" => "12"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Extension Data has been
deleted successfully."}}

request to delete Extension of Ring Group with invalid EXTENSIONID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETEEXTENSION',
'DATA' => Array("RINGGROUPID" => "34",
"EXTENSIONID" => "122"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Voxucs1.0.1 API 82
VOXVALLEY

request to delete Extension of Ring Group with invalid RINGGROUPID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETEEXTENSION',
'DATA' => Array("RINGGROUPID" => "3411",
"EXTENSIONID" => "12"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPID is not valid."}}

Delete Ring Group

request to delete Ring Group with invalid RINGGROUPID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETEEXTENSION',
'DATA' => Array("RINGGROUPID" => "3411",
"EXTENSIONID" => "12"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGGROUPID is not valid."}}

request to delete Ring Group with mapped Extension.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETE',
'DATA' => Array("RINGGROUPID" => "28"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Ring Group is Mapped
To Announcements:0 IVR:0 DID:0 Ringgroup:0 Extension:0 Day
Night:0 Extensions Under RingGroup:1 "}}

request to delete Ring Group with no mapped Extension.

Voxucs1.0.1 API 83
VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUP',
'ACTION' => 'DELETE',
'DATA' => Array("RINGGROUPID" => "34"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Ring Group Data has been
deleted successfully."}}

Voice Mail

Voice Mail request SECTION parameters should be as ''VOICEMAIL'

VOICEMAILID - VoiceMail Id accepts only integer

VOICEMAILUSER - VoiceMail Username
VOICEMAILSECRET - VoiceMail Secret
EMAILADDRESS - VoiceMail Email Address
STATUS - VoiceMail Status

Response Parameters
RESULTLIST - Holding all added VoiceMail data
VOICEMAILID - VoiceMail Id accepts only integer
VOICEMAILUSER - VoiceMail Username
VOICEMAILSECRET - VoiceMail Secret
EMAILADDRESS - VoiceMail Email Address
STATUS - VoiceMail Status as “ACTIVE” or “INACTIVE”
MESSAGE - request processed status message.

Voice Mail listing request example.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"VOICEMAILID":"7","VOICE
MAILUSER":"fffff","VOICEMAILSECRET":"233454555","EMAILADDRESS":"xf
[email protected]","STATUS":"ACTIVE"},{"VOICEMAILID":"6","VOICEMAILUSE
R":"sss","VOICEMAILSECRET":"123456","EMAILADDRESS":"[email protected]
m","STATUS":"ACTIVE"},{"VOICEMAILID":"3","VOICEMAILUSER":"159951",
"VOICEMAILSECRET":"123412","EMAILADDRESS":"[email protected]","S
TATUS":"ACTIVE"},{"VOICEMAILID":"2","VOICEMAILUSER":"1234","VOICE

Voxucs1.0.1 API 84
VOXVALLEY
MAILSECRET":"1234","EMAILADDRESS":"[email protected]","STAT
US":"ACTIVE"}],"MESSAGE":""}}

Voice Mail listing with empty data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '13_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'LIST');
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"No Data."}}

Add Voice Mail

Add Voice Mail request with VOICEMAILUSER empty.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "",
"VOICEMAILSECRET" => "5689793",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILUSER is not valid"}}

Add Voice Mail request with invalid VOICEMAILUSER.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "vsdg%%$#$#",
"VOICEMAILSECRET" => "5689793",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));

Voxucs1.0.1 API 85
VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILUSER allows alpha
numeric."}}

Add Voice Mail request with VOICEMAILUSER containing less than 3 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "1",
"VOICEMAILSECRET" => "5689793",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILUSER must consist of
at least 3 characters."}}

Add Voice Mail request with VOICEMAILUSER containing more than 20 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "x565555555248hhhhshhhh",
"VOICEMAILSECRET" => "5689793",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILUSER must not
exceed more than 20 characters."}}

Add Voice Mail request with duplicate VOICEMAILUSER.

Voxucs1.0.1 API 86
VOXVALLEY
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILUSER must contain a
unique value."}}

Add Voice Mail request with empty VOICEMAILSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET is not
valid"}}

Add Voice Mail request with invalid VOICEMAILUSER.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "aaaa",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET allows
numeric."}}

Add Voice Mail request with VOICEMAILSECRET containing more than 20 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',

Voxucs1.0.1 API 87
VOXVALLEY
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "124578963258745879635689",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET must not
exceed more than 20 digits."}}

Add Voice Mail request with invalid VOICEMAILSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "-1",
"EMAILADDRESS" => "10",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET allows
numeric."}}

Add Voice Mail request with empty EMAILADDRESS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "254878",
"EMAILADDRESS" => "",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EMAILADDRESS is not valid"}}

Add Voice Mail request with invalid EMAILADDRESS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 88
VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "254878",
"EMAILADDRESS" => "xyz@@@@voxvalley.com",
"STATUS" => "1245"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EMAILADDRESS is not valid"}}

Add Voice Mail request with empty STATUS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "254878",
"EMAILADDRESS" => "[email protected]",
"STATUS" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STATUS is not valid"}}

Add Voice Mail request with invalid STATUS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "254878",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STATUS is not valid"}}

Add Voice Mail request with valid data and STATUS (as 0/1).

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 89
VOXVALLEY
'SECTION' => 'VOICEMAIL',
'ACTION' => 'ADD',
'DATA' => Array("VOICEMAILUSER" => "2323263",
"VOICEMAILSECRET" => "254878",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1"));
OutPut {"STATUS":"SUCCESS","DATA":{"VOICEMAILID":"12","MESSAGE":"VoiceMa
il data has been created successfully."}}

Update Voice Mail

Update Voice Mail request without valid VOICEMAILID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILUSER" => "",
"VOICEMAILSECRET" => "254878"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid."}}

Update Voice Mail request with empty VOICEMAILID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"",
"VOICEMAILSECRET" => "254878"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid."}}

Update Voice Mail request with invalid VOICEMAILID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',

Voxucs1.0.1 API 90
VOXVALLEY
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"0",
"VOICEMAILSECRET" => "254878"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid."}}

Update Voice Mail request with empty VOICEMAILSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"VOICEMAILSECRET" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET is not
valid"}}

Update Voice Mail request with invalid VOICEMAILSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"VOICEMAILSECRET" => "aaaa"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET allows
numeric."}}

Update Voice Mail request with VOICEMAILSECRET containing more than 20 characters

Voxucs1.0.1 API 91
VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET must not
exceed more than 20 digits."}}

Update Voice Mail request with invalid VOICEMAILSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"VOICEMAILSECRET" => "-1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILSECRET is not
valid."}}

Update Voice Mail request with empty EMAILADDRESS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"EMAILADDRESS" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EMAILADDRESS is not valid"}}

Update Voice Mail request with invalid EMAILADDRESS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"EMAILADDRESS" => "xyz@@@@voxvalley.com"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EMAILADDRESS is not valid"}}

Update Voice Mail request with empty STATUS.

Voxucs1.0.1 API 92
VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"STATUS" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STATUS is not valid"}}

Update Voice Mail request with invalid STATUS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"STATUS" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STATUS is not valid"}}

Update Voice Mail request with valid data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'EDIT',
'DATA' => Array("VOICEMAILID"=>"15",
"VOICEMAILSECRET" => "2548178",
"EMAILADDRESS" => "[email protected]",
"STATUS" => "1"));
OutPut {"STATUS":"SUCCESS","DATA":{"VOICEMAILID":"15","MESSAGE":"VoiceMa
il data has been updated successfully."}}

Delete Voice Mail

Delete Voice Mail request with empty VOICEMAILID.

Type Detail

Voxucs1.0.1 API 93
VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'DELETE',
'DATA' => Array("VOICEMAILID"=>""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VOICEMAILID is not valid."}}

Delete Voice Mail request with invalid VOICEMAILID.

Delete Voice Mail request with valid VOICEMAILID which is mapped to extensions.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'DELETE',
'DATA' => Array("VOICEMAILID"=>"2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"VoiceMail is Mapped
To Announcements:0 IVR:0 DID:0 Ringgroup:0 Extension:4 Day
Night:0 "}}

Delete Voice Mail request with valid VOICEMAILID which not mapped to any features.

Voxucs1.0.1 API 94
VOXVALLEY
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"VoiceMail Data has been
deleted successfully."}}

List of Voice Mail Mapped Extensions request with invalid VOICEMAILID.

Voice Mail Mapped Extensions

List of Voice Mail Mapped Extensions request with valid VOICEMAILID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAIL',
'ACTION' => 'MAPPEDEXTENSION',
'DATA' => Array("VOICEMAILID"=>"2"));
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"subscriber_id":"19","usern
ame":"1_1234"},{"subscriber_id":"20","username":"1_8547"},{"subscriber
_id":"22","username":"1_Testextension"},{"subscriber_id":"23","username
":"1_cccvv"},{"subscriber_id":"28","username":"1_896547"},{"subscriber_i
d":"29","username":"1_12345"},{"subscriber_id":"43","username":"1_gsdf
gsdfg"},{"subscriber_id":"45","username":"1_123456987"},{"subscriber_id
":"46","username":"1_xyzabc"},{"subscriber_id":"47","username":"1_xycre
dit"},{"subscriber_id":"65","username":"1_5689913"},{"subscriber_id":"67
","username":"1_568993"},{"subscriber_id":"68","username":"1_5689149
3"}],"MESSAGE":""}}

Queues

Queues request SECTION parameters should be as ''QUEUES'

QUEUEID - Queue Id accepts integers

QUEUENAME - Queue Name which allows alphanumeric,_ and dot(.).

Voxucs1.0.1 API 95
VOXVALLEY
QUEUEMOH - Queue MOH
RINGTIMEOUT - Ring Time Out
RECORDING - Queue Recording accepting 1 or 0 as input
RETRY - Retry
ANNOUNCEMENT - Welcome Announcement accepting Announcement Dropdown List key as input
CLIPREFIXNAME - CLI Prefix Name
STRATEGY - Strategy accepting Queue Strategy Dropdown List key or value as input
WEIGHT - Weight accepting Queue Weight Dropdown List key or value as input

Response Parameters

RESULTLIST - Holding all added Queues data

QUEUEID - Queue Id accepts integers.
QUEUENAME - Queue Name which allows alphanumeric,_, and dot(.).
QUEUEMOH - Queue MOH name
ANNOUNCEMENT - Welcome Announcement displays Announcement Dropdown List value
CLIPREFIXNAME - CLI Prefix Name
STRATEGY - Strategy displays Queue Strategy Dropdown List value.
WEIGHT - Weight displays Queue Weight Dropdown List value.
RETRY - Retry

Queues listing request

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"QUEUEID":"6","QUEUENA
ME":"Thresholdqueue","QUEUEMOH":"frdas","ANNOUNCEMENT":"","CLIP
REFIXNAME":"91","STRATEGY":"roundrobin","WEIGHT":"1","RETRY":"20"},
{"QUEUEID":"2","QUEUENAME":"testquename","QUEUEMOH":"mohtest",
"ANNOUNCEMENT":"testannouncement","CLIPREFIXNAME":"92","STRATE
GY":"roundrobin","WEIGHT":"1","RETRY":"2"},{"QUEUEID":"1","QUEUENA
ME":"Voxdevelopment","QUEUEMOH":"mohtest","ANNOUNCEMENT":"","
CLIPREFIXNAME":"dev","STRATEGY":"ringall","WEIGHT":"1","RETRY":"15"}]
,"MESSAGE":""}}

Queues listing with empty data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 96
VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'LIST');
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"No Data."}}

Add Queues

Add Queues request with QUEUENAME empty.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "x3",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME is not valid"}}

Add Queues request with QUEUENAME containing less than 4 characters.

Voxucs1.0.1 API 97
VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must consist of at
least 4 characters."}}

Add Queues request with QUEUENAME containing more than 20 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "x565555555248hhhhshhhh",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must not exceed
more than 20 characters."}}

Add Queues request with invalid QUEUENAME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "$ggsgssg ddddd",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME allows
alphanumeric,_ and dot(.)."}}

Add Queues request with invalid QUEUENAME

Voxucs1.0.1 API 98
VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "@@#ggsgssg ddddd",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME allows
alphanumeric,_ and dot(.)."}}

Add Queues request with duplicate QUEUENAME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "54545",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must contain a
unique value."}}

Add Queues request with empty QUEUEMOH.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 99
VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEMOH is not valid"}}

Add Queues request with invalid QUEUEMOH.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5689793",
"RINGTIMEOUT" => "10",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEMOH is not valid"}}

Queue MOH Dropdown List

Below request examples to fetch MOH list.

Here DATA -> RESULTLIST contains Queue MOH id as key and Queue MOH display name as value
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'MOHDROPDOWN',
'ACTION' => 'LIST');

Voxucs1.0.1 API 100

VOXVALLEY
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"5":"frdas","6":"hhhh","3":"
Moh457","2":"mohtest"},"MESSAGE":""}}

Add Queues request with invalid RINGTIMEOUT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "1ssss0",
"RECORDING" => "0",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGTIMEOUT allows
numeric."}}

Add Queues request with invalid RECORDING

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "5",
"RETRY" => "IVR",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RECORDING is not valid"}}

Add Queues request with invalid RETRY

Voxucs1.0.1 API 101

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "abc",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RETRY allows numeric."}}

Add Queues request with invalid ANNOUNCEMENT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "aa2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ANNOUNCEMENT is not valid"}}

Queue Announcement Dropdown List

Below request examples to fetch Announcement list.

Here DATA -> RESULTLIST contains Queue Announcement id as key and Queue Announcement display
name as value.

Type Detail

Voxucs1.0.1 API 102

VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'ANNOUNCEMENTDROPDOWN',

'ACTION' => 'LIST');

OutPut
{"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"3":"ccccc","2":"testannoun
cement"},"MESSAGE":""}}

Add Queues request with CLIPREFIXNAME containing more than 6 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "1245",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CLIPREFIXNAME must not
exceed more than 6 characters."}}

Add Queues request with invalid STRATEGY.

Voxucs1.0.1 API 103

VOXVALLEY
"STRATEGY"=>"roussssssssssssndrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STRATEGY is not valid"}}

Queue Strategy Dropdown List

Below request examples to fetch Strategy list.

Here DATA -> RESULTLIST contains Queue Strategy as key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'STRATEGYDROPDOWN',

'ACTION' => 'LIST');

OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"roundrobin":"roundrobin","
leastrecent":"leastrecent","fewestcalls":"fewestcalls","random":"random",
"ringall":"ringall"},"MESSAGE":""}}

Add Queues request with invalid WEIGHT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"0"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"WEIGHT is not valid"}}

Queue Weight Dropdown List

Below request examples to fetch Weight list.

Voxucs1.0.1 API 104

VOXVALLEY

Here DATA -> RESULTLIST contains Queue Weight as key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'WEIGHTDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"1","2":"2","3":"3","4":"
4","5":"5","6":"6","7":"7","8":"8","9":"9","10":"10"},"MESSAGE":""}}

Add Queues request with valid data.

QUEUEMOH should contain Queue MOH id as input,

ANNOUNCEMENT should contain Queue Announcement id as input,
STRATEGY should contain Queue Strategy key or value as input.
WEIGHT should contain Queue weight key or value as input.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'ADD',
'DATA' => Array("QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"SUCCESS","DATA":{"QUEUEID":"8","MESSAGE":"Queue data
has been created successfully."}}

Update Queue

Update Queue request with empty QUEUEID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 105

VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"",
"QUEUENAME" => "xyzabcs",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Update Queue request with invalid QUEUEID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"0",
"QUEUENAME" => "xyzabcs",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Update Queue request with invalid QUEUEID

Voxucs1.0.1 API 106

VOXVALLEY
"QUEUENAME" => "xyzabcs",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Update Queue request with QUEUENAME containing less than 4 characters

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"QUEUENAME" => "xyz",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must consist of at
least 4 characters."}}

Update Queue request with QUEUENAME containing more than 20 characters.

Voxucs1.0.1 API 107

VOXVALLEY
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));

OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must not exceed

more than 20 characters."}}

Update Queue request with duplicate QUEUENAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"QUEUENAME" => "545452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "10",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUENAME must contain a
unique value."}}

Update Queue request with invalid QUEUEMOH.

Voxucs1.0.1 API 108

VOXVALLEY
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEMOH is not valid"}}

Update Queue request with invalid RINGTIMEOUT.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"QUEUENAME" => "54512452",
"QUEUEMOH" => "5",
"RINGTIMEOUT" => "1s0",
"RECORDING" => "1",
"RETRY" => "123",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RINGTIMEOUT allows
numeric."}}

Update Queue request with invalid ANNOUNCEMENT.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"ANNOUNCEMENT" => "2",
"CLIPREFIXNAME" => "xyxy",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ANNOUNCEMENT is not valid"}}

Update Queue request with invalid CLIPREFIXNAME.

Voxucs1.0.1 API 109

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"CLIPREFIXNAME" => "xyxy11222222",
"STRATEGY"=>"roundrobin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CLIPREFIXNAME must not
exceed more than 6 characters."}}

Update Queue request with invalid STRATEGY.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"STRATEGY"=>"roundro11bin",
"WEIGHT"=>"1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STRATEGY is not valid"}}

Update Queue request with empty WEIGHT.

Update Queue request with valid WEIGHT.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 110

VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"WEIGHT"=>"2"));
OutPut {"STATUS":"SUCCESS","DATA":{"QUEUEID":1,"MESSAGE":"Queue data has
been updated successfully."}}

Update Queue request with valid QUEUENAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'EDIT',
'DATA' => Array("QUEUEID"=>"13",
"QUEUENAME" => "4221154"));
OutPut {"STATUS":"SUCCESS","DATA":{"QUEUEID":1,"MESSAGE":"Queue data has
been updated successfully."}}

Queue Agent Map

QUEUEID - Queue Id of Queues drop down List

AGENTID - Agent I'd accept integers only
EXTENSIONID - Extension id of Extension dropdown List
PENALTY - Penalty accepts key or value from Penalty Drop down list

Response Parameters

RESULTLIST - Holding tenant agent data

QUEUEID - Queue Id of Queues drop down List
AGENTID - Agent I'd accept integers only
EXTENSIONID - Extension id of Extension dropdown List
PENALTY - Penalty accepts key or value from Penalty Drop down list

Request for Agent listing

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'AGENTLIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"AGENTID":"10","EXTENSION":"854
7","QUEUE":"testquename","PENALTY":"2"},{"AGENTID":"9","EXTENSION":"1234",

Voxucs1.0.1 API 111

VOXVALLEY
"QUEUE":"testquename","PENALTY":"1"},{"AGENTID":"8","EXTENSION":"789456",
"QUEUE":"testquename","PENALTY":"1"},{"AGENTID":"7","EXTENSION":"159951",
"QUEUE":"testquename","PENALTY":"1"},{"AGENTID":"6","EXTENSION":"789456",
"QUEUE":"Voxdevelopment","PENALTY":"1"},{"AGENTID":"5","EXTENSION":"1471
47","QUEUE":"testquename","PENALTY":"1"},{"AGENTID":"4","EXTENSION":"3693
69","QUEUE":"testquename","PENALTY":"1"},{"AGENTID":"3","EXTENSION":"3693
69","QUEUE":"Voxdevelopment","PENALTY":"1"},{"AGENTID":"2","EXTENSION":"1
47147","QUEUE":"Voxdevelopment","PENALTY":"2"},{"AGENTID":"1","EXTENSION
":"159951","QUEUE":"Voxdevelopment","PENALTY":"1"}],"MESSAGE":""}}

Queues drop down List

Request for Queue list

Here DATA -> RESULTLIST contains queue id as key and queue display name as value.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUESDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"Voxdevelopment","2":"testque
name","6":"Thresholdqueue","7":"54545","8":"545452","9":"5451452","10":"545
23452","11":"54452","12":"42252"},"MESSAGE":""}}

Extension drop down List

Request for Extension list

Response Parameters

RESULTLIST - Holding all the extensions data under-tenant.

Here DATA -> RESULTLIST contains Extension id as key and Extension display name as value.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'AGENTEXTENSIONDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"147147","12":"159951","16":"3
69369","17":"789456","19":"1234","20":"8547","22":"Testextension","23":"cccvv"
,"28":"896547","29":"12345","43":"gsdfgsdfg","45":"123456987","46":"xyzabc","4

Voxucs1.0.1 API 112

VOXVALLEY
7":"xycredit","65":"5689913","67":"568993","68":"56891493","70":"testextension
2","93":"1_user1","100":"ananddayal","101":"ananddayal","102":"ananddayal"},"
MESSAGE":""}}

Penalty dropdown List

Request for Penalty list.

Here DATA -> RESULTLIST contains penalty as key and value.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'PENALTYDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"1","2":"2","3":"3","4":"4","5":"
5","6":"6","7":"7","8":"8","9":"9","10":"10"},"MESSAGE":""}}

Request for map Agent(Extension) to Queue with invalid QUEUEID.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'MAPPAGENT',
'DATA' => Array("QUEUEID" => "1ss",
"EXTENSIONID" => "2",
"PENALTY" => "1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Request for map Agent(Extension) to Queue with invalid EXTENSIONID.

Voxucs1.0.1 API 113

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"EXTENSIONID is not valid."}}

Request for map Agent(Extension) to Queue with invalid PENALTY.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'MAPPAGENT',
'DATA' => Array("QUEUEID" => "1",
"EXTENSIONID" => "23",
"PENALTY" => "1ss"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"PENALTY is not valid."}}

Request with duplicate map of Agent(Extension) to Queue.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'MAPPAGENT',
'DATA' => Array("QUEUEID" => "1",
"EXTENSIONID" => "2",
"PENALTY" => "1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Duplicate entry of QUEUEID and
EXTENSIONID combination."}}

Request for map of Agent(Extension) to Queue with valid data.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'MAPPAGENT',
'DATA' => Array("QUEUEID" => "1",
"EXTENSIONID" => "23",
"PENALTY" => "1"));
OutPut {"STATUS":"SUCCESS","DATA":{"AGENTQUEUEID":"11","MESSAGE":"Agent has
been created successfully."}}

Request to delete Agent with invalid AGENTID.

Voxucs1.0.1 API 114

VOXVALLEY

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'AGENTDELETE',
'DATA' => Array("AGENTID" => "12aa"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"AGENTID is not valid."}}

Request to delete Agent with valid data.

Type Detail
API Request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'AGENTDELETE',
'DATA' => Array("AGENTID" => "12"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Agent Data has been deleted
successfully."}}

Delete Queue

Delete Queue request with empty QUEUEID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'DELETE',
'DATA' => Array("QUEUEID"=>""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Delete Queue request with invalid QUEUEID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'DELETE',

Voxucs1.0.1 API 115

VOXVALLEY
'DATA' => Array("QUEUEID"=>"2566"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"QUEUEID is not valid."}}

Delete Queue request with valid QUEUEID which is mapped to DID.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'DELETE',
'DATA' => Array("QUEUEID"=>"2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Queues is Mapped
To Announcements:0 IVR:0 DID:1 Day Night:0 Agents:0"}}

Delete Queue request with valid QUEUEID which not mapped to any features.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUES',
'ACTION' => 'DELETE',
'DATA' => Array("QUEUEID"=>"2"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Queues Data has been
deleted successfully."}}

Conference

Conference request SECTION parameters should be as 'CONFERENCE'.

CONFERENCEID - Conference id accepts only integers

CONFERENCENUMBER - Conference Number accepts integer and “*”
MAXMEMBERS - Conference Max. Members
ADMINSECRET - Admin PIN
USERSECRET - PIN
STARTTIME - Conference Start Time
ENDTIME - Conference End Time
RECORDING- Conference Recording accepting 1 or 0 as input

Response Parameters

Voxucs1.0.1 API 116

VOXVALLEY
RESULTLIST - Holding all added Conference data
CONFERENCEID - Conference id accepts only integers
CONFERENCENUMBER - Conference Number
STARTTIME - Conference Start Time
ENDTIME - Conference End Time
MAXMEMBERS - Conference Max. Members
ADMINSECRET - Admin PIN
USERSECRET - PIN

Conference listing request

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"CONFERENCEID":"1","CON
FERENCENUMBER":"1666","STARTTIME":"2016-01-01
00:00:00","ENDTIME":"2016-01-02
05:00:00","MAXMEMBERS":"3","ADMINSECRET":"12345","USERSECRET":"
12345"},{"CONFERENCEID":"7","CONFERENCENUMBER":"123477","START
TIME":"2015-12-02 16:38:21","ENDTIME":"2015-12-02
22:00:00","MAXMEMBERS":"123","ADMINSECRET":"2344","USERSECRET":
"344455"},{"CONFERENCEID":"6","CONFERENCENUMBER":"12345*634","S
TARTTIME":"2015-12-02 16:28:18","ENDTIME":"2015-12-02
20:00:00","MAXMEMBERS":"1234","ADMINSECRET":"3455","USERSECRET"
:"1234567"},{"CONFERENCEID":"3","CONFERENCENUMBER":"1233455","S
TARTTIME":"2015-12-02 12:57:21","ENDTIME":"2015-12-02
13:00:00","MAXMEMBERS":"123","ADMINSECRET":"1234","USERSECRET":
"2345"},{"CONFERENCEID":"2","CONFERENCENUMBER":"12334","STARTTI
ME":"2015-12-02 12:49:47","ENDTIME":"2015-12-02
19:14:14","MAXMEMBERS":"1233","ADMINSECRET":"2222","USERSECRET"
:"2222"}],"MESSAGE":""}}

Conference listing with empty data

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user12',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'LIST');

Voxucs1.0.1 API 117

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"No Data."}}

Add Conference

Add Conference request with CONFERENCENUMBER empty

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER is not
valid"}}

Add Conference request with CONFERENCENUMBER containing less than 3 characters

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "1",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must
consist of at least 3 digits."}}

Add Conference request with CONFERENCENUMBER containing more than 10 characters

Type Detail

Voxucs1.0.1 API 118

VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" =>
"1222222222222222222222222",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must not
exceed more than 10 digits."}}

Add Conference request with invalid CONFERENCENUMBER

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "dfsdfas",
"MAXMEMBERS" => "sdfsdf",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER is not
valid."}}

Add Conference request with duplicate CONFERENCENUMBER

Voxucs1.0.1 API 119

VOXVALLEY
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must
contain a unique value."}}

Add Conference request with empty MAXMEMBERS

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS is not valid"}}

Add Conference request with invalid MAXMEMBERS containing more than 4 characters

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "ghhhhh",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS must not
exceed more than 4 digits."}}

Add Conference request with invalid MAXMEMBERS

Voxucs1.0.1 API 120

VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "ghhh",
"ADMINSECRET" => "10",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS allows
numeric."}}

Add Conference request with empty ADMINSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET is not valid"}}

Add Conference request with invalid ADMINSECRET.

Voxucs1.0.1 API 121

VOXVALLEY
"ADMINSECRET" => "ffff",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET allows
numeric."}}

Add Conference request with invalid ADMINSECRET containing less than 4 digits.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "455",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET must consist of
at least 4 digits."}}

Add Conference request with empty USERSECRET.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET is not valid"}}

Add Conference request with invalid USERSECRET.

Voxucs1.0.1 API 122

VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "aaaa",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET allows numeric."}}

Add Conference request with invalid USERSECRET containing less than 4 digits

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4555",
"USERSECRET" => "1",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET must consist of at
least 4 digits."}}

Add Conference request with empty STARTTIME

Voxucs1.0.1 API 123

VOXVALLEY
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME is not valid"}}

Add Conference request with invalid STARTTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "123",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME is not valid.Please
provide valid date format as 'YYYY-mm-dd H:i:s'(Ex - '2016-01-12
08:38:14')."}}

Add Conference request with STARTTIME less than current date

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-11 08:38:14",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));

Voxucs1.0.1 API 124

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME should be greater
than current date."}}

Add Conference request with empty ENDTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME is not valid"}}

Add Conference request with invalid ENDTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "2",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME is not valid.Please
provide valid date format as 'YYYY-mm-dd H:i:s'(Ex - '2016-01-12
08:38:14')."}}

Add Conference request with ENDTIME less than the current date.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 125

VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "2016-01-11 08:38:14",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME should be greater
than current date."}}

Add Conference request with ENDTIME less than STARTTIME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "2016-01-12 08:25:14",
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME should be greater
than STARTTIME."}}

Add Conference request with invalid RECORDING

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "2016-01-12 09:40:14",

Voxucs1.0.1 API 126

VOXVALLEY
"RECORDING" => "xyxy"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RECORDING is not valid"}}

Add Conference request with valid data

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'ADD',
'DATA' => Array("CONFERENCENUMBER" => "6599",
"MAXMEMBERS" => "5",
"ADMINSECRET" => "4155",
"USERSECRET" => "5266",
"STARTTIME" => "2016-01-12 08:38:14",
"ENDTIME" => "2016-01-12 09:40:14",
"RECORDING" => "1"));
OutPut {"STATUS":"SUCCESS","DATA":{"CONFERENCEID":"9","MESSAGE":"Confere
nce data has been created successfully."}}

Update Conference

Update Conference request with CONFERENCEID empty

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"",
"CONFERENCENUMBER" => "56"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCEID is not valid."}}

Update Conference request with CONFERENCENUMBER empty

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',

Voxucs1.0.1 API 127

VOXVALLEY
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"CONFERENCENUMBER" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER is not
valid"}}

Update Conference request with CONFERENCENUMBER containing less than 3 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"CONFERENCENUMBER" => "45"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must
consist of at least 3 digits."}}

Update Conference request with CONFERENCENUMBER containing more than 10 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"CONFERENCENUMBER" => "2345678456344"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must not
exceed more than 10 digits."}}

Update Conference request with invalid CONFERENCENUMBER.

Voxucs1.0.1 API 128

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER is not
valid."}}

Update Conference request with duplicate CONFERENCENUMBER.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"CONFERENCENUMBER" => "1666"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCENUMBER must
contain a unique value."}}

Update Conference requests with empty MAXMEMBERS.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"MAXMEMBERS" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS is not valid"}}

Update Conference request with invalid MAXMEMBERS containing more than 4 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"MAXMEMBERS" => "2356666"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS must not
exceed more than 4 digits."}}

Update Conference request with invalid MAXMEMBERS

Voxucs1.0.1 API 129

VOXVALLEY

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"MAXMEMBERS" => "ddd"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"MAXMEMBERS allows
numeric."}}

Update Conference request with empty ADMINSECRET

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ADMINSECRET" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET is not valid"}}

Update Conference request with invalid ADMINSECRET

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ADMINSECRET" => "dffss"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET allows
numeric."}}

Update Conference request with invalid ADMINSECRET containing less than 4 digits

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 130

VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ADMINSECRET" => "1"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ADMINSECRET must consist of
at least 4 digits."}}

Update Conference request with empty USERSECRET

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"USERSECRET" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET is not valid"}}

Update Conference request with invalid USERSECRET

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"USERSECRET" => "ffffs"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET allows numeric."}}

Update Conference request with invalid USERSECRET containing less than 4 digits

Voxucs1.0.1 API 131

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"USERSECRET must consist of at
least 4 digits."}}

Update Conference request with empty STARTTIME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"STARTTIME" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME is not valid"}}

Update Conference request with invalid STARTTIME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"STARTTIME" => "4"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME is not valid.Please
provide valid date format as 'YYYY-mm-dd H:i:s'(Ex - '2016-01-12
08:38:14')."}}

Update Conference request with STARTTIME less than current date

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"STARTTIME" => "2016-01-11 08:38:14"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME should be greater
than current date."}}

Voxucs1.0.1 API 132

VOXVALLEY
Update Conference request with STARTTIME greater than ENDTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"STARTTIME" => "2016-01-12 09:40:14"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"STARTTIME should be greater
than current date."}}

Update Conference request with empty ENDTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ENDTIME" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME is not valid"}}

Update Conference request with invalid ENDTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ENDTIME" => "25"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME is not valid.Please
provide valid date format as 'YYYY-mm-dd H:i:s'(Ex - '2016-01-12
08:38:14')."}}

Update Conference request with ENDTIME less than current date

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 133

VOXVALLEY
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ENDTIME" => "2016-01-11 08:38:14"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME should be greater
than current date."}}

Update Conference request with ENDTIME less than STARTTIME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"ENDTIME" => "2016-01-12 03:38:14"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"ENDTIME should be greater
than STARTTIME."}}

Update Conference request with invalid RECORDING

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"RECORDING" => "34"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RECORDING is not valid"}}

Update Conference request with valid data

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'EDIT',
'DATA' => Array("CONFERENCEID"=>"9",
"CONFERENCENUMBER" => "6591*9",
"MAXMEMBERS" => "4",
"ADMINSECRET" => "4255",
"USERSECRET" => "5216",
"STARTTIME" => "2016-01-12 08:38:14",

Voxucs1.0.1 API 134

VOXVALLEY
"ENDTIME" => "2016-01-12 09:40:14",
"RECORDING" => "1"));
OutPut {"STATUS":"SUCCESS","DATA":{"CONFERENCEID":"9","MESSAGE":"Confere
nce data has been updated successfully."}}

Delete Conference
Delete Conference request with empty CONFERENCEID
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'DELETE',
'DATA' => Array("CONFERENCEID"=>""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"CONFERENCEID is not valid."}}

Delete Conference request with invalid CONFERENCEID

Delete Conference request with mapped CONFERENCEID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'DELETE',
'DATA' => Array("CONFERENCEID"=>"8"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"Conference is Mapped To IVR
Options:3 DID:1 Day Night:1 "}}

Delete Conference request with valid CONFERENCEID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 135

VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCE',
'ACTION' => 'DELETE',
'DATA' => Array("CONFERENCEID"=>"9"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"Conference Data has been
deleted successfully."}}

GET Sound List

GET Sound List request SECTION parameters should be as 'SOUNDSDROPDWON'

Sounds Dropdown List

Request for Sounds list

Response Parameters

RESULTLIST - Holding all added Sounds data as key and value, where key holds sound id and value holds
sound name.

Here DATA -> RESULTLIST contains Sound id as key and Sound display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'SOUNDSDROPDWON',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"Soundname"},"MESSAG
E":""}}

IVR

IVR request SECTION parameters should be as 'IVR'

IVRID - IVR Id accepts integers

IVRNAME - IVR Name allows alphanumeric
IVRDESCRIPTION - IVR Description
RETRY - Retry accepting IVR Retry Dropdown List key or value as input
IVRMESSAGESOUNDID - IVR Voice Message accepting IVR Sounds Dropdown List key as input
DTMFWAITTIME - DTMF Wait Time accepting IVR DTMF Wait Time Dropdown List key as input

Response Parameters

Voxucs1.0.1 API 136

VOXVALLEY

RESULTLIST - Holding all added IVR data

IVRID - IVR Id accepts integers
IVRNAME - IVR Name allows alphanumeric
IVRDESCRIPTION - IVR Description
RETRY - Retry accepting IVR Retry Dropdown List key or value as input
IVRMESSAGE - IVR Voice Message displays IVR Sounds Dropdown List value
DTMFWAITTIME - DTMF Wait Time displays IVR DTMF Wait Time Dropdown List value as input
IVR listing request.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"IVRID":"4","IVRNAME":"sa
mpleivrthree","IVRDESCRIPTION":"testdes","RETRY":"2","IVRMESSAGE":"S
oundname","DTMFWAITTIME":"10"},"MESSAGE":""}}

IVR listing with empty data.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user12',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'LIST');
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"No Data."}}

Add IVR

Add IVR request with empty IVRNAME.

Voxucs1.0.1 API 137

VOXVALLEY
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME is not valid"}}

Add IVR request with invalid IVRNAME containing less than 3 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "s",
"IVRDESCRIPTION" => "5",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must consist of at
least 3 characters."}}

Add IVR request with invalid IVRNAME containing more than 20 characters.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "8956666666666666666666",
"IVRDESCRIPTION" => "5",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must not exceed
more than 20 characters."}}

Add IVR request with invalid IVRNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',

Voxucs1.0.1 API 138

VOXVALLEY
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "aaaaa#$$$$$$",
"IVRDESCRIPTION" => "5",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME allows alpha
numeric."}}

Add IVR request with duplicate IVRNAME.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr2",
"IVRDESCRIPTION" => "5",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must contain a
unique value."}}

Add IVR request with invalid IVRDESCRIPTION.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "fff@@ 7",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRDESCRIPTION allows
alphanumeric, _ and space dot(.)."}}

Add IVR request with empty RETRY.

Voxucs1.0.1 API 139

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "abc",
"RETRY" => "",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RETRY is not valid"}}

Add IVR request with invalid RETRY.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "abc",
"RETRY" => "4155",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"RETRY is not valid"}}

IVR Retry Dropdown List

Below request examples of Retry list

Here DATA -> RESULTLIST contains IVR Retry as key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RETRYROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"1","2":"2","3":"3","4":"
4","5":"5","6":"6"},"MESSAGE":""}}

Add IVR request with invalid IVRMESSAGE and RETRY contains IVR Retry Dropdown List key or value

Voxucs1.0.1 API 140

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "abc",
"RETRY" => "1",
"IVRMESSAGESOUNDID" => "5266",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRMESSAGESOUNDID is not
valid"}}

IVR Sounds Dropdown List

Below request examples of Sounds list.

Here DATA -> RESULTLIST contains Sound id as key and Sound display name as value

Add IVR request with invalid DTMFWAITTIME and IVRMESSAGE contains IVR Sounds Dropdown List keys
as valid IVRMESSAGE input.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "abc",
"RETRY" => "1",
"IVRMESSAGESOUNDID" => "2",
"DTMFWAITTIME" => "2d"));

Voxucs1.0.1 API 141

VOXVALLEY
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DTMFWAITTIME is not valid"}}

IVR DTMF Wait Time Dropdown List

Below request examples of DTMF Wait Time list.

Here DATA -> RESULTLIST contains DTMF Wait Time as key and value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'DTMFWAITTIMEDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"10":"10 Sec","20":"20
Sec","30":"30 Sec","40":"40 Sec","60":"60 Sec","90":"90 Sec","120":"120
Sec"},"MESSAGE":""}}

Add IVR request with valid data

RETRY should contain Queue Retry key or value as input,

IVRMESSAGESOUNDID should contain IVR Sound-id (i.e key) as input.
DTMFWAITTIME should contain IVR DTMF Wait Time key as input,

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'ADD',
'DATA' => Array("IVRNAME" => "sampleivr212",
"IVRDESCRIPTION" => "abc",
"RETRY" => "1",
"IVRMESSAGESOUNDID" => "2",
"DTMFWAITTIME" => "20"));
OutPut {"STATUS":"SUCCESS","DATA":{"IVRID":"6","MESSAGE":"IVR data has been
created successfully."}}

Update IVR

Update IVR requests with empty IVRID

Voxucs1.0.1 API 142

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"",
"IVRNAME" => "sampleivr212"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Update IVR requests with invalid IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"4444",
"IVRNAME" => "sampleivr212"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Update IVR requests with empty IVRNAME

Update IVR requests with invalid IVRNAME containing less than 3 characters

Voxucs1.0.1 API 143

VOXVALLEY
"IVRNAME" => "2"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must consist of at
least 3 characters."}}

Update IVR requests with invalid IVRNAME containing more than 20 characters

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"IVRNAME" => "8956666666666666666666"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must not exceed
more than 20 characters."}}

Update IVR requests with invalid IVRNAME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"IVRNAME" => "abc$&@@@"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME allows alpha
numeric."}}

Update IVR requests with duplicate IVRNAME

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"IVRNAME" => "sampleimnjn"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRNAME must contain a
unique value."}}

Voxucs1.0.1 API 144

VOXVALLEY

Update IVR requests with invalid IVRDESCRIPTION

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"IVRDESCRIPTION" => "fff@@ 7"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRDESCRIPTION allows
alphanumeric, _ and space dot(.)."}}

Update IVR requests with empty RETRY

Update IVR requests with invalid RETRY

IVR Retry Dropdown List

Below request examples of Retry list.

Here DATA -> RESULTLIST contains IVR Retry as key and value.

Voxucs1.0.1 API 145

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RETRYROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"1","2":"2","3":"3","4":"
4","5":"5","6":"6"},"MESSAGE":""}}

Update IVR request with invalid IVRMESSAGE and RETRY contains IVR Retry Dropdown List key or value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"RETRY" => "1",
"IVRMESSAGESOUNDID" => "2aa"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRMESSAGESOUNDID is not
valid"}}

IVR Sounds Dropdown List

Below request examples of Sounds list.

Here DATA -> RESULTLIST contains Sound id as key and Sound display name as value.

Update IVR request with invalid DTMFWAITTIME and IVRMESSAGE contains IVR Sounds Dropdown List
keys as valid IVRMESSAGE input.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php

Voxucs1.0.1 API 146

VOXVALLEY
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"5",
"IVRMESSAGESOUNDID" => "2",
"DTMFWAITTIME" => "2d"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DTMFWAITTIME is not valid"}}

IVR DTMF Wait Time Dropdown List

Below request examples of DTMF Wait Time list.

Here DATA -> RESULTLIST contains DTMF Wait Time as key and value.

Update IVR requests with valid data

RETRY should contain Queue Retry key or value as input,
IVRMESSAGESOUNDID should contain IVR Sounds id(i.e key) as input.
DTMFWAITTIME should contain IVR DTMF Wait Time key as input,

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'EDIT',
'DATA' => Array("IVRID"=>"6",
"IVRNAME" => "sampleivr2122",
"IVRDESCRIPTION" => "abc",
"RETRY" => "1",
"IVRMESSAGESOUNDID" => "2",
"DTMFWAITTIME" => "20"));
OutPut {"STATUS":"SUCCESS","DATA":{"IVRID":"6","MESSAGE":"IVR data has been
updated successfully."}}

Voxucs1.0.1 API 147

VOXVALLEY

Add IVR Option

IVRID - IVR id
OPTIONINPUT - user press input for Destination app access
IVRDESTAPP - Destination App accepting IVR Destination App Dropdown List key as input
DESTINATIONNUMBER - Destination number accepting Extension Dropdown List key as input when
IVRDESTAPP="EXTENSION", Ring group Dropdown List key as input when IVRDESTAPP="RINGGROUP"
etc.....

Add IVR Options request with empty IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "",
"OPTIONINPUT" => "1",
"IVRDESTAPP" => "",
"DESTINATIONNUMBER" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Add IVR Options request with invalid IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "2226",
"OPTIONINPUT" => "aaa",
"IVRDESTAPP" => "HANGUP",
"DESTINATIONNUMBERID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Add IVR Options request with empty OPTIONINPUT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 148

VOXVALLEY
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "",
"IVRDESTAPP" => "",
"DESTINATIONNUMBER" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"OPTIONINPUT is not valid."}}

Add IVR Options request with invalid OPTIONINPUT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "aaa",
"IVRDESTAPP" => "HANGUP",
"DESTINATIONNUMBERID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"OPTIONINPUT allows
numeric."}}

Add IVR Options request with invalid OPTIONINPUT

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "0",
"IVRDESTAPP" => "HANGUP",
"DESTINATIONNUMBERID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"OPTIONINPUT is not valid"}}

Add IVR Options request with empty IVRDESTAPP

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),

Voxucs1.0.1 API 149

VOXVALLEY
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "1",
"IVRDESTAPP" => "",
"DESTINATIONNUMBERID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRDESTAPP is not valid"}}

Add IVR Options request with invalid IVRDESTAPP

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "1",
"IVRDESTAPP" => "aaaaaaa",
"DESTINATIONNUMBERID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRDESTAPP is not valid"}}

IVR Destination App Dropdown List

Request for Destination App Waits Time list

Here DATA -> RESULTLIST contains Destination App as key and value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVRFAILOVER',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"HANGUP":"HANGUP","EXTE
NSION":"EXTENSION","RINGGROUP":"RINGGROUP","ANNOUNCEMENT":"
ANNOUNCEMENT","IVR":"IVR","VOICEMAIL":"VOICEMAIL","CONFERENCE"
:"CONFERENCE","QUEUE":"QUEUE"}}}

Add IVR Option request with invalid DESTINATIONNUMBERID and IVRDESTAPP contains IVR Destination
App Dropdown List key or value as valid IVRDESTAPP input.

Type Detail

Voxucs1.0.1 API 150

VOXVALLEY
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "1",
"IVRDESTAPP" => "EXTENSION",
"DESTINATIONNUMBERID" => "ssss"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"DESTINATIONNUMBERID is not
valid"}}

IVR Extension Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value

IVR Announcement Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'ANNOUNCEMENTDROPDOWN',

Voxucs1.0.1 API 151

VOXVALLEY
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"3":"ccccc","2":"testannoun
cement"},"MESSAGE":""}}

IVR Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVRDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"5":"dgdfg","2":"sampleimnj
n","3":"sampleivr2","6":"sampleivr2122","4":"sampleivrthree"},"MESSAGE
":""}}

IVR Voice mail Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'VOICEMAILDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"2":"1234","3":"159951","6"
:"sss","7":"fffff","13":null,"14":"xyxyyyyy"},"MESSAGE":""}}

IVR Conference Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 152

VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'CONFERENCEDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"1666","2":"12334","3":
"1233455","6":"12345*634","7":"123477","8":"455555"},"MESSAGE":""}}

IVR Ring group Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value.

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'RINGGROUPDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"4":"dddddf","28":"dfdf","24
":"dfdfgd","20":"dfdgd","16":"dfdgf","19":"dfgdgfg","18":"dgdfgf","6":"dgf
gf","26":"dgfgfgf","27":"dgfgfhgh","14":"fdfd","15":"fdfgsd","12":"fdfhg","
25":"fdgfg","13":"fgfgf","11":"fgfhgh","10":"fhfghgh","8":"fhfhg","9":"gfhf"
,"5":"gsdgfd","21":"sdfsfd","23":"sdsafd","17":"sdsfdf","22":"sfasfdf","2":"
testRG","7":"vcbvb"},"MESSAGE":""}}

IVR Queues Destination number Dropdown List

Request for Destination number list

Here DATA -> RESULTLIST contains Destination numbers id as key and destination display name as value

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'QUEUESDROPDOWN',
'ACTION' => 'LIST');
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":{"1":"Voxdevelopment","2":"
testquename","6":"Thresholdqueue","7":"54545","8":"545452","9":"5451
452","10":"54523452","11":"54452","12":"42252"},"MESSAGE":""}}

Add IVR Option request with valid DESTINATIONNUMBERID contains IVR Extension Destination number
Dropdown List key as valid IVRDESTAPP input.

Voxucs1.0.1 API 153

VOXVALLEY
Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'IVROPTIONS',
'DATA' => Array("IVRID" => "6",
"OPTIONINPUT" => "1",
"IVRDESTAPP" => "EXTENSION",
"DESTINATIONNUMBERID" => "2"));
OutPut {"STATUS":"SUCCESS","DATA":{"IVRID":"6","MESSAGE":"IVR Option data
has been created successfully."}}

Delete IVR

Delete IVR request with empty IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'DELETE',
'DATA' => Array("IVRID" => ""));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Delete IVR request with invalid IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'DELETE',
'DATA' => Array("IVRID" => "4444"));
OutPut {"STATUS":"FAILED","DATA":{"MESSAGE":"IVRID is not valid."}}

Delete IVR request with valid IVRID

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',

Voxucs1.0.1 API 154

VOXVALLEY
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'IVR',
'ACTION' => 'DELETE',
'DATA' => Array("IVRID" => "6"));
OutPut {"STATUS":"SUCCESS","DATA":{"MESSAGE":"IVR Data has been deleted
successfully."}}

GET Extension

GET Extension request SECTION parameters should be as 'GETEXTENSIONS'

USERNAME - Extension Username

Response Parameters
RESULTLIST - Holding all the extensions under the same tenant
EXTENSION - Extension name along with tenant id and underscore as a prefix.
USERNAME - Extension Username

Extension listing requests with valid USERNAME and PASSWORD

Type Detail
API request URL http:// Vox UCM server IP /api/api.php
InPut Array('APIUSER' => '1_user1',
‘APIPASSWORD’ => MD5(‘123456’),
'SECTION' => 'EXTENSION',
'ACTION' => 'GETEXTENSIONS',
'DATA' => Array("USERNAME"=>"1_147147"));
OutPut {"STATUS":"SUCCESS","DATA":{"RESULTLIST":[{"EXTENSION":"1_user3","U
SERNAME":"1_user3"},{"EXTENSION":"1_user2","USERNAME":"1_user2"},{
"EXTENSION":"1_user1","USERNAME":"1_user1"},{"EXTENSION":"159951",
"USERNAME":"1_159951"},{"EXTENSION":"testextension2","USERNAME":"
1_testextension2"},{"EXTENSION":"1234","USERNAME":"1_1234"},{"EXTE
NSION":"147147","USERNAME":"1_147147"},{"EXTENSION":"8547","USER
NAME":"1_8547"},{"EXTENSION":"789456","USERNAME":"1_789456"},{"E
XTENSION":"369369","USERNAME":"1_369369"},{"EXTENSION":"5689913"
,"USERNAME":"1_5689913"},{"EXTENSION":"56891493","USERNAME":"1_
56891493"},{"EXTENSION":"568993","USERNAME":"1_568993"},{"EXTENSI
ON":"xycredit","USERNAME":"1_xycredit"},{"EXTENSION":"xyzabc","USER
NAME":"1_xyzabc"},{"EXTENSION":"123456987","USERNAME":"1_123456
987"},{"EXTENSION":"gsdfgsdfg","USERNAME":"1_gsdfgsdfg"},{"EXTENSIO
N":"896547","USERNAME":"1_896547"},{"EXTENSION":"12345","USERNA
ME":"1_12345"},{"EXTENSION":"cccvv","USERNAME":"1_cccvv"},{"EXTENSI
ON":"Testextension","USERNAME":"1_Testextension"}],"MESSAGE":""}}

Voxucs1.0.1 API 155

VOXVALLEY

Extension listing requests with invalid USERNAME

Extension listing request with empty USERNAME

Voxucs1.0.1 API 156

Cyara User Guide 1 PDF
No ratings yet
Cyara User Guide 1 PDF
284 pages
Active Matrimonial CMS Documentation
No ratings yet
Active Matrimonial CMS Documentation
46 pages
QM Developer Api Database Schema Guide Cisco 115
No ratings yet
QM Developer Api Database Schema Guide Cisco 115
233 pages
Five9 Administrator Guide
92% (13)
Five9 Administrator Guide
1,177 pages
Skiza Biashara - Custom Tunes
No ratings yet
Skiza Biashara - Custom Tunes
2 pages
Micontact Center Business
No ratings yet
Micontact Center Business
667 pages
CUCM BK F3AC1C0F 00 Cucm Features Services Guide 100
No ratings yet
CUCM BK F3AC1C0F 00 Cucm Features Services Guide 100
1,158 pages
SRSTCR
No ratings yet
SRSTCR
402 pages
Audiocodes Voip Gateways For Um
No ratings yet
Audiocodes Voip Gateways For Um
85 pages
CME Admin Guide
No ratings yet
CME Admin Guide
1,694 pages
Xivo Solutions Complete Manual
No ratings yet
Xivo Solutions Complete Manual
707 pages
Mizu Voip Server Tutorial PDF
No ratings yet
Mizu Voip Server Tutorial PDF
17 pages
KT-Kshitij
No ratings yet
KT-Kshitij
6 pages
OpenScape Contact Center AgileEnterprise V11 IVR API Integration Guide Issue 1
No ratings yet
OpenScape Contact Center AgileEnterprise V11 IVR API Integration Guide Issue 1
75 pages
Mivoice Mx-One: Overview Guide
No ratings yet
Mivoice Mx-One: Overview Guide
58 pages
Voip or Voice Vlan
No ratings yet
Voip or Voice Vlan
10 pages
Cisco - IOS Voip Configuration Guide
No ratings yet
Cisco - IOS Voip Configuration Guide
1,002 pages
CCVP BK CCA63467 00 Cvp-Configuration-Guide-1101
No ratings yet
CCVP BK CCA63467 00 Cvp-Configuration-Guide-1101
418 pages
B Consolidated Config Guide 3850 Chapter 0100011
No ratings yet
B Consolidated Config Guide 3850 Chapter 0100011
12 pages
NEC Aspire Phone System Manual
No ratings yet
NEC Aspire Phone System Manual
164 pages
Fanvil URL
No ratings yet
Fanvil URL
15 pages
KnowledgeNet Cisco Voice Over IP (CVOICE) 4.2 Student Guide
No ratings yet
KnowledgeNet Cisco Voice Over IP (CVOICE) 4.2 Student Guide
961 pages
Guide To Data Collection - CommCare
No ratings yet
Guide To Data Collection - CommCare
22 pages
Gartners CPaaS Report Nov21
100% (1)
Gartners CPaaS Report Nov21
14 pages
AddPac VoIP Gateway Training Guide
No ratings yet
AddPac VoIP Gateway Training Guide
130 pages
TG400 User Manual
No ratings yet
TG400 User Manual
42 pages
GK982 User Manual 20061030
No ratings yet
GK982 User Manual 20061030
35 pages
WBP Sample-Feasibility
No ratings yet
WBP Sample-Feasibility
96 pages
Vitalpbx Reference Guide Ver. 2.2.2
No ratings yet
Vitalpbx Reference Guide Ver. 2.2.2
233 pages
Uccx - B - 125getting Started Ip Ivr
No ratings yet
Uccx - B - 125getting Started Ip Ivr
110 pages
MiCC - Business Overview Customer Presentation - EN 2023
No ratings yet
MiCC - Business Overview Customer Presentation - EN 2023
82 pages
EERD Lecture5
No ratings yet
EERD Lecture5
29 pages
VitalPBXReferenceGuideVer2EN PDF
No ratings yet
VitalPBXReferenceGuideVer2EN PDF
233 pages
Cisco Ucm 14.0 Sip Configuration Guide
No ratings yet
Cisco Ucm 14.0 Sip Configuration Guide
14 pages
Panasonic KX HTS32 KX HTS824
No ratings yet
Panasonic KX HTS32 KX HTS824
80 pages
XML Troubleshooting
No ratings yet
XML Troubleshooting
8 pages
Pakistan Studies SSC-I Model Question Paper
No ratings yet
Pakistan Studies SSC-I Model Question Paper
6 pages
CVP Trubleshooting
100% (1)
CVP Trubleshooting
87 pages
Hardware Protection
No ratings yet
Hardware Protection
21 pages
Simple
No ratings yet
Simple
1 page
CooVox Series IPPBX Admin User Manual - V3.0.1 PDF
No ratings yet
CooVox Series IPPBX Admin User Manual - V3.0.1 PDF
116 pages
Internos
No ratings yet
Internos
146 pages
CP R80.40 VoIP AdminGuide
No ratings yet
CP R80.40 VoIP AdminGuide
70 pages
Menú IVR ATA 187
No ratings yet
Menú IVR ATA 187
2 pages
Avaya Communication Manager: System Handover Document
100% (1)
Avaya Communication Manager: System Handover Document
26 pages
Sugarcane Information System: Project Background
No ratings yet
Sugarcane Information System: Project Background
24 pages
ROS 2252C 119+ - Dashboard
No ratings yet
ROS 2252C 119+ - Dashboard
9 pages
Coovox v2 User Manualadmin v2.1.3
No ratings yet
Coovox v2 User Manualadmin v2.1.3
124 pages
Configuring SIP and TEL URL Support
No ratings yet
Configuring SIP and TEL URL Support
32 pages
ISSB Picture Story Writing Samples
No ratings yet
ISSB Picture Story Writing Samples
30 pages
RFP - East Call Center - 2021
No ratings yet
RFP - East Call Center - 2021
11 pages
Cisco Press Cisco IP Telephony Volume 1 CIPT1 Student Guide V4 1 PDF
No ratings yet
Cisco Press Cisco IP Telephony Volume 1 CIPT1 Student Guide V4 1 PDF
158 pages
Islamiat
No ratings yet
Islamiat
2 pages
PLN (I) CVM11 OSSv1 - 01.16
No ratings yet
PLN (I) CVM11 OSSv1 - 01.16
108 pages
Derje Tilahun
No ratings yet
Derje Tilahun
91 pages
Sap Contact Center
No ratings yet
Sap Contact Center
71 pages
NEC Aspire Multi-Button User Guide
No ratings yet
NEC Aspire Multi-Button User Guide
164 pages
DP New Pharmacy Opening Checklist
100% (1)
DP New Pharmacy Opening Checklist
8 pages
Barge and Privacy 365: Chapter 17 Configuring User Features, Part 2 377
No ratings yet
Barge and Privacy 365: Chapter 17 Configuring User Features, Part 2 377
1 page
Md. Arafat Alam: Curriculum Vitae of
No ratings yet
Md. Arafat Alam: Curriculum Vitae of
7 pages
4.3 Connect User Guide en
No ratings yet
4.3 Connect User Guide en
35 pages
CVP "Send To VRU" and "Run Ext Script" Failures: Document ID: 116178
No ratings yet
CVP "Send To VRU" and "Run Ext Script" Failures: Document ID: 116178
83 pages
Unlock IEWB VO VOL2.v3.00.Lab8.Solutionsguide
No ratings yet
Unlock IEWB VO VOL2.v3.00.Lab8.Solutionsguide
79 pages
I Don't Need an Acting Class
From Everand
I Don't Need an Acting Class
Milton Justice
5/5 (3)
Unlock IEWB VO VOL2.v3.00.Lab7.Solutionsguide
No ratings yet
Unlock IEWB VO VOL2.v3.00.Lab7.Solutionsguide
85 pages
Lifesize® Multipoint™ Installation Guide
No ratings yet
Lifesize® Multipoint™ Installation Guide
49 pages
Digital Marketing Agency Business Plan Example
No ratings yet
Digital Marketing Agency Business Plan Example
37 pages
620-0216-016A VoIP Option
No ratings yet
620-0216-016A VoIP Option
114 pages
Information About Basic Inter-VSAN Routing
No ratings yet
Information About Basic Inter-VSAN Routing
24 pages
Charging SYSTEM
No ratings yet
Charging SYSTEM
64 pages
VXMLRef 007-02542-0025 R4.21 v01
No ratings yet
VXMLRef 007-02542-0025 R4.21 v01
232 pages
Ccbootcamp'S Ccie Voice Lab Technology Workbook: Email
No ratings yet
Ccbootcamp'S Ccie Voice Lab Technology Workbook: Email
30 pages
Imsvoltesip 150121033603 Conversion Gate02
No ratings yet
Imsvoltesip 150121033603 Conversion Gate02
29 pages
Hipath 1100: Hipath 1120 Hipath 1130 Hipath 1150 Hipath 1190 User Manual
No ratings yet
Hipath 1100: Hipath 1120 Hipath 1130 Hipath 1150 Hipath 1190 User Manual
68 pages
Merit List CHPE 23 12 211640349197
No ratings yet
Merit List CHPE 23 12 211640349197
10 pages
Computer Science Ssc-I: Answer Sheet No.
No ratings yet
Computer Science Ssc-I: Answer Sheet No.
7 pages
Task 1.1: CCIE Voice Lab Workbook Volume II Lab 9 Solutions
No ratings yet
Task 1.1: CCIE Voice Lab Workbook Volume II Lab 9 Solutions
79 pages
Math SSC-I Model Question Paper
No ratings yet
Math SSC-I Model Question Paper
8 pages
Chemistry Ssc-I: Answer Sheet No.
No ratings yet
Chemistry Ssc-I: Answer Sheet No.
7 pages
Physics Ssc-I: Answer Sheet No.
No ratings yet
Physics Ssc-I: Answer Sheet No.
6 pages
Presentation On-Ivrs
No ratings yet
Presentation On-Ivrs
18 pages
Survey Data On Voice Over Industry
No ratings yet
Survey Data On Voice Over Industry
15 pages
Islamic Studies
No ratings yet
Islamic Studies
2 pages
Hi Path 1100 Manual
No ratings yet
Hi Path 1100 Manual
68 pages
Untitled
No ratings yet
Untitled
1 page
Telecom Regulatory Authority of India: To Be Published in The Gazette of India, Extraordinary, Part Iii, Section 4
No ratings yet
Telecom Regulatory Authority of India: To Be Published in The Gazette of India, Extraordinary, Part Iii, Section 4
23 pages
Cisco Voip Guide
100% (7)
Cisco Voip Guide
32 pages
Swvoip
No ratings yet
Swvoip
6 pages
Dynaport
No ratings yet
Dynaport
9 pages
Volte
No ratings yet
Volte
15 pages
Voice Mail Connectivity To Cisco Callmanager
No ratings yet
Voice Mail Connectivity To Cisco Callmanager
6 pages
VoIP Book
No ratings yet
VoIP Book
52 pages
Options Trading for Income: Learn the strategies and techniques for maximizing returns and minimizing risk in the options market (2023 Guide for Beginners)
From Everand
Options Trading for Income: Learn the strategies and techniques for maximizing returns and minimizing risk in the options market (2023 Guide for Beginners)
Lane Conner
No ratings yet
BC Project On Ivr System
No ratings yet
BC Project On Ivr System
19 pages
Elastix 5 Converter Tool - Migrate Easily From Older Versions
No ratings yet
Elastix 5 Converter Tool - Migrate Easily From Older Versions
1 page
IVR Testing
No ratings yet
IVR Testing
15 pages
Swvoip
No ratings yet
Swvoip
6 pages
"Interactive Voice Response System": A Project Report (Stage I)
No ratings yet
"Interactive Voice Response System": A Project Report (Stage I)
6 pages
BlockChain for Beginners
From Everand
BlockChain for Beginners
Matthew Smith
No ratings yet
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
From Everand
The Linux Terminal for Advanced Users - The Command Line Made Easy: First Edition
Michael Basler
No ratings yet
Trixbox CE Functions and Features by Kerry Garrison
No ratings yet
Trixbox CE Functions and Features by Kerry Garrison
8 pages
Intrusion Detection Honeypots
From Everand
Intrusion Detection Honeypots
Chris Sanders
3/5 (2)
Gray Hat Hacking the Ethical Hacker's
From Everand
Gray Hat Hacking the Ethical Hacker's
Çağatay Şanlı
5/5 (1)
ChatGPT for Business: Strategies for Success
From Everand
ChatGPT for Business: Strategies for Success
Matthew C. Smith
No ratings yet
Lock 'n Load Tactical Core Rules v5.0
From Everand
Lock 'n Load Tactical Core Rules v5.0
David Heath
No ratings yet
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
From Everand
Securing ChatGPT: Best Practices for Protecting Sensitive Data in AI Language Models
Matthew C. Smith
No ratings yet
Software Patterns Made Easy
From Everand
Software Patterns Made Easy
Justice Nanhou
No ratings yet