API Version: Development
System-Admin permissions for create, delete or container operations, but company read and update may be used by company administrators (scope must specify a company).System-Admin permissions is also required to enable or disable features, and these options will be ignored for other users.company-id is restricted with the following RexEx pattern: /^[a-zA-Z0-9_]{1-32}$/
name is restricted with the following RexEx pattern: /^[a-zA-Z0-9\.\,\;\-_ ]{1-240}$//rest/ops/create/{
"type": "company",
"values": {
"company": "company-id",
"name": "company name",
"description": "company description"
}
}{
"result": "success",
"values": {
"company id": {
"id": 1234, /* Company unique ID */
"name": "Company Name",
"data": {}
}
}
}{
"type": "company",
"values": {
"company": "testcompany",
"name": "My Test Company"
}
}{
"result": "success",
"values": {
"testcompany": {
"id": 1235,
"name": "My Test Company",
"data": {}
},
...
}
}/rest/ops/read/{
"type": "company",
"scope": {
"company": "company-id"
}
}{
"result": "success",
"values": {
"company id": {
"id": 1234, /* Company unique ID */
"name": "Company Name",
"data": {
"record": bitwise value specifying default call ecording options,
"nm_password": "numeric nightmode pin",
"ivr_password": "numeric ivr pin",
"barge_pin": "numeric barge pin",
"zone": "timezone string",
"hs_nm": "Handset nightmode ('' or 0-9)",
"hs_access": "Default handset access level",
"hs_access_nm": "Nightmode handset access level",
"fid": "Block handset forwards ('' = system default, 0 = no, 1 = yes)",
"vm_callback": "Enable call-return from voicemail (-1 = no, 0 = system default, 1 = yes)",
"phonebook": "Default phonebook visibility (0 = none, 1 = company, 2 = logged-in, 3 = public)",
"callerid": "Override caller-id default value (prefix with '-' for cid blocking)",
"vm_silent": "Silence voicemail instructins ('' = default, 'no' = say instructions, 'yes' = silence)",
"vm_maxmsgs": "Max voicemail messages per mailbox ('' = Global Default, 50, 100, 200, 300, 500))",
"q_ringtime": "Queue ring time ('' or 5 to 30)",
"q_pausetime": "Queue pause time ('' or 2 to 10)",
"q_wraptime": "Queue wrapup time ('' or 2 to 240)",
"q_per_ann_int": "Periodic announce interval seconds ('', 30, 60, 90)",
"q_per_pos_int": "Periodic position interval seconds ('', 30, 60, 90)",
"pre_queue_ring": "Pre-queue ring time ('' or 1 to 999)",
"crm_url": "(Deprecated) CRM popup URL",
"hs_webrtc": "Default keevio phone status ('' = Global default, no = None, yes = keevio phone, disable = not for this company) (from version 6.3.22)",
"nocallrec": suppress access to call recording (boolean null/false or true) (from version 6.3.22),
"nokeevio": suppress access to keevio web interface (boolean null/false or true) (from version 6.3.22),
"noext": "suppress access to certain extension types (string made up of: hqficovptx) (from version 6.3.22)",
"nopickup": "suppress access to call pickups (boolean null/false or true) (from version 6.3.23)",
"nobarge": "suppress access to barge or whisper (boolean null/false or true) (from version 6.3.23)"
}
}
}
}{
"type": "company",
"scope": {
"company": "testcompany"
}
}{
"result": "success",
"values": {
"testcompany": {
"id": 1234,
"name": "A Test Company",
"data": {
"record": 15,
"nm_password": "0000",
"ivr_password": "0000",
"zone": "US/Pacific",
"hs_nm": "",
"hs_access": "",
"hs_access_nm": "",
"hs_webrtc": "",
"fid": "",
"phonebook": "",
"crm_url": "",
"vm_silent": "",
"vm_maxmsgs": "",
"q_ringtime": "",
"q_pausetime": "",
"q_wraptime": "",
"q_per_ann_int": "",
"q_per_pos_int": "",
"barge_pin": "",
"callerid": "",
"vm_callback": 0,
"nocallrec": null
}
},
...
}
}/rest/ops/update/{
"type": "company",
"scope": {
"company": "company-id"
},
"values": {
"name": "company name",
"description": "company description",
"record": bitwise value specifying default call ecording options,
"nm_password": "numeric nightmode pin",
"ivr_password": "numeric ivr pin",
"barge_pin": "numeric barge pin",
"zone": "timezone string",
"hs_nm": "Handset nightmode ('' or 0-9)",
"hs_access": "Default handset access level",
"hs_access_nm": "Nightmode handset access level",
"fid": "Block handset forwards ('' = system default, 0 = no, 1 = yes)",
"vm_callback": "Enable call-return from voicemail (-1 = no, 0 = system default, 1 = yes)",
"phonebook": "Default phonebook visibility (0 = none, 1 = company, 2 = logged-in, 3 = public)",
"callerid": "Override caller-id default value (prefix with '-' for cid blocking)",
"vm_silent": "Silence voicemail instructins ('' = default, 'no' = say instructions, 'yes' = silence)",
"vm_maxmsgs": "Max voicemail messages per mailbox ('' = Global Default, 50, 100, 200, 300, 500))",
"q_ringtime": "Queue ring time ('' or 5 to 30)",
"q_pausetime": "Queue pause time ('' or 2 to 10)",
"q_wraptime": "Queue wrapup time ('' or 2 to 240)",
"q_per_ann_int": "Periodic announce interval seconds ('', 30, 60, 90)",
"q_per_pos_int": "Periodic position interval seconds ('', 30, 60, 90)",
"pre_queue_ring": "Pre-queue ring time ('' or 1 to 999)",
"crm_url": "(Deprecated) CRM popup URL",
"hs_webrtc": "Default keevio phone status ('' = Global default, no = None, yes = keevio phone, disable = not for this company) (from version 6.3.22)",
"nocallrec": suppress access to call recording (boolean null/false or true) (from version 6.3.22),
"nokeevio": suppress access to keevio web interface (boolean null/false or true) (from version 6.3.22),
"noext": "suppress access to certain extension types (string made up of: hqficovptx) (from version 6.3.22)",
"nopickup": "suppress access to call pickups (boolean null/false or true) (from version 6.3.23)",
"nobarge": "suppress access to barge or whisper (boolean null/false or true) (from version 6.3.23)"
}
}{
"result": "success",
"values": {
"company id": {
"id": 1234, /* Company unique ID */
"name": "Company Name",
"data": {
"nm_password": "",
"ivr_password": "",
"zone": "",
"hs_nm": "",
"hs_access": "",
"hs_access_nm": "",
"fid": "",
"vm_callback": 0,
"phonebook": "",
"callerid": "",
"vm_silent": "",
"vm_maxmsgs": "",
"q_ringtime": "",
"q_pausetime": "",
"q_wraptime": "",
"q_per_ann_int": "",
"q_per_pos_int": "",
"pre_queue_ring": "",
"barge_pin": "",
"crm_url": "",
"hs_webrtc": ""
}
}
}
}{
"type": "company",
"scope": {
"company": "testcompany"
},
"values": {
"name": "My Test Company"
}
}{
"result": "success",
"values": {
"testcompany": {
"id": 1235,
"name": "My Test Company",
"data": {
"nm_password": "1234",
"ivr_password": "1234",
"zone": "",
"hs_nm": "",
"hs_access": "external",
"hs_access_nm": "",
"fid": "1",
"vm_callback": 0,
"phonebook": "",
"callerid": "",
"vm_silent": "",
"vm_maxmsgs": "",
"q_ringtime": "",
"q_pausetime": "",
"q_wraptime": "",
"q_per_ann_int": "",
"q_per_pos_int": "",
"pre_queue_ring": "",
"barge_pin": "",
"crm_url": "",
"hs_webrtc": ""
}
},
...
}
}/rest/ops/readContainer/{
"type": "company",
"scope": {
"company": "company-id",
"container": "container-id"
}
}{
"result": "success",
"values": {
"container id": {
"id": 999, /* Container unique ID */
"name": "Container Name",
"data": {}, /* Containers currently have no data */
"members: {
"company id": {
"id": 1234, /* Company unique ID */
"name": "Company Name",
"data": {
"record": 15,
"nm_password": "0000",
"ivr_password": "0000",
"zone": "US/Pacific",
"hs_nm": "",
"hs_access": "",
"hs_access_nm": "",
"hs_webrtc": "",
"fid": "",
"phonebook": "",
"crm_url": "",
"vm_silent": "",
"vm_maxmsgs": "",
"q_ringtime": "",
"q_pausetime": "",
"q_wraptime": "",
"q_per_ann_int": "",
"q_per_pos_int": "",
"barge_pin": "",
"callerid": "",
"vm_callback": 0
}
},
...
}
}
}
}{
"type": "company",
"scope": {
"company": "testcompany"
}
}{
"result": "success",
"values": {
"test": {
"id": 2345,
"name": "Test Container",
"data": {},
"members": {
"testcompany": {
"id": 4567,
"name": "Test Co",
"data": {
"nm_password": "0000",
"ivr_password": "0000",
"zone": "",
"hs_nm": "",
"hs_access": "",
"hs_access_nm": "",
"hs_webrtc": "",
"fid": "",
"phonebook": "",
"crm_url": "",
"vm_silent": "",
"vm_maxmsgs": "",
"q_ringtime": "",
"q_pausetime": "",
"q_wraptime": "",
"q_per_ann_int": "",
"q_per_pos_int": "",
"barge_pin": "",
"callerid": "123456",
"record": 15,
"vm_callback": 0,
"vm_maxmsgs": "300"
}
}
}
}
}
}/rest/ops/group/{
"type": "company",
"scope": {
"company": "company-id" /* Company to 'move' */
},
"values": {
"company": "company-id" /* Target company */
}
}{
"result": "success",
"message": "grouped okay",
"containermoves": 0 /* How many other companies were relocated as a side effect - ignore */
}/rest/ops/ungroup/{
"type": "company",
"scope": {
"company": "company-id" /* Company to 'ungroup' */
}
}{
"result": "success",
"message": "un-grouped okay",
"containermoves": 0 /* How many other companies were relocated as a side effect - ignore */
}