Introduction
Welcome to the CustomPbx API! You can use it to manipulate configs, dialplan and directory of FreeSwitch. Here we have language bindings in Shell and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.
Transport
Request schema:
{
"event":"",
"data":{}
}
Response schema have one mandatory field:
{
"MessageType": ""
}
let exampleSocket = new WebSocket('https://HOST:PORT/ws', '');
API available with http POST requests or trough websocket transport.
Routes for websocket can be cofigured in CustomPbx conf file default: https://HOST:PORT/ws, POST route https://HOST:PORT/api/v1.
Websocket Methods Only
login
exampleSocket.send('{"event":"login","data":{"login":"admin","password":"admin"}}');
Returns JSON structured like this:
{
"MessageType": "login",
"token": "asd3fvdg45fshj8dv33fsdgy6sdge2sdvstt",
"user": {
"id": 1,
"login": "admin",
"sip_id": {
"Int64": 19,
"Valid": true
},
"webrtc_lib": "sipjs",
"ws": "wss://111.111.111.111:7443",
"verto_ws": "",
"stun": "",
"avatar_format": "",
"enabled": true,
"lang": 0
}
}
Generates new api token and returns logged user data.
Event value
login
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| login | string | User name. |
| password | string | User password. |
Errors
- Unknown user
- Wrong Login
- Cant set token
Logout
exampleSocket.send('{"event":"[Auth] Logout","data":{"token":"asd3fvdg45fshj8dv33fsdgy6sdge2sdvstt"}}');
Returns JSON structured like this:
{
"MessageType": "[Auth] Logout"
}
Removes api token for user and unsubscribe from events.
Event value
[Auth] Logout
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
Errors
- Cant delete token
relogin
exampleSocket.send('{"event":"login","data":{"token":"asd3fvdg45fshj8dv33fsdgy6sdge2sdvstt"}}');
Returns JSON structured like this:
{
"MessageType": "relogin",
"token": "asd3fvdg45fshj8dv33fsdgy6sdge2sdvstt",
"user": {
"id": 1,
"login": "admin",
"sip_id": {
"Int64": 19,
"Valid": true
},
"webrtc_lib": "sipjs",
"ws": "wss://111.111.111.111:7443",
"verto_ws": "",
"stun": "",
"avatar_format": "",
"enabled": true,
"lang": 0
}
}
Returning user data by token if exists.
Event value
relogin
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
Errors
- Unknown user
- Wrong Login
- Cant set token
Dialplan Debug
exampleSocket.send('{"event":"[Dialplan][Switch] Debug","data":{"token":"asd3fvdg45fshj8dv33fsdgy6sdge2sdvstt","enabled":true}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Switch] Debug",
"enabled": true
}
Example of event body:
{
"MessageType": "[Dialplan] Debug",
"dialplan_debug": {
"log": [
"[CONDITION 105] (false) [unloop] ${unroll_loops}(_UNDEF_) =~ /^true$/ break=on-false \n",
"[CONDITION 107] (true) [outside_call] EMPTY(_UNDEF_) =~ // break=on-false \n",
"[CONDITION 108] (false) [call_debug] ${call_debug}(_UNDEF_) =~ /^true$/ break=never \n",
"[CONDITION 109] (false) [public_extensions] destination_number(062100442922550325) =~ /^(10[01][0-9])$/ break=on-false \n",
"[CONDITION 110] (false) [public_conference_extensions] destination_number(062100442922550325) =~ /^(3[5-8][01][0-9])$/ break=on-false \n",
"[CONDITION 111] (false) [public_did] destination_number(062100442922550325) =~ /^(5551212)$/ break=on-false \n"
],
"actions": [
{
"id": 0,
"enabled": false,
"position": 0,
"application": "set",
"data": "outside_call=true",
"inline": false
},
{
"id": 0,
"enabled": false,
"position": 0,
"application": "export",
"data": "RFC2822_DATE=${strftime(%a, %d %b %Y %T %z)}",
"inline": false
}
]
}
}
Enabling or disabling dialplan events sending to websocket.
Event value
[Dialplan][Switch] Debug
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| enabled | boolean |
Errors
None.
SubscriptionList
exampleSocket.send('{"event":"SubscriptionList","data":{"token":"dd64511448aed2ce2160fc091a79749d","values":["[Config] Get_sofia_profiles"]}}');
Returns JSON structured like this:
{
"MessageType": "OK"
}
Enabling collect events trough websocket by name.
List of available events:
- [Dashboard]
- [Config] Get_sofia_profiles
- [Config] Get_sofia_profile_gateways
- [Config][Get] Modules
- [Dialplan] Debug
- [Users] Get_users
- SubscribeCallcenterAgents
- connection
Event value
SubscriptionList
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| values | array(string) | List of subscriptions. |
Errors
- cant subscribe!
UnSubscribe
exampleSocket.send('{"event":"[UnSubscribe]","data":{"token":"dd64511448aed2ce2160fc091a79749d"}}');
Returns JSON structured like this:
{
"MessageType": "OK"
}
Event value
[UnSubscribe]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| name | string | Name of event could be empty string to unsubscribe from all. |
Errors
None.
AddUserToken
exampleSocket.send('{"event":"AddUserToken","data":{"token":"dd64511448aed2ce2160fc091a79749d","id":1}}');
Returns JSON structured like this:
{
"MessageType": "AddUserToken",
"tokens_list": [
{
"id": 25,
"login": "",
"token": "891ff2c6aea84e646a7303b2773876f7",
"created": "2020-07-04 17:23:08.192",
"purpose": "api"
}
],
"id": 1
}
Creates new token for user for api purposes.
Event value
AddUserToken
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| id | integer | User id to create token for. |
Errors
- wrong id
- user not found
- Cant set token
GetUserTokens
exampleSocket.send('{"event":"GetUserTokens","data":{"token":"dd64511448aed2ce2160fc091a79749d","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetUserTokens",
"tokens_list": [
{
"id": 17,
"login": "",
"token": "b0391946307c03fa9ac870fe3647ce2b",
"created": "2020-06-27 09:41:29.427",
"purpose": "api"
},
{
"id": 24,
"login": "",
"token": "dd64511448aed2ce2160fc091a79749d",
"created": "2020-07-04 11:39:04.174",
"purpose": "gui"
}
],
"id": 1
}
Returns list of user's tokens by sent user id.
Event value
GetUserTokens
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| id | integer | User id. |
Errors
- wrong id
- user not found
UserGetOwnTokens
exampleSocket.send('{"event":"UserGetOwnTokens","data":{"token":"dd64511448aed2ce2160fc091a79749d"}}');
Returns JSON structured like this:
{
"MessageType": "GetUserTokens",
"tokens_list": [
{
"id": 17,
"login": "",
"token": "b0391946307c03fa9ac870fe3647ce2b",
"created": "2020-06-27 09:41:29.427",
"purpose": "api"
},
{
"id": 24,
"login": "",
"token": "dd64511448aed2ce2160fc091a79749d",
"created": "2020-07-04 11:39:04.174",
"purpose": "gui"
}
],
"id": 1
}
Returns list of current user's tokens.
Event value
UserGetOwnTokens
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
Errors
None.
RemoveUserToken
exampleSocket.send('{"event":"RemoveUserToken","data":{"token":"dd64511448aed2ce2160fc091a79749d","id":25}}');
Returns JSON structured like this:
{
"event": "RemoveUserToken",
"data": {
"token": "dd64511448aed2ce2160fc091a79749d",
"id": 25
}
}
Deleting user token.
Event value
RemoveUserToken
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| id | integer | User id. |
Errors
- wrong id
Websocket and POST Methods
Custom Data
Get Settings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"get_settings","data":{"token":"dd64511448aed2ce2160fc091a79749d"}}'
exampleSocket.send('{"event":"get_settings","data":{"token":"dd64511448aed2ce2160fc091a79749d"}}');
Returns JSON structured like this:
{
"MessageType": "settings",
"settings": {
"freeswitch": {
"esl": {
"host": "127.0.0.1",
"port": 8021,
"pass": "ClueCon",
"timeout": 10,
"collect_logs": 7
}
},
"webserver": {
"route": "/ws",
"host": "188.188.188.188",
"port": 8080,
"stun_port": 3478,
"cert_path": "/etc/freeswitch/tls/wss.pem",
"key_path": "/etc/freeswitch/tls/wss.pem"
},
"xml_curl_server": {
"route": "/conf/config",
"host": "127.0.0.1",
"port": 8080,
"stun_port": 0,
"cert_path": "/etc/freeswitch/tls/wss.pem",
"key_path": "/etc/freeswitch/tls/wss.pem"
},
"database": {
"name": "custompbx",
"host": "127.0.0.1",
"port": 5432,
"user": "custompbx",
"pass": "custompbx"
}
}
}
Getting default setting file content.
Event value
get_settings
settings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
Errors
Set Settings
curl -X POST "https://HOST:PORT/api/v1"
-d '{{"event":"set_settings","data":{"token":"dd64511448aed2ce2160fc091a79749d","payload":{"freeswitch":{"esl":{"host":"127.0.0.1","port":8021,"pass":"ClueCon","timeout":101,"collect_logs":7}},"webserver":{"route":"/ws","host":"188.188.188.188","port":8080,"stun_port":3478,"cert_path":"/etc/freeswitch/tls/wss.pem","key_path":"/etc/freeswitch/tls/wss.pem"},"xml_curl_server":{"route":"/conf/config","host":"127.0.0.1","port":8080,"stun_port":0,"cert_path":"/etc/freeswitch/tls/wss.pem","key_path":"/etc/freeswitch/tls/wss.pem"},"database":{"name":"custompbx","host":"127.0.0.1","port":5432,"user":"custompbx","pass":"custompbx"}},"type":"[Settings] Set"}}}'
exampleSocket.send('{"event":"set_settings","data":{"token":"dd64511448aed2ce2160fc091a79749d","payload":{"freeswitch":{"esl":{"host":"127.0.0.1","port":8021,"pass":"ClueCon","timeout":101,"collect_logs":7}},"webserver":{"route":"/ws","host":"188.188.188.188","port":8080,"stun_port":3478,"cert_path":"/etc/freeswitch/tls/wss.pem","key_path":"/etc/freeswitch/tls/wss.pem"},"xml_curl_server":{"route":"/conf/config","host":"127.0.0.1","port":8080,"stun_port":0,"cert_path":"/etc/freeswitch/tls/wss.pem","key_path":"/etc/freeswitch/tls/wss.pem"},"database":{"name":"custompbx","host":"127.0.0.1","port":5432,"user":"custompbx","pass":"custompbx"}},"type":"[Settings] Set"}}');
Returns JSON structured like this:
{
"MessageType": "settings",
"settings": {
"freeswitch": {
"esl": {
"host": "127.0.0.1",
"port": 8021,
"pass": "ClueCon",
"timeout": 10,
"collect_logs": 7
}
},
"webserver": {
"route": "/ws",
"host": "188.188.188.188",
"port": 8080,
"stun_port": 3478,
"cert_path": "/etc/freeswitch/tls/wss.pem",
"key_path": "/etc/freeswitch/tls/wss.pem"
},
"xml_curl_server": {
"route": "/conf/config",
"host": "127.0.0.1",
"port": 8080,
"stun_port": 0,
"cert_path": "/etc/freeswitch/tls/wss.pem",
"key_path": "/etc/freeswitch/tls/wss.pem"
},
"database": {
"name": "custompbx",
"host": "127.0.0.1",
"port": 5432,
"user": "custompbx",
"pass": "custompbx"
}
}
}
Updating default setting file content.
Event value
set_settings
settings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
| payload | string | json object of settings. |
Errors
- empty data
- can't save
Get Dashboard Data
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dashboard]", "data":{"token":"dd64511448aed2ce2160fc091a79749d"}}'
exampleSocket.send('{"event":"[Dashboard]", "data":{"token":"dd64511448aed2ce2160fc091a79749d"}}');
Returns JSON structured like this:
{
"MessageType": "[Dashboard]",
"dashboard_data": {
"timestamp": "2020-07-07T18:23:12.732291139Z",
"hostname": "debian-01",
"os": "linux",
"platform": "debian",
"cpu_model": "Intel Core Processor (Broadwell, IBRS)",
"cpu_frequency": 2199.994,
"dynamic_metrics": {
"total_memory": 1032409088,
"free_memory": 72151040,
"percentage_used_memory": 63.959960801894847,
"total_disc_space": 26288107520,
"free_disk_space": 14397915136,
"percentage_disk_usage": 42.244677320241468,
"core_utilization": [
5.940594060490095
]
},
"domain_sip_regs": {
"188.188.188.188": 0,
"domain.com": 0
},
"calls_counter": {
"answered": 0,
"total": 0
},
"sofia_profiles": [
{
"id": 1,
"enabled": true,
"name": "external-ipv6",
"started": false,
"state": "",
"uri": ""
},
{
"id": 2,
"enabled": true,
"name": "external",
"started": false,
"state": "",
"uri": ""
},
{
"id": 3,
"enabled": true,
"name": "internal-ipv6",
"started": false,
"state": "",
"uri": ""
},
{
"id": 4,
"enabled": true,
"name": "internal",
"started": false,
"state": "",
"uri": ""
}
],
"sofia_gateways": [
{
"id": 1,
"enabled": true,
"name": "asterlink.com",
"started": false,
"state": ""
}
]
}
}
Getting dashboard data.
Event value
[Dashboard]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | string | User auth token. |
Errors
ImportDirectory
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"ImportDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "ImportDirectory"
}
Import Directory.
Event value
ImportDirectory
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
- empty data
- can't parse
ImportXMLDomain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportXMLDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"\r\n <!--the domain or ip (the right hand side of the @ in the addr-->\r\n <domain name=\"test_do\">\r\n <params>\r\n <param name=\"jsonrpc-allowed-methods\" value=\"verto\"/>>\r\n </params>\r\n <variables>\r\n <variable name=\"record_stereo\" value=\"true\"/>\r\n <variable name=\"default_gateway\" value=\"$${default_provider}\"/>\r\n </variables>\r\n <groups>\r\n <group name=\"default\">\r\n\t<users>\r\n\t</users>\r\n </group>\r\n </groups>\r\n </domain>"}}'
exampleSocket.send('{"event":"ImportXMLDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"\r\n <!--the domain or ip (the right hand side of the @ in the addr-->\r\n <domain name=\"test_do\">\r\n <params>\r\n <param name=\"jsonrpc-allowed-methods\" value=\"verto\"/>>\r\n </params>\r\n <variables>\r\n <variable name=\"record_stereo\" value=\"true\"/>\r\n <variable name=\"default_gateway\" value=\"$${default_provider}\"/>\r\n </variables>\r\n <groups>\r\n <group name=\"default\">\r\n\t<users>\r\n\t</users>\r\n </group>\r\n </groups>\r\n </domain>"}}');
Returns JSON structured like this:
{
"MessageType": "ImportXMLDomain",
"data": {
"6": {
"id": 6,
"position": 1,
"enabled": true,
"name": "domain.com",
"parent": {
"id": 1
},
"sip_regs_counter": 0
},
"7": {
"id": 7,
"position": 2,
"enabled": true,
"name": "test_do",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
}
}
Import XMLDomain.
Event value
ImportXMLDomain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| file | String |
Errors
- can't parse
AddDirectoryDomain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"test"}}'
exampleSocket.send('{"event":"AddDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"test"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryDomain",
"data": {
"id": 9,
"position": 4,
"enabled": true,
"name": "test",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
}
Add Directory Domain.
Event value
AddDirectoryDomain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
- DB error
RenameDirectoryDomain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"RenameDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9,"name":"test2"}}'
exampleSocket.send('{"event":"RenameDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9,"name":"test2"}}');
Returns JSON structured like this:
{
"MessageType": "RenameDirectoryDomain",
"data": {
"id": 9,
"position": 4,
"enabled": true,
"name": "test2",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
}
Rename Directory Domain.
Event value
RenameDirectoryDomain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
- DB error
SwitchDirectoryDomain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryDomain",
"data": {
"id": 8,
"position": 3,
"enabled": false,
"name": "test_do2",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
}
Switch Directory Domain.
Event value
SwitchDirectoryDomain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
- DB error
DeleteDirectoryDomain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}'
exampleSocket.send('{"event":"DeleteDirectoryDomain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryDomain",
"data": {
"id": 9,
"position": 4,
"enabled": true,
"name": "test2",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
}
Delete Directory Domain.
Event value
DeleteDirectoryDomain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- DB error
GetDirectoryDomainDetails
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryDomainDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}'
exampleSocket.send('{"event":"GetDirectoryDomainDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryDomainDetails",
"data": {
"parameters": {
"10": {
"id": 10,
"position": 2,
"enabled": true,
"name": "jsonrpc-allowed-methods",
"value": "verto",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"9": {
"id": 9,
"position": 1,
"enabled": true,
"name": "dial-string",
"value": "{^^:sip_invite_domain=${dialed_domain}:presence_id=${dialed_user}@${dialed_domain}}${sofia_contact(*/${dialed_user}@${dialed_domain})},${verto_contact(${dialed_user}@${dialed_domain})}",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
},
"variables": {
"13": {
"id": 13,
"position": 1,
"enabled": true,
"name": "record_stereo",
"value": "true",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"14": {
"id": 14,
"position": 2,
"enabled": true,
"name": "default_gateway",
"value": "example.com",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"15": {
"id": 15,
"position": 3,
"enabled": true,
"name": "default_areacode",
"value": "918",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"16": {
"id": 16,
"position": 4,
"enabled": true,
"name": "transfer_fallback_extension",
"value": "operator",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
}
}
Get Directory Domain Details.
Event value
GetDirectoryDomainDetails
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- DB error
AddDirectoryDomainParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"paramn","value":"paramv"}}'
exampleSocket.send('{"event":"AddDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"paramn","value":"paramv"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryDomainParameter",
"data": {
"id": 15,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Add Directory Domain Parameter.
Event value
AddDirectoryDomainParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
| token | String | User auth token. |
Errors
- DB error
UpdateDirectoryDomainParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":15,"name":"paramn1","value":"paramv1"}}'
exampleSocket.send('{"event":"UpdateDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":15,"name":"paramn1","value":"paramv1"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryDomainParameter",
"data": {
"id": 15,
"position": 3,
"enabled": true,
"name": "paramn1",
"value": "paramv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Update Directory Domain Parameter.
Event value
UpdateDirectoryDomainParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| value | String | Item value |
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
SwitchDirectoryDomainParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":15,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":15,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryDomainParameter",
"data": {
"id": 15,
"position": 3,
"enabled": false,
"name": "paramn1",
"value": "paramv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Switch Directory Domain Parameter.
Event value
SwitchDirectoryDomainParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
DeleteDirectoryDomainParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"DeleteDirectoryDomainParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryDomainParameter",
"data": {
"id": 15,
"position": 3,
"enabled": false,
"name": "paramn1",
"value": "paramv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Delete Directory Domain Parameter.
Event value
DeleteDirectoryDomainParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddDirectoryDomainVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"varn","value":"varv"}}'
exampleSocket.send('{"event":"AddDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"varn","value":"varv"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryDomainVariable",
"data": {
"id": 21,
"position": 5,
"enabled": true,
"name": "varn",
"value": "varv",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Add Directory Domain Variable.
Event value
AddDirectoryDomainVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| value | String | Item value |
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
UpdateDirectoryDomainVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":21,"name":"varn1","value":"varv1"}}'
exampleSocket.send('{"event":"UpdateDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":21,"name":"varn1","value":"varv1"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryDomainVariable",
"data": {
"id": 21,
"position": 5,
"enabled": true,
"name": "varn1",
"value": "varv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Update Directory Domain Variable.
Event value
UpdateDirectoryDomainVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
SwitchDirectoryDomainVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":21,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":21,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryDomainVariable",
"data": {
"id": 21,
"position": 5,
"enabled": false,
"name": "varn1",
"value": "varv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Switch Directory Domain Variable.
Event value
SwitchDirectoryDomainVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
DeleteDirectoryDomainVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"DeleteDirectoryDomainVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryDomainVariable",
"data": {
"id": 21,
"position": 5,
"enabled": false,
"name": "varn1",
"value": "varv1",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Delete Directory Domain Variable.
Event value
DeleteDirectoryDomainVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Users
GetDirectoryUsers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDirectoryUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryUsers",
"data": {
"domains": {
"6": {
"id": 6,
"position": 1,
"enabled": true,
"name": "domain.com",
"parent": {
"id": 1
},
"sip_regs_counter": 0
},
"7": {
"id": 7,
"position": 2,
"enabled": true,
"name": "test_do",
"parent": {
"id": 1
},
"sip_regs_counter": 0
},
"8": {
"id": 8,
"position": 3,
"enabled": true,
"name": "test_do2",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
},
"directory_users": {
"100": {
"id": 100,
"position": 10,
"enabled": true,
"name": "1009",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"101": {
"id": 101,
"position": 11,
"enabled": true,
"name": "1010",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
}
Get Directory Users.
Event value
GetDirectoryUsers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetDirectoryUserDetails
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryUserDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91}}'
exampleSocket.send('{"event":"GetDirectoryUserDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryUserDetails",
"data": {
"parameters": {
"93": {
"id": 93,
"position": 1,
"enabled": true,
"name": "password",
"value": "12345asdqwe123asd213fsfd3qrsd3qrrfd32rffd5uhr6",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"94": {
"id": 94,
"position": 2,
"enabled": true,
"name": "vm-password",
"value": "1000",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
},
"variables": {
"346": {
"id": 346,
"position": 1,
"enabled": true,
"name": "toll_allow",
"value": "domestic,international,local",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"347": {
"id": 347,
"position": 2,
"enabled": true,
"name": "accountcode",
"value": "1000",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"348": {
"id": 348,
"position": 3,
"enabled": true,
"name": "user_context",
"value": "default",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"349": {
"id": 349,
"position": 4,
"enabled": true,
"name": "effective_caller_id_name",
"value": "Extension 1000",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"350": {
"id": 350,
"position": 5,
"enabled": true,
"name": "effective_caller_id_number",
"value": "1000",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"351": {
"id": 351,
"position": 6,
"enabled": true,
"name": "outbound_caller_id_name",
"value": "FreeSWITCH",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"352": {
"id": 352,
"position": 7,
"enabled": true,
"name": "outbound_caller_id_number",
"value": "0000000000",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"353": {
"id": 353,
"position": 8,
"enabled": true,
"name": "callgroup",
"value": "techsupport",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
},
"user": {
"id": 91,
"position": 1,
"enabled": true,
"name": "1000",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Get Directory User Details.
Event value
GetDirectoryUserDetails
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddDirectoryUserParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91,"name":"paramn","value":"paramv"}}'
exampleSocket.send('{"event":"AddDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91,"name":"paramn","value":"paramv"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUserParameter",
"data": {
"id": 137,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Add Directory User Parameter.
Event value
AddDirectoryUserParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
AddDirectoryUserVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91,"name":"varn","value":"varv"}}'
exampleSocket.send('{"event":"AddDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":91,"name":"varn","value":"varv"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUserVariable",
"data": {
"id": 514,
"position": 9,
"enabled": true,
"name": "varn",
"value": "varv",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Add Directory User Variable.
Event value
AddDirectoryUserVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
DeleteDirectoryUserParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":13}}'
exampleSocket.send('{"event":"DeleteDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":13}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUserParameter",
"data": {
"id": 137,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Delete Directory User Parameter.
Event value
DeleteDirectoryUserParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
DeleteDirectoryUserVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":51}}'
exampleSocket.send('{"event":"DeleteDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":51}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUserVariable",
"data": {
"id": 514,
"position": 9,
"enabled": true,
"name": "varn",
"value": "varv",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Delete Directory User Variable.
Event value
DeleteDirectoryUserVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
UpdateDirectoryUserParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":138,"name":"paramn1","value":"paramv1"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":138,"name":"paramn1","value":"paramv1"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserParameter",
"data": {
"id": 138,
"position": 3,
"enabled": true,
"name": "paramn1",
"value": "paramv1",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Update Directory User Parameter.
Event value
UpdateDirectoryUserParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
| token | String | User auth token. |
Errors
UpdateDirectoryUserVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":515,"name":"varn1","value":"varv1"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":515,"name":"varn1","value":"varv1"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserVariable",
"data": {
"id": 515,
"position": 9,
"enabled": true,
"name": "varn1",
"value": "varv1",
"description": "",
"parent": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Update Directory User Variable.
Event value
UpdateDirectoryUserVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| value | String | Item value |
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
UpdateDirectoryUserCache
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserCache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"3000","id":91}}'
exampleSocket.send('{"event":"UpdateDirectoryUserCache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"3000","id":91}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserCache",
"data": {
"id": 91,
"position": 1,
"enabled": true,
"name": "1000",
"cache": 3000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Update Directory User Cache.
Event value
UpdateDirectoryUserCache
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| value | String | Item value |
| id | Integer | Item ID. |
Errors
UpdateDirectoryUserCidr
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserCidr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"0.0.0.0","id":91}}'
exampleSocket.send('{"event":"UpdateDirectoryUserCidr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"0.0.0.0","id":91}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserCidr",
"data": {
"id": 91,
"position": 1,
"enabled": true,
"name": "1000",
"cache": 3000,
"cidr": "0.0.0.0",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Update Directory User Cidr.
Event value
UpdateDirectoryUserCidr
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| value | String | Item value |
| id | Integer | Item ID. |
Errors
UpdateDirectoryUserNumberAlias
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserNumberAlias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"555","id":91}}'
exampleSocket.send('{"event":"UpdateDirectoryUserNumberAlias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"555","id":91}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserNumberAlias",
"data": {
"id": 91,
"position": 1,
"enabled": true,
"name": "1000",
"cache": 3000,
"cidr": "0.0.0.0",
"number_alias": "555",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Update Directory User Number Alias.
Event value
UpdateDirectoryUserNumberAlias
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| value | String | Item value |
| id | Integer | Item ID. |
Errors
AddDirectoryUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"5000","id":6}}'
exampleSocket.send('{"event":"AddDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"5000","id":6}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUser",
"data": {
"115": {
"id": 115,
"position": 25,
"enabled": true,
"name": "5000",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Add Directory User.
Event value
AddDirectoryUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
| id | Integer | Item ID. |
Errors
ImportXMLDomainUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportXMLDomainUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"<user id=\"1099\">\r\n <params>\r\n <param name=\"password\" value=\"$${default_password}\"/>\r\n <param name=\"vm-password\" value=\"1099\"/>\r\n </params>\r\n <variables>\r\n <variable name=\"toll_allow\" value=\"domestic,international,local\"/>\r\n <variable name=\"accountcode\" value=\"1099\"/>\r\n <variable name=\"user_context\" value=\"default\"/>\r\n <variable name=\"effective_caller_id_name\" value=\"Extension 1990\"/>\r\n <variable name=\"effective_caller_id_number\" value=\"1099\"/>\r\n <variable name=\"outbound_caller_id_name\" value=\"$${outbound_caller_name}\"/>\r\n <variable name=\"outbound_caller_id_number\" value=\"$${outbound_caller_id}\"/>\r\n <variable name=\"callgroup\" value=\"techsupport\"/>\r\n </variables>\r\n </user>","id":6}}'
exampleSocket.send('{"event":"ImportXMLDomainUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"<user id=\"1099\">\r\n <params>\r\n <param name=\"password\" value=\"$${default_password}\"/>\r\n <param name=\"vm-password\" value=\"1099\"/>\r\n </params>\r\n <variables>\r\n <variable name=\"toll_allow\" value=\"domestic,international,local\"/>\r\n <variable name=\"accountcode\" value=\"1099\"/>\r\n <variable name=\"user_context\" value=\"default\"/>\r\n <variable name=\"effective_caller_id_name\" value=\"Extension 1990\"/>\r\n <variable name=\"effective_caller_id_number\" value=\"1099\"/>\r\n <variable name=\"outbound_caller_id_name\" value=\"$${outbound_caller_name}\"/>\r\n <variable name=\"outbound_caller_id_number\" value=\"$${outbound_caller_id}\"/>\r\n <variable name=\"callgroup\" value=\"techsupport\"/>\r\n </variables>\r\n </user>","id":6}}');
Returns JSON structured like this:
{
"MessageType": "ImportXMLDomainUser",
"data": {
"100": {
"id": 100,
"position": 10,
"enabled": true,
"name": "1009",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"101": {
"id": 101,
"position": 11,
"enabled": true,
"name": "1010",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"102": {
"id": 102,
"position": 12,
"enabled": true,
"name": "1011",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"103": {
"id": 103,
"position": 13,
"enabled": true,
"name": "1012",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"104": {
"id": 104,
"position": 14,
"enabled": true,
"name": "1013",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"105": {
"id": 105,
"position": 15,
"enabled": true,
"name": "1014",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"106": {
"id": 106,
"position": 16,
"enabled": true,
"name": "1015",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"107": {
"id": 107,
"position": 17,
"enabled": true,
"name": "1016",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"108": {
"id": 108,
"position": 18,
"enabled": true,
"name": "1017",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"109": {
"id": 109,
"position": 19,
"enabled": true,
"name": "1018",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"110": {
"id": 110,
"position": 20,
"enabled": true,
"name": "1019",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"111": {
"id": 111,
"position": 21,
"enabled": true,
"name": "brian",
"cache": 1000,
"cidr": "192.0.2.0/24",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"112": {
"id": 112,
"position": 22,
"enabled": true,
"name": "default",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"113": {
"id": 113,
"position": 23,
"enabled": true,
"name": "example.com",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"114": {
"id": 114,
"position": 24,
"enabled": true,
"name": "SEP001120AABBCC",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"115": {
"id": 115,
"position": 25,
"enabled": true,
"name": "5000",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"116": {
"id": 116,
"position": 26,
"enabled": true,
"name": "1099",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"91": {
"id": 91,
"position": 1,
"enabled": true,
"name": "1000",
"cache": 3000,
"cidr": "0.0.0.0",
"number_alias": "555",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"92": {
"id": 92,
"position": 2,
"enabled": true,
"name": "1001",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"93": {
"id": 93,
"position": 3,
"enabled": true,
"name": "1002",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"94": {
"id": 94,
"position": 4,
"enabled": true,
"name": "1003",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"95": {
"id": 95,
"position": 5,
"enabled": true,
"name": "1004",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"96": {
"id": 96,
"position": 6,
"enabled": true,
"name": "1005",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"97": {
"id": 97,
"position": 7,
"enabled": true,
"name": "1006",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"98": {
"id": 98,
"position": 8,
"enabled": true,
"name": "1007",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"99": {
"id": 99,
"position": 9,
"enabled": true,
"name": "1008",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Import XMLDomain User.
Event value
ImportXMLDomainUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| file | String | |
| id | Integer | Item ID. |
Errors
DeleteDirectoryUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":11}}'
exampleSocket.send('{"event":"DeleteDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":11}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUser",
"data": {
"id": 115,
"position": 25,
"enabled": true,
"name": "5000",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Delete Directory User.
Event value
DeleteDirectoryUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
UpdateDirectoryUserName
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":116,"name":"1098"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":116,"name":"1098"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserName",
"data": {
"id": 116,
"position": 26,
"enabled": true,
"name": "1098",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Update Directory User Name.
Event value
UpdateDirectoryUserName
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
SwitchDirectoryUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":116,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":116,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryUser",
"data": {
"id": 116,
"position": 26,
"enabled": false,
"name": "1098",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
Switch Directory User.
Event value
SwitchDirectoryUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
SwitchDirectoryUserParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":140,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryUserParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":140,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryUserParameter",
"data": {
"id": 140,
"position": 2,
"enabled": false,
"name": "vm-password",
"value": "1099",
"description": "",
"parent": {
"id": 116,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Switch Directory User Parameter.
Event value
SwitchDirectoryUserParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
SwitchDirectoryUserVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":516,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryUserVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":516,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryUserVariable",
"data": {
"id": 516,
"position": 1,
"enabled": false,
"name": "toll_allow",
"value": "domestic,international,local",
"description": "",
"parent": {
"id": 116,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Switch Directory User Variable.
Event value
SwitchDirectoryUserVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| enabled | Boolean | Enabled/Disabled status of item. |
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Groups
GetDirectoryGroups
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryGroups","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDirectoryGroups","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryGroups",
"data": {
"domains": {
"6": {
"id": 6,
"position": 1,
"enabled": true,
"name": "domain.com",
"parent": {
"id": 1
},
"sip_regs_counter": 0
},
"7": {
"id": 7,
"position": 2,
"enabled": true,
"name": "test_do",
"parent": {
"id": 1
},
"sip_regs_counter": 0
},
"8": {
"id": 8,
"position": 3,
"enabled": true,
"name": "test_do2",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
},
"list": {
"10": {
"id": 10,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"11": {
"id": 11,
"position": 2,
"enabled": true,
"name": "sales",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"12": {
"id": 12,
"position": 3,
"enabled": true,
"name": "billing",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"13": {
"id": 13,
"position": 4,
"enabled": true,
"name": "support",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"14": {
"id": 14,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
},
"15": {
"id": 15,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
}
}
Get Directory Groups.
Event value
GetDirectoryGroups
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetDirectoryGroupUsers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryGroupUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":12}}'
exampleSocket.send('{"event":"GetDirectoryGroupUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":12}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryGroupUsers",
"data": {
"group_users": {
"114": {
"id": 114,
"position": 2,
"enabled": true,
"type": "",
"description": "",
"parent": {
"id": 12,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
},
"user": {
"id": 100,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
},
"users": {
"100": {
"id": 100,
"position": 10,
"enabled": true,
"name": "1009",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"101": {
"id": 101,
"position": 11,
"enabled": true,
"name": "1010",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
}
Get Directory Group Users.
Event value
GetDirectoryGroupUsers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddNewDirectoryGroup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddNewDirectoryGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_group"}}'
exampleSocket.send('{"event":"AddNewDirectoryGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_group"}}');
Returns JSON structured like this:
{
"MessageType": "AddNewDirectoryGroup",
"data": {
"id": 16,
"position": 5,
"enabled": true,
"name": "new_group",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Add New Directory Group.
Event value
AddNewDirectoryGroup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DeleteDirectoryGroup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"DeleteDirectoryGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryGroup",
"data": {
"id": 16,
"position": 5,
"enabled": true,
"name": "new_group",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Delete Directory Group.
Event value
DeleteDirectoryGroup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
UpdateDirectoryGroupName
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryGroupName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":17,"name":"newnew"}}'
exampleSocket.send('{"event":"UpdateDirectoryGroupName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":17,"name":"newnew"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryGroupName",
"data": {
"id": 17,
"position": 5,
"enabled": true,
"name": "newnew",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
}
}
}
Update Directory Group Name.
Event value
UpdateDirectoryGroupName
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| token | String | User auth token. |
Errors
AddDirectoryGroupUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryGroupUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id_int":91,"id":13}}'
exampleSocket.send('{"event":"AddDirectoryGroupUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id_int":91,"id":13}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryGroupUser",
"data": {
"id": 120,
"position": 3,
"enabled": true,
"type": "",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
},
"user": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Add Directory Group User.
Event value
AddDirectoryGroupUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id_int | Integer | |
| id | Integer | Item ID. |
Errors
DeleteDirectoryGroupUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryGroupUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":12}}'
exampleSocket.send('{"event":"DeleteDirectoryGroupUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":12}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryGroupUser",
"data": {
"id": 120,
"position": 3,
"enabled": true,
"type": "",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
},
"user": {
"id": 91,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Delete Directory Group User.
Event value
DeleteDirectoryGroupUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Gateways
GetDirectoryUserGateways
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryUserGateways","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDirectoryUserGateways","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryUserGateways",
"data": {
"domains": {
"6": {
"id": 6,
"position": 1,
"enabled": true,
"name": "domain.com",
"parent": {
"id": 1
},
"sip_regs_counter": 0
}
},
"directory_users": {
"100": {
"id": 100,
"position": 10,
"enabled": true,
"name": "1009",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"101": {
"id": 101,
"position": 11,
"enabled": true,
"name": "1010",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"102": {
"id": 102,
"position": 12,
"enabled": true,
"name": "1011",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"103": {
"id": 103,
"position": 13,
"enabled": true,
"name": "1012",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"104": {
"id": 104,
"position": 14,
"enabled": true,
"name": "1013",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
},
"105": {
"id": 105,
"position": 15,
"enabled": true,
"name": "1014",
"cache": 1000,
"cidr": "",
"number_alias": "",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"parent": null,
"sip_regs_counter": 0
},
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
},
"user_gateways": {
"5": {
"id": 5,
"position": 1,
"enabled": true,
"name": "example.com",
"description": "",
"parent": {
"id": 113,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
}
}
Get Directory User Gateways.
Event value
GetDirectoryUserGateways
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetDirectoryUserGatewayDetails
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryUserGatewayDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"GetDirectoryUserGatewayDetails","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryUserGatewayDetails",
"data": {
"parameters": {
"29": {
"id": 29,
"position": 1,
"enabled": true,
"name": "username",
"value": "joeuser",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"30": {
"id": 30,
"position": 2,
"enabled": true,
"name": "password",
"value": "password",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"31": {
"id": 31,
"position": 3,
"enabled": true,
"name": "from-user",
"value": "joeuser",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"32": {
"id": 32,
"position": 4,
"enabled": true,
"name": "from-domain",
"value": "example.com",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"33": {
"id": 33,
"position": 5,
"enabled": true,
"name": "expire-seconds",
"value": "600",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"34": {
"id": 34,
"position": 6,
"enabled": true,
"name": "register",
"value": "false",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"35": {
"id": 35,
"position": 7,
"enabled": true,
"name": "retry-seconds",
"value": "30",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"36": {
"id": 36,
"position": 8,
"enabled": true,
"name": "extension",
"value": "5000",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"37": {
"id": 37,
"position": 9,
"enabled": true,
"name": "context",
"value": "public",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
},
"variables": {}
}
}
Get Directory User Gateway Details.
Event value
GetDirectoryUserGatewayDetails
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
AddDirectoryUserGatewayParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"paramn","value":"paramv"}}'
exampleSocket.send('{"event":"AddDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"paramn","value":"paramv"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUserGatewayParameter",
"data": {
"id": 38,
"position": 10,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Directory User Gateway Parameter.
Event value
AddDirectoryUserGatewayParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
DeleteDirectoryUserGatewayParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3}}'
exampleSocket.send('{"event":"DeleteDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUserGatewayParameter",
"data": {
"id": 38,
"position": 10,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Delete Directory User Gateway Parameter.
Event value
DeleteDirectoryUserGatewayParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
UpdateDirectoryUserGatewayParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":39,"name":"param","value":"param_new_val"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":39,"name":"param","value":"param_new_val"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserGatewayParameter",
"data": {
"id": 39,
"position": 10,
"enabled": true,
"name": "param",
"value": "param_new_val",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Directory User Gateway Parameter.
Event value
UpdateDirectoryUserGatewayParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
AddDirectoryUserGatewayVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"varn","value":"varv","direction":"vard"}}'
exampleSocket.send('{"event":"AddDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"varn","value":"varv","direction":"vard"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUserGatewayVariable",
"data": {
"id": 4,
"position": 1,
"enabled": true,
"name": "varn",
"value": "varv",
"direction": "vard",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Directory User Gateway Variable.
Event value
AddDirectoryUserGatewayVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| direction | String | |
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
Errors
UpdateDirectoryUserGatewayVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"varn","value":"varv2222","direction":"vard"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"varn","value":"varv2222","direction":"vard"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserGatewayVariable",
"data": {
"id": 4,
"position": 1,
"enabled": true,
"name": "varn",
"value": "varv2222",
"direction": "vard",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Directory User Gateway Variable.
Event value
UpdateDirectoryUserGatewayVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| value | String | Item value |
| direction | String | |
| token | String | User auth token. |
Errors
SwitchDirectoryUserGatewayVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryUserGatewayVariable",
"data": {
"id": 4,
"position": 1,
"enabled": false,
"name": "varn",
"value": "varv2222",
"direction": "vard",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Directory User Gateway Variable.
Event value
SwitchDirectoryUserGatewayVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
DeleteDirectoryUserGatewayVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}'
exampleSocket.send('{"event":"DeleteDirectoryUserGatewayVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUserGatewayVariable",
"data": {
"id": 4,
"position": 1,
"enabled": false,
"name": "varn",
"value": "varv2222",
"direction": "vard",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Delete Directory User Gateway Variable.
Event value
DeleteDirectoryUserGatewayVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddDirectoryUserGateway
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryUserGateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_gw","id":93}}'
exampleSocket.send('{"event":"AddDirectoryUserGateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_gw","id":93}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryUserGateway",
"data": {
"id": 6,
"position": 1,
"enabled": true,
"name": "new_gw",
"description": "",
"parent": {
"id": 93,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Add Directory User Gateway.
Event value
AddDirectoryUserGateway
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
DeleteDirectoryUserGateway
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteDirectoryUserGateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}'
exampleSocket.send('{"event":"DeleteDirectoryUserGateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}');
Returns JSON structured like this:
{
"MessageType": "DeleteDirectoryUserGateway",
"data": {
"id": 6,
"position": 1,
"enabled": true,
"name": "new_gw2",
"description": "",
"parent": {
"id": 93,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Delete Directory User Gateway.
Event value
DeleteDirectoryUserGateway
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
UpdateDirectoryUserGatewayName
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryUserGatewayName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_gw2"}}'
exampleSocket.send('{"event":"UpdateDirectoryUserGatewayName","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_gw2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryUserGatewayName",
"data": {
"id": 6,
"position": 1,
"enabled": true,
"name": "new_gw2",
"description": "",
"parent": {
"id": 93,
"position": 0,
"enabled": false,
"name": "",
"cache": 0,
"cidr": "",
"number_alias": "",
"description": "",
"parent": null,
"call_date": 0,
"in_call": false,
"talking": false,
"last_uuid": "",
"call_direction": "",
"sip_register": false,
"verto_register": false
}
}
}
Update Directory User Gateway Name.
Event value
UpdateDirectoryUserGatewayName
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
SwitchDirectoryUserGatewayParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":39,"enabled":false}}'
exampleSocket.send('{"event":"SwitchDirectoryUserGatewayParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":39,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryUserGatewayParameter",
"data": {
"id": 39,
"position": 10,
"enabled": false,
"name": "param",
"value": "param_new_val",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Directory User Gateway Parameter.
Event value
SwitchDirectoryUserGatewayParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
Configuration
Modules
[Config][Get] Modules
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Get] Modules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config][Get] Modules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Get] Modules",
"modules": {
"post_load_switch": {
"id": 43,
"position": 43,
"enabled": true,
"name": "post_load_switch.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"acl": {
"id": 1,
"position": 1,
"enabled": true,
"name": "acl.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"callcenter": {
"id": 6,
"position": 6,
"enabled": true,
"name": "callcenter.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_pg_csv": {
"id": 8,
"position": 8,
"enabled": true,
"name": "cdr_pg_csv.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"odbc_cdr": {
"id": 51,
"position": 51,
"enabled": true,
"name": "odbc_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lcr": {
"id": 24,
"position": 24,
"enabled": true,
"name": "lcr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sofia": {
"id": 42,
"position": 42,
"enabled": true,
"name": "sofia.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"verto": {
"id": 46,
"position": 46,
"enabled": true,
"name": "verto.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"shout": {
"id": 40,
"position": 40,
"enabled": true,
"name": "shout.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"redis": {
"id": 38,
"position": 38,
"enabled": true,
"name": "redis.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"nibblebill": {
"id": 29,
"position": 29,
"enabled": true,
"name": "nibblebill.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"db": {
"id": 14,
"position": 14,
"enabled": true,
"name": "db.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"distributor": {
"id": 17,
"position": 17,
"enabled": true,
"name": "distributor.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"memcache": {
"id": 26,
"position": 26,
"enabled": true,
"name": "memcache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"avmd": {
"id": 5,
"position": 5,
"enabled": true,
"name": "avmd.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"tts_commandline": {
"id": 44,
"position": 44,
"enabled": true,
"name": "tts_commandline.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_mongodb": {
"id": 7,
"position": 7,
"enabled": true,
"name": "cdr_mongodb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"http_cache": {
"id": 23,
"position": 23,
"enabled": true,
"name": "http_cache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"opus": {
"id": 31,
"position": 31,
"enabled": true,
"name": "opus.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"python": {
"id": 37,
"position": 37,
"enabled": true,
"name": "python.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"alsa": {
"id": 2,
"position": 2,
"enabled": false,
"name": "alsa.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"amr": {
"id": 52,
"position": 52,
"enabled": true,
"name": "amr.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"amrwb": {
"id": 4,
"position": 4,
"enabled": true,
"name": "amrwb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cepstral": {
"id": 9,
"position": 9,
"enabled": true,
"name": "cepstral.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cidlookup": {
"id": 10,
"position": 10,
"enabled": true,
"name": "cidlookup.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"curl": {
"id": 13,
"position": 13,
"enabled": true,
"name": "curl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"dialplan_directory": {
"id": 15,
"position": 15,
"enabled": true,
"name": "dialplan_directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"easyroute": {
"id": 18,
"position": 18,
"enabled": true,
"name": "easyroute.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"erlang_event": {
"id": 19,
"position": 19,
"enabled": true,
"name": "erlang_event.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"event_multicast": {
"id": 20,
"position": 20,
"enabled": true,
"name": "event_multicast.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fax": {
"id": 21,
"position": 21,
"enabled": true,
"name": "fax.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lua": {
"id": 25,
"position": 25,
"enabled": true,
"name": "lua.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"mongo": {
"id": 27,
"position": 27,
"enabled": true,
"name": "mongo.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"msrp": {
"id": 28,
"position": 28,
"enabled": true,
"name": "msrp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"oreka": {
"id": 32,
"position": 32,
"enabled": true,
"name": "oreka.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"perl": {
"id": 34,
"position": 34,
"enabled": true,
"name": "perl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"pocketsphinx": {
"id": 35,
"position": 35,
"enabled": true,
"name": "pocketsphinx.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sangoma_codec": {
"id": 39,
"position": 39,
"enabled": true,
"name": "sangoma_codec.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sndfile": {
"id": 41,
"position": 41,
"enabled": true,
"name": "sndfile.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_cdr": {
"id": 48,
"position": 48,
"enabled": true,
"name": "xml_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_rpc": {
"id": 49,
"position": 49,
"enabled": true,
"name": "xml_rpc.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"zeroconf": {
"id": 50,
"position": 50,
"enabled": true,
"name": "zeroconf.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"directory": {
"id": 16,
"position": 16,
"enabled": true,
"name": "directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fifo": {
"id": 22,
"position": 22,
"enabled": true,
"name": "fifo.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"opal": {
"id": 30,
"position": 30,
"enabled": true,
"name": "opal.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"osp": {
"id": 33,
"position": 33,
"enabled": true,
"name": "osp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"unicall": {
"id": 45,
"position": 45,
"enabled": true,
"name": "unicall.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference": {
"id": 11,
"position": 11,
"enabled": true,
"name": "conference.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference_layouts": {
"id": 12,
"position": 12,
"enabled": true,
"name": "conference_layouts.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"post_load_modules": {
"id": 36,
"position": 36,
"enabled": true,
"name": "post_load_modules.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"voicemail": {
"id": 47,
"position": 47,
"enabled": true,
"name": "voicemail.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
}
}
}
[ Config][ Get] Modules.
Event value
[Config][Get] Modules
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config][Reload] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Reload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}'
exampleSocket.send('{"event":"[Config][Reload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Reload] Module"
}
[ Config][ Reload] Module.
Event value
[Config][Reload] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
[Config][Unload] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Unload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}'
exampleSocket.send('{"event":"[Config][Unload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Unload] Module"
}
[ Config][ Unload] Module.
Event value
[Config][Unload] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
[Config][Load] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Load] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}'
exampleSocket.send('{"event":"[Config][Load] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Load] Module"
}
[ Config][ Load] Module.
Event value
[Config][Load] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
[Config][Switch] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Switch] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52,"enabled":false}}'
exampleSocket.send('{"event":"[Config][Switch] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":52,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Switch] Module",
"modules": {
"post_load_switch": {
"id": 43,
"position": 43,
"enabled": true,
"name": "post_load_switch.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"acl": {
"id": 1,
"position": 1,
"enabled": true,
"name": "acl.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"callcenter": {
"id": 6,
"position": 6,
"enabled": true,
"name": "callcenter.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_pg_csv": {
"id": 8,
"position": 8,
"enabled": true,
"name": "cdr_pg_csv.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"odbc_cdr": {
"id": 51,
"position": 51,
"enabled": true,
"name": "odbc_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lcr": {
"id": 24,
"position": 24,
"enabled": true,
"name": "lcr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sofia": {
"id": 42,
"position": 42,
"enabled": true,
"name": "sofia.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"verto": {
"id": 46,
"position": 46,
"enabled": true,
"name": "verto.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"shout": {
"id": 40,
"position": 40,
"enabled": true,
"name": "shout.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"redis": {
"id": 38,
"position": 38,
"enabled": true,
"name": "redis.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"nibblebill": {
"id": 29,
"position": 29,
"enabled": true,
"name": "nibblebill.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"db": {
"id": 14,
"position": 14,
"enabled": true,
"name": "db.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"distributor": {
"id": 17,
"position": 17,
"enabled": true,
"name": "distributor.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"memcache": {
"id": 26,
"position": 26,
"enabled": true,
"name": "memcache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"avmd": {
"id": 5,
"position": 5,
"enabled": true,
"name": "avmd.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"tts_commandline": {
"id": 44,
"position": 44,
"enabled": true,
"name": "tts_commandline.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_mongodb": {
"id": 7,
"position": 7,
"enabled": true,
"name": "cdr_mongodb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"http_cache": {
"id": 23,
"position": 23,
"enabled": true,
"name": "http_cache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"opus": {
"id": 31,
"position": 31,
"enabled": true,
"name": "opus.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"python": {
"id": 37,
"position": 37,
"enabled": true,
"name": "python.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"alsa": {
"id": 2,
"position": 2,
"enabled": false,
"name": "alsa.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"amr": {
"id": 52,
"position": 52,
"enabled": false,
"name": "amr.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"amrwb": {
"id": 4,
"position": 4,
"enabled": true,
"name": "amrwb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cepstral": {
"id": 9,
"position": 9,
"enabled": true,
"name": "cepstral.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cidlookup": {
"id": 10,
"position": 10,
"enabled": true,
"name": "cidlookup.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"curl": {
"id": 13,
"position": 13,
"enabled": true,
"name": "curl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"dialplan_directory": {
"id": 15,
"position": 15,
"enabled": true,
"name": "dialplan_directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"easyroute": {
"id": 18,
"position": 18,
"enabled": true,
"name": "easyroute.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"erlang_event": {
"id": 19,
"position": 19,
"enabled": true,
"name": "erlang_event.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"event_multicast": {
"id": 20,
"position": 20,
"enabled": true,
"name": "event_multicast.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fax": {
"id": 21,
"position": 21,
"enabled": true,
"name": "fax.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lua": {
"id": 25,
"position": 25,
"enabled": true,
"name": "lua.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"mongo": {
"id": 27,
"position": 27,
"enabled": true,
"name": "mongo.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"msrp": {
"id": 28,
"position": 28,
"enabled": true,
"name": "msrp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"oreka": {
"id": 32,
"position": 32,
"enabled": true,
"name": "oreka.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"perl": {
"id": 34,
"position": 34,
"enabled": true,
"name": "perl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"pocketsphinx": {
"id": 35,
"position": 35,
"enabled": true,
"name": "pocketsphinx.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sangoma_codec": {
"id": 39,
"position": 39,
"enabled": true,
"name": "sangoma_codec.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sndfile": {
"id": 41,
"position": 41,
"enabled": true,
"name": "sndfile.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_cdr": {
"id": 48,
"position": 48,
"enabled": true,
"name": "xml_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_rpc": {
"id": 49,
"position": 49,
"enabled": true,
"name": "xml_rpc.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"zeroconf": {
"id": 50,
"position": 50,
"enabled": true,
"name": "zeroconf.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"directory": {
"id": 16,
"position": 16,
"enabled": true,
"name": "directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fifo": {
"id": 22,
"position": 22,
"enabled": true,
"name": "fifo.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"opal": {
"id": 30,
"position": 30,
"enabled": true,
"name": "opal.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"osp": {
"id": 33,
"position": 33,
"enabled": true,
"name": "osp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"unicall": {
"id": 45,
"position": 45,
"enabled": true,
"name": "unicall.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference": {
"id": 11,
"position": 11,
"enabled": true,
"name": "conference.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference_layouts": {
"id": 12,
"position": 12,
"enabled": true,
"name": "conference_layouts.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"post_load_modules": {
"id": 36,
"position": 36,
"enabled": true,
"name": "post_load_modules.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"voicemail": {
"id": 47,
"position": 47,
"enabled": true,
"name": "voicemail.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
}
}
}
[ Config][ Switch] Module.
Event value
[Config][Switch] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config][From scratch] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][From scratch] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"alsa"}}'
exampleSocket.send('{"event":"[Config][From scratch] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"alsa"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][From scratch] Module"
}
[ Config][ From scratch] Module.
Event value
[Config][From scratch] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
[Config][Import] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Import] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"alsa"}}'
exampleSocket.send('{"event":"[Config][Import] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"alsa"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Import] Module"
}
[ Config][ Import] Module.
Event value
[Config][Import] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| token | String | User auth token. |
Errors
[Config][Import] All Modules
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Import] All Modules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config][Import] All Modules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Import] All Modules"
}
[ Config][ Import] All Modules.
Event value
[Config][Import] All Modules
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
TruncateModuleConfig
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"TruncateModuleConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":54}}'
exampleSocket.send('{"event":"TruncateModuleConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":54}}');
Returns JSON structured like this:
{
"MessageType": "TruncateModuleConfig",
"modules": {
"post_load_switch": {
"id": 43,
"position": 43,
"enabled": true,
"name": "post_load_switch.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"acl": {
"id": 1,
"position": 1,
"enabled": true,
"name": "acl.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"callcenter": {
"id": 6,
"position": 6,
"enabled": true,
"name": "callcenter.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_pg_csv": {
"id": 8,
"position": 8,
"enabled": true,
"name": "cdr_pg_csv.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"odbc_cdr": {
"id": 51,
"position": 51,
"enabled": true,
"name": "odbc_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lcr": {
"id": 24,
"position": 24,
"enabled": true,
"name": "lcr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sofia": {
"id": 42,
"position": 42,
"enabled": true,
"name": "sofia.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"verto": {
"id": 46,
"position": 46,
"enabled": true,
"name": "verto.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"shout": {
"id": 40,
"position": 40,
"enabled": true,
"name": "shout.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"redis": {
"id": 38,
"position": 38,
"enabled": true,
"name": "redis.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"nibblebill": {
"id": 29,
"position": 29,
"enabled": true,
"name": "nibblebill.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"db": {
"id": 14,
"position": 14,
"enabled": true,
"name": "db.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"distributor": {
"id": 17,
"position": 17,
"enabled": true,
"name": "distributor.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"memcache": {
"id": 26,
"position": 26,
"enabled": true,
"name": "memcache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"avmd": {
"id": 5,
"position": 5,
"enabled": true,
"name": "avmd.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"tts_commandline": {
"id": 44,
"position": 44,
"enabled": true,
"name": "tts_commandline.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_mongodb": {
"id": 7,
"position": 7,
"enabled": true,
"name": "cdr_mongodb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"http_cache": {
"id": 23,
"position": 23,
"enabled": true,
"name": "http_cache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"opus": {
"id": 31,
"position": 31,
"enabled": true,
"name": "opus.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"python": {
"id": 37,
"position": 37,
"enabled": true,
"name": "python.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"alsa": null,
"amr": {
"id": 52,
"position": 52,
"enabled": false,
"name": "amr.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"amrwb": {
"id": 4,
"position": 4,
"enabled": true,
"name": "amrwb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cepstral": {
"id": 9,
"position": 9,
"enabled": true,
"name": "cepstral.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cidlookup": {
"id": 10,
"position": 10,
"enabled": true,
"name": "cidlookup.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"curl": {
"id": 13,
"position": 13,
"enabled": true,
"name": "curl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"dialplan_directory": {
"id": 15,
"position": 15,
"enabled": true,
"name": "dialplan_directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"easyroute": {
"id": 18,
"position": 18,
"enabled": true,
"name": "easyroute.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"erlang_event": {
"id": 19,
"position": 19,
"enabled": true,
"name": "erlang_event.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"event_multicast": {
"id": 20,
"position": 20,
"enabled": true,
"name": "event_multicast.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fax": {
"id": 21,
"position": 21,
"enabled": true,
"name": "fax.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lua": {
"id": 25,
"position": 25,
"enabled": true,
"name": "lua.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"mongo": {
"id": 27,
"position": 27,
"enabled": true,
"name": "mongo.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"msrp": {
"id": 28,
"position": 28,
"enabled": true,
"name": "msrp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"oreka": {
"id": 32,
"position": 32,
"enabled": true,
"name": "oreka.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"perl": {
"id": 34,
"position": 34,
"enabled": true,
"name": "perl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"pocketsphinx": {
"id": 35,
"position": 35,
"enabled": true,
"name": "pocketsphinx.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sangoma_codec": {
"id": 39,
"position": 39,
"enabled": true,
"name": "sangoma_codec.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sndfile": {
"id": 41,
"position": 41,
"enabled": true,
"name": "sndfile.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_cdr": {
"id": 48,
"position": 48,
"enabled": true,
"name": "xml_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_rpc": {
"id": 49,
"position": 49,
"enabled": true,
"name": "xml_rpc.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"zeroconf": {
"id": 50,
"position": 50,
"enabled": true,
"name": "zeroconf.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"directory": {
"id": 16,
"position": 16,
"enabled": true,
"name": "directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fifo": {
"id": 22,
"position": 22,
"enabled": true,
"name": "fifo.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"opal": {
"id": 30,
"position": 30,
"enabled": true,
"name": "opal.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"osp": {
"id": 33,
"position": 33,
"enabled": true,
"name": "osp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"unicall": {
"id": 45,
"position": 45,
"enabled": true,
"name": "unicall.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference": {
"id": 11,
"position": 11,
"enabled": true,
"name": "conference.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference_layouts": {
"id": 12,
"position": 12,
"enabled": true,
"name": "conference_layouts.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"post_load_modules": {
"id": 36,
"position": 36,
"enabled": true,
"name": "post_load_modules.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"voicemail": {
"id": 47,
"position": 47,
"enabled": true,
"name": "voicemail.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
}
}
}
Truncate Module Config.
Event value
TruncateModuleConfig
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
ImportXMLModuleConfig
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportXMLModuleConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"<configuration name=\"alsa.conf\" description=\"Soundcard Endpoint\">\r\n <settings>\r\n <!--Default dialplan and caller-id info -->\r\n <param name=\"dialplan\" value=\"XML\"/>\r\n <param name=\"cid-name\" value=\"N800 Alsa\"/>\r\n <param name=\"cid-num\" value=\"5555551212\"/>\r\n\r\n <!--audio sample rate and interval -->\r\n <param name=\"sample-rate\" value=\"8000\"/>\r\n <param name=\"codec-ms\" value=\"20\"/>\r\n </settings>\r\n</configuration>"}}'
exampleSocket.send('{"event":"ImportXMLModuleConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","file":"<configuration name=\"alsa.conf\" description=\"Soundcard Endpoint\">\r\n <settings>\r\n <!--Default dialplan and caller-id info -->\r\n <param name=\"dialplan\" value=\"XML\"/>\r\n <param name=\"cid-name\" value=\"N800 Alsa\"/>\r\n <param name=\"cid-num\" value=\"5555551212\"/>\r\n\r\n <!--audio sample rate and interval -->\r\n <param name=\"sample-rate\" value=\"8000\"/>\r\n <param name=\"codec-ms\" value=\"20\"/>\r\n </settings>\r\n</configuration>"}}');
Returns JSON structured like this:
{
"MessageType": "ImportXMLModuleConfig",
"modules": {
"post_load_switch": {
"id": 43,
"position": 43,
"enabled": true,
"name": "post_load_switch.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"acl": {
"id": 1,
"position": 1,
"enabled": true,
"name": "acl.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"callcenter": {
"id": 6,
"position": 6,
"enabled": true,
"name": "callcenter.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_pg_csv": {
"id": 8,
"position": 8,
"enabled": true,
"name": "cdr_pg_csv.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"odbc_cdr": {
"id": 51,
"position": 51,
"enabled": true,
"name": "odbc_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lcr": {
"id": 24,
"position": 24,
"enabled": true,
"name": "lcr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sofia": {
"id": 42,
"position": 42,
"enabled": true,
"name": "sofia.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"verto": {
"id": 46,
"position": 46,
"enabled": true,
"name": "verto.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"shout": {
"id": 40,
"position": 40,
"enabled": true,
"name": "shout.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"redis": {
"id": 38,
"position": 38,
"enabled": true,
"name": "redis.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"nibblebill": {
"id": 29,
"position": 29,
"enabled": true,
"name": "nibblebill.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"db": {
"id": 14,
"position": 14,
"enabled": true,
"name": "db.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"distributor": {
"id": 17,
"position": 17,
"enabled": true,
"name": "distributor.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"memcache": {
"id": 26,
"position": 26,
"enabled": true,
"name": "memcache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"avmd": {
"id": 5,
"position": 5,
"enabled": true,
"name": "avmd.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"tts_commandline": {
"id": 44,
"position": 44,
"enabled": true,
"name": "tts_commandline.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cdr_mongodb": {
"id": 7,
"position": 7,
"enabled": true,
"name": "cdr_mongodb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"http_cache": {
"id": 23,
"position": 23,
"enabled": true,
"name": "http_cache.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"opus": {
"id": 31,
"position": 31,
"enabled": true,
"name": "opus.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"python": {
"id": 37,
"position": 37,
"enabled": true,
"name": "python.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"alsa": {
"id": 55,
"position": 53,
"enabled": true,
"name": "alsa.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"amr": {
"id": 52,
"position": 52,
"enabled": false,
"name": "amr.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"amrwb": {
"id": 4,
"position": 4,
"enabled": true,
"name": "amrwb.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cepstral": {
"id": 9,
"position": 9,
"enabled": true,
"name": "cepstral.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"cidlookup": {
"id": 10,
"position": 10,
"enabled": true,
"name": "cidlookup.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"curl": {
"id": 13,
"position": 13,
"enabled": true,
"name": "curl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"dialplan_directory": {
"id": 15,
"position": 15,
"enabled": true,
"name": "dialplan_directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"easyroute": {
"id": 18,
"position": 18,
"enabled": true,
"name": "easyroute.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"erlang_event": {
"id": 19,
"position": 19,
"enabled": true,
"name": "erlang_event.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"event_multicast": {
"id": 20,
"position": 20,
"enabled": true,
"name": "event_multicast.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fax": {
"id": 21,
"position": 21,
"enabled": true,
"name": "fax.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"lua": {
"id": 25,
"position": 25,
"enabled": true,
"name": "lua.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"mongo": {
"id": 27,
"position": 27,
"enabled": true,
"name": "mongo.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"msrp": {
"id": 28,
"position": 28,
"enabled": true,
"name": "msrp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"oreka": {
"id": 32,
"position": 32,
"enabled": true,
"name": "oreka.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"perl": {
"id": 34,
"position": 34,
"enabled": true,
"name": "perl.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"pocketsphinx": {
"id": 35,
"position": 35,
"enabled": true,
"name": "pocketsphinx.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sangoma_codec": {
"id": 39,
"position": 39,
"enabled": true,
"name": "sangoma_codec.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"sndfile": {
"id": 41,
"position": 41,
"enabled": true,
"name": "sndfile.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_cdr": {
"id": 48,
"position": 48,
"enabled": true,
"name": "xml_cdr.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"xml_rpc": {
"id": 49,
"position": 49,
"enabled": true,
"name": "xml_rpc.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"zeroconf": {
"id": 50,
"position": 50,
"enabled": true,
"name": "zeroconf.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"directory": {
"id": 16,
"position": 16,
"enabled": true,
"name": "directory.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"fifo": {
"id": 22,
"position": 22,
"enabled": true,
"name": "fifo.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"opal": {
"id": 30,
"position": 30,
"enabled": true,
"name": "opal.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"osp": {
"id": 33,
"position": 33,
"enabled": true,
"name": "osp.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"unicall": {
"id": 45,
"position": 45,
"enabled": true,
"name": "unicall.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference": {
"id": 11,
"position": 11,
"enabled": true,
"name": "conference.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
},
"conference_layouts": {
"id": 12,
"position": 12,
"enabled": true,
"name": "conference_layouts.conf",
"module": "",
"loaded": false,
"unloadable": false,
"parent": {
"id": 1
}
},
"post_load_modules": {
"id": 36,
"position": 36,
"enabled": true,
"name": "post_load_modules.conf",
"module": "",
"loaded": false,
"unloadable": true,
"parent": {
"id": 1
}
},
"voicemail": {
"id": 47,
"position": 47,
"enabled": true,
"name": "voicemail.conf",
"module": "",
"loaded": true,
"unloadable": false,
"parent": {
"id": 1
}
}
}
}
Import XMLModule Config.
Event value
ImportXMLModuleConfig
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| file | String |
Errors
[Config][Autoload] Module
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Autoload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":55}}'
exampleSocket.send('{"event":"[Config][Autoload] Module","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":55}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Autoload] Module",
"data": {
"id": 15,
"position": 12,
"enabled": true,
"name": "mod_alsa",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Autoload] Module.
Event value
[Config][Autoload] Module
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Acl
[Config] Get_acl_lists
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_acl_lists","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config] Get_acl_lists","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_acl_lists",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "lan",
"default": "allow",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "domains",
"default": "deny",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
[ Config] Get_acl_lists.
Event value
[Config] Get_acl_lists
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config] Add_acl_list
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"dddd","default":"deny"}}'
exampleSocket.send('{"event":"[Config] Add_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"dddd","default":"deny"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_acl_list",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "dddd",
"default": "deny",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Add_acl_list.
Event value
[Config] Add_acl_list
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
| default | String |
Errors
[Config] Update_acl_list
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"dddd2"}}'
exampleSocket.send('{"event":"[Config] Update_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"dddd2"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_acl_list",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "dddd2",
"default": "deny",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Update_acl_list.
Event value
[Config] Update_acl_list
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
[Config] Del_acl_list
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}'
exampleSocket.send('{"event":"[Config] Del_acl_list","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_acl_list",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "dddd2",
"default": "deny",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Del_acl_list.
Event value
[Config] Del_acl_list
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Update_acl_list_default
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_acl_list_default","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"allow","id":5}}'
exampleSocket.send('{"event":"[Config] Update_acl_list_default","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"allow","id":5}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_acl_list_default",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "ccc",
"default": "allow",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Update_acl_list_default.
Event value
[Config] Update_acl_list_default
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| value | String | Item value |
| id | Integer | Item ID. |
Errors
[Config] Get_acl_nodes
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_acl_nodes","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"[Config] Get_acl_nodes","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_acl_nodes",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"type": "deny",
"cidr": "192.168.42.0/24",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 4,
"enabled": true,
"type": "allow",
"cidr": "192.168.42.42/32",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 5,
"enabled": false,
"type": "2",
"cidr": "2",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
}
[ Config] Get_acl_nodes.
Event value
[Config] Get_acl_nodes
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Add_acl_node
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"node":{"type":"allow","cidr":"0.0.0.0","domain":""}}}'
exampleSocket.send('{"event":"[Config] Add_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"node":{"type":"allow","cidr":"0.0.0.0","domain":""}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_acl_node",
"data": {
"id": 9,
"position": 6,
"enabled": true,
"type": "allow",
"cidr": "0.0.0.0",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
[ Config] Add_acl_node.
Event value
[Config] Add_acl_node
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| node | Object | |
| - type | String | |
| - cidr | String | |
| - domain | String |
Errors
[Config] Del_acl_node
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}'
exampleSocket.send('{"event":"[Config] Del_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_acl_node",
"data": {
"id": 9,
"position": 6,
"enabled": true,
"type": "allow",
"cidr": "0.0.0.0",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
[ Config] Del_acl_node.
Event value
[Config] Del_acl_node
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Update_acl_node
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","node":{"id":7,"type":"deny","cidr":"0.0.0.0","domain":""}}}'
exampleSocket.send('{"event":"[Config] Update_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","node":{"id":7,"type":"deny","cidr":"0.0.0.0","domain":""}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_acl_node",
"data": {
"id": 7,
"position": 5,
"enabled": true,
"type": "deny",
"cidr": "0.0.0.0",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
[ Config] Update_acl_node.
Event value
[Config] Update_acl_node
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| node | Object | |
| - id | Integer | Item ID. |
| - type | String | |
| - cidr | String | |
| - domain | String |
Errors
[Config] Switch_acl_node
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","node":{"id":7,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_acl_node","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","node":{"id":7,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_acl_node",
"data": {
"id": 7,
"position": 5,
"enabled": false,
"type": "deny",
"cidr": "0.0.0.0",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
[ Config] Switch_acl_node.
Event value
[Config] Switch_acl_node
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| node | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
MoveAclListNode
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"MoveAclListNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":1,"current_index":4,"id":1}}'
exampleSocket.send('{"event":"MoveAclListNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":1,"current_index":4,"id":1}}');
Returns JSON structured like this:
{
"MessageType": "MoveAclListNode",
"data": {
"1": {
"id": 1,
"position": 4,
"enabled": true,
"type": "deny",
"cidr": "192.168.42.0/24",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 3,
"enabled": true,
"type": "allow",
"cidr": "192.168.42.42/32",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 5,
"enabled": false,
"type": "deny",
"cidr": "0.0.0.0",
"domain": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"default": "",
"description": "",
"parent": null
}
}
}
}
Move Acl List Node.
Event value
MoveAclListNode
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer | |
| id | Integer | Item ID. |
Errors
Sofia
[Config] Get_sofia_global_settings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_global_settings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config] Get_sofia_global_settings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_global_settings",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "log-level",
"value": "0",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "debug-presence",
"value": "0",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
[ Config] Get_sofia_global_settings.
Event value
[Config] Get_sofia_global_settings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config] Update_sofia_global_setting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"[Config] Update_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_sofia_global_setting",
"data": {
"id": 10,
"position": 3,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Update_sofia_global_setting.
Event value
[Config] Update_sofia_global_setting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
[Config] Switch_sofia_global_setting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_global_setting",
"data": {
"id": 2,
"position": 2,
"enabled": false,
"name": "debug-presence",
"value": "0",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Switch_sofia_global_setting.
Event value
[Config] Switch_sofia_global_setting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
[Config] Add_sofia_global_setting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"[Config] Add_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_global_setting",
"data": {
"id": 10,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Add_sofia_global_setting.
Event value
[Config] Add_sofia_global_setting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - name | String | Item name |
Errors
[Config] Del_sofia_global_setting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}'
exampleSocket.send('{"event":"[Config] Del_sofia_global_setting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_global_setting",
"data": {
"id": 10,
"position": 3,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config] Del_sofia_global_setting.
Event value
[Config] Del_sofia_global_setting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config] Get_sofia_profiles
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_profiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config] Get_sofia_profiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_profiles",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "external-ipv6",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": true,
"state": "RUNNING (0)",
"uri": "sip:mod_sofia@[::1]:5080"
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "external",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": true,
"state": "RUNNING (0)",
"uri": "sip:mod_sofia@domain.com:5080"
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "internal-ipv6",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": true,
"state": "RUNNING (0)",
"uri": "sip:mod_sofia@[::1]:5060"
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "internal",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": true,
"state": "RUNNING (21) (WSS)",
"uri": "sips:mod_sofia@domain.com:7443;transport=wss"
}
}
}
[ Config] Get_sofia_profiles.
Event value
[Config] Get_sofia_profiles
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config] Get_sofia_profiles_params
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_profiles_params","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"[Config] Get_sofia_profiles_params","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_profiles_params",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "debug",
"value": "0",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "outbound-codec-prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "hold-music",
"value": "local_stream://moh",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"12": {
"id": 12,
"position": 12,
"enabled": true,
"name": "rtp-timer-name",
"value": "soft",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"13": {
"id": 13,
"position": 13,
"enabled": true,
"name": "local-network-acl",
"value": "localnet.auto",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"14": {
"id": 14,
"position": 14,
"enabled": true,
"name": "manage-presence",
"value": "false",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"15": {
"id": 15,
"position": 15,
"enabled": true,
"name": "inbound-codec-negotiation",
"value": "generous",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"16": {
"id": 16,
"position": 16,
"enabled": true,
"name": "nonce-ttl",
"value": "60",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"17": {
"id": 17,
"position": 17,
"enabled": true,
"name": "auth-calls",
"value": "false",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"18": {
"id": 18,
"position": 18,
"enabled": true,
"name": "inbound-late-negotiation",
"value": "true",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"19": {
"id": 19,
"position": 19,
"enabled": true,
"name": "inbound-zrtp-passthru",
"value": "true",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "sip-trace",
"value": "no",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"20": {
"id": 20,
"position": 20,
"enabled": true,
"name": "rtp-ip",
"value": "::1",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"21": {
"id": 21,
"position": 21,
"enabled": true,
"name": "sip-ip",
"value": "::1",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"22": {
"id": 22,
"position": 22,
"enabled": true,
"name": "rtp-timeout-sec",
"value": "300",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"23": {
"id": 23,
"position": 23,
"enabled": true,
"name": "rtp-hold-timeout-sec",
"value": "1800",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"24": {
"id": 24,
"position": 24,
"enabled": true,
"name": "tls",
"value": "false",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"25": {
"id": 25,
"position": 25,
"enabled": true,
"name": "tls-only",
"value": "false",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"26": {
"id": 26,
"position": 26,
"enabled": true,
"name": "tls-bind-params",
"value": "transport=tls",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"27": {
"id": 27,
"position": 27,
"enabled": true,
"name": "tls-sip-port",
"value": "5081",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"28": {
"id": 28,
"position": 28,
"enabled": true,
"name": "tls-passphrase",
"value": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"29": {
"id": 29,
"position": 29,
"enabled": true,
"name": "tls-verify-date",
"value": "true",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "sip-capture",
"value": "no",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"30": {
"id": 30,
"position": 30,
"enabled": true,
"name": "tls-verify-policy",
"value": "none",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"31": {
"id": 31,
"position": 31,
"enabled": true,
"name": "tls-verify-depth",
"value": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"32": {
"id": 32,
"position": 32,
"enabled": true,
"name": "tls-verify-in-subjects",
"value": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"33": {
"id": 33,
"position": 33,
"enabled": true,
"name": "tls-version",
"value": "tlsv1,tlsv1.1,tlsv1.2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "rfc2833-pt",
"value": "101",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "sip-port",
"value": "5080",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "context",
"value": "public",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "dtmf-duration",
"value": "2000",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "inbound-codec-prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
}
[ Config] Get_sofia_profiles_params.
Event value
[Config] Get_sofia_profiles_params
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Add_sofia_profile_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile_param",
"data": {
"id": 180,
"position": 34,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Add_sofia_profile_param.
Event value
[Config] Add_sofia_profile_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config] Del_sofia_profile_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180}}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile_param",
"data": {
"id": 180,
"position": 34,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Del_sofia_profile_param.
Event value
[Config] Del_sofia_profile_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config] Switch_sofia_profile_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_profile_param",
"data": {
"id": 180,
"position": 34,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Switch_sofia_profile_param.
Event value
[Config] Switch_sofia_profile_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config] Update_sofia_profile_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"[Config] Update_sofia_profile_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":180,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_sofia_profile_param",
"data": {
"id": 180,
"position": 34,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Update_sofia_profile_param.
Event value
[Config] Update_sofia_profile_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config] Get_sofia_profile_gateways
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_profile_gateways","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"keep_subscription":true}}'
exampleSocket.send('{"event":"[Config] Get_sofia_profile_gateways","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"keep_subscription":true}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_profile_gateways",
"data": {
"9": {
"id": 9,
"position": 1,
"enabled": true,
"name": "test",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
},
"started": false,
"state": ""
}
}
}
[ Config] Get_sofia_profile_gateways.
Event value
[Config] Get_sofia_profile_gateways
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| keep_subscription | Boolean |
Errors
GetSofiaProfileGatewayParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetSofiaProfileGatewayParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}'
exampleSocket.send('{"event":"GetSofiaProfileGatewayParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9}}');
Returns JSON structured like this:
{
"MessageType": "GetSofiaProfileGatewayParameters",
"data": {
"20": {
"id": 20,
"position": 1,
"enabled": true,
"name": "test",
"value": "param",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": ""
}
}
}
}
Get Sofia Profile Gateway Parameters.
Event value
GetSofiaProfileGatewayParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Add_sofia_profile_gateway_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":9,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile_gateway_param",
"data": {
"id": 21,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": ""
}
}
}
[ Config] Add_sofia_profile_gateway_param.
Event value
[Config] Add_sofia_profile_gateway_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config] Update_sofia_profile_gateway_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"[Config] Update_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_sofia_profile_gateway_param",
"data": {
"id": 21,
"position": 2,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": ""
}
}
}
[ Config] Update_sofia_profile_gateway_param.
Event value
[Config] Update_sofia_profile_gateway_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config] Switch_sofia_profile_gateway_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_profile_gateway_param",
"data": {
"id": 21,
"position": 2,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": ""
}
}
}
[ Config] Switch_sofia_profile_gateway_param.
Event value
[Config] Switch_sofia_profile_gateway_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config] Del_sofia_profile_gateway_param
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile_gateway_param","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile_gateway_param",
"data": {
"id": 21,
"position": 2,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": ""
}
}
}
[ Config] Del_sofia_profile_gateway_param.
Event value
[Config] Del_sofia_profile_gateway_param
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config] Add_sofia_profile_gateway
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"test_gw","id":2}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"test_gw","id":2}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile_gateway",
"data": {
"id": 10,
"position": 2,
"enabled": true,
"name": "test_gw",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
},
"started": false,
"state": ""
}
}
[ Config] Add_sofia_profile_gateway.
Event value
[Config] Add_sofia_profile_gateway
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
| id | Integer | Item ID. |
Errors
[Config] Del_sofia_profile_gateway
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile_gateway",
"data": {
"id": 10,
"position": 2,
"enabled": true,
"name": "test_gw2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
},
"started": false,
"state": ""
}
}
[ Config] Del_sofia_profile_gateway.
Event value
[Config] Del_sofia_profile_gateway
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Rename_sofia_profile_gateway
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Rename_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"name":"test_gw2"}}'
exampleSocket.send('{"event":"[Config] Rename_sofia_profile_gateway","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"name":"test_gw2"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Rename_sofia_profile_gateway",
"data": {
"id": 10,
"position": 2,
"enabled": true,
"name": "test_gw2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
},
"started": false,
"state": ""
}
}
[ Config] Rename_sofia_profile_gateway.
Event value
[Config] Rename_sofia_profile_gateway
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
[Config] Get_sofia_profile_domains
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_profile_domains","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"[Config] Get_sofia_profile_domains","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_profile_domains",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "all",
"alias": false,
"parse": true,
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
}
[ Config] Get_sofia_profile_domains.
Event value
[Config] Get_sofia_profile_domains
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Add_sofia_profile_domain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"sofia_domain":{"name":"domain2","alias":true,"parse":false}}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"sofia_domain":{"name":"domain2","alias":true,"parse":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile_domain",
"data": {
"id": 12,
"position": 2,
"enabled": true,
"name": "domain2",
"alias": true,
"parse": false,
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Add_sofia_profile_domain.
Event value
[Config] Add_sofia_profile_domain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| sofia_domain | Object | |
| - name | String | Item name |
| - alias | Boolean | |
| - parse | Boolean |
Errors
[Config] Del_sofia_profile_domain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1}}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile_domain",
"data": {
"id": 12,
"position": 2,
"enabled": true,
"name": "domain2",
"alias": true,
"parse": false,
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Del_sofia_profile_domain.
Event value
[Config] Del_sofia_profile_domain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_domain | Object | |
| - id | Integer | Item ID. |
Errors
[Config] Switch_sofia_profile_domain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_profile_domain",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "all",
"alias": false,
"parse": true,
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Switch_sofia_profile_domain.
Event value
[Config] Switch_sofia_profile_domain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_domain | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config] Update_sofia_profile_domain
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1,"name":"all","alias":false,"parse":true}}}'
exampleSocket.send('{"event":"[Config] Update_sofia_profile_domain","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_domain":{"id":1,"name":"all","alias":false,"parse":true}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_sofia_profile_domain",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "all",
"alias": false,
"parse": true,
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Update_sofia_profile_domain.
Event value
[Config] Update_sofia_profile_domain
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_domain | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - alias | Boolean | |
| - parse | Boolean |
Errors
[Config] Get_sofia_profile_aliases
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Get_sofia_profile_aliases","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"[Config] Get_sofia_profile_aliases","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Get_sofia_profile_aliases",
"data": {
"4": {
"id": 4,
"position": 1,
"enabled": true,
"name": "domain_alias",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
}
[ Config] Get_sofia_profile_aliases.
Event value
[Config] Get_sofia_profile_aliases
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config] Add_sofia_profile_alias
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"sofia_alias":{"name":"domain_alias2"}}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"sofia_alias":{"name":"domain_alias2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile_alias",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "domain_alias2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Add_sofia_profile_alias.
Event value
[Config] Add_sofia_profile_alias
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
| sofia_alias | Object | |
| - name | String | Item name |
Errors
[Config] Del_sofia_profile_alias
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":5}}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile_alias",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "domain_alias2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Del_sofia_profile_alias.
Event value
[Config] Del_sofia_profile_alias
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_alias | Object | |
| - id | Integer | Item ID. |
Errors
[Config] Switch_sofia_profile_alias
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_profile_alias",
"data": {
"id": 4,
"position": 1,
"enabled": false,
"name": "domain_alias",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Switch_sofia_profile_alias.
Event value
[Config] Switch_sofia_profile_alias
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_alias | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config] Update_sofia_profile_alias
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Update_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":4,"name":"domain_alias3"}}}'
exampleSocket.send('{"event":"[Config] Update_sofia_profile_alias","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","sofia_alias":{"id":4,"name":"domain_alias3"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Update_sofia_profile_alias",
"data": {
"id": 4,
"position": 1,
"enabled": true,
"name": "domain_alias3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config] Update_sofia_profile_alias.
Event value
[Config] Update_sofia_profile_alias
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| sofia_alias | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
[Config] Add_sofia_profile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Add_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"[Config] Add_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Add_sofia_profile",
"data": {
"id": 19,
"position": 5,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": false,
"state": "",
"uri": ""
}
}
[ Config] Add_sofia_profile.
Event value
[Config] Add_sofia_profile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
[Config] Rename_sofia_profile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Rename_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":19,"name":"new_profile2"}}'
exampleSocket.send('{"event":"[Config] Rename_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":19,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Rename_sofia_profile",
"data": {
"id": 19,
"position": 5,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": false,
"state": "",
"uri": ""
}
}
[ Config] Rename_sofia_profile.
Event value
[Config] Rename_sofia_profile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
[Config] Del_sofia_profile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Del_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"[Config] Del_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Del_sofia_profile",
"data": {
"id": 19,
"position": 5,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": false,
"state": "",
"uri": ""
}
}
[ Config] Del_sofia_profile.
Event value
[Config] Del_sofia_profile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
[API] Sofia profile command
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[API] Sofia profile command","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"stop","id":1,"id_int":0}}'
exampleSocket.send('{"event":"[API] Sofia profile command","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"stop","id":1,"id_int":0}}');
Returns JSON structured like this:
{
"MessageType": "[API] Sofia profile command"
}
[ API] Sofia profile command.
Event value
[API] Sofia profile command
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| id_int | Integer | |
| token | String | User auth token. |
| name | String | Item name |
Errors
[Config] Switch_sofia_profile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config] Switch_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"enabled":false}}'
exampleSocket.send('{"event":"[Config] Switch_sofia_profile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"enabled":false}}');
Returns JSON structured like this:
{
"MessageType": "[Config] Switch_sofia_profile",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "external-ipv6",
"description": "",
"parent": {
"id": 42,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
},
"started": false,
"state": "",
"uri": ""
}
}
[ Config] Switch_sofia_profile.
Event value
[Config] Switch_sofia_profile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
Cdr_Pg_Csv
[Config][Get] Cdr_Pg_Csv
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Get] Cdr_Pg_Csv","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config][Get] Cdr_Pg_Csv","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Get] Cdr_Pg_Csv",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "db-info",
"value": "host=localhost dbname=cdr connect_timeout=10",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "legs",
"value": "a",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "spool-format",
"value": "csv",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "rotate-on-hup",
"value": "true",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"schemas": {}
}
}
[ Config][ Get] Cdr_ Pg_ Csv.
Event value
[Config][Get] Cdr_Pg_Csv
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config][Add] Cdr_Pg_Csv Parameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Add] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"[Config][Add] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Add] Cdr_Pg_Csv Parameter",
"data": {
"id": 12,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Add] Cdr_ Pg_ Csv Parameter.
Event value
[Config][Add] Cdr_Pg_Csv Parameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config][Update] Cdr_Pg_Csv Parameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Update] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"[Config][Update] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Update] Cdr_Pg_Csv Parameter",
"data": {
"id": 12,
"position": 5,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Update] Cdr_ Pg_ Csv Parameter.
Event value
[Config][Update] Cdr_Pg_Csv Parameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
[Config][Switch] Cdr_Pg_Csv Parameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Switch] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"enabled":false}}}'
exampleSocket.send('{"event":"[Config][Switch] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Switch] Cdr_Pg_Csv Parameter",
"data": {
"id": 12,
"position": 5,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Switch] Cdr_ Pg_ Csv Parameter.
Event value
[Config][Switch] Cdr_Pg_Csv Parameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config][Delete] Cdr_Pg_Csv Parameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Delete] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1}}}'
exampleSocket.send('{"event":"[Config][Delete] Cdr_Pg_Csv Parameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Delete] Cdr_Pg_Csv Parameter",
"data": {
"id": 12,
"position": 5,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Delete] Cdr_ Pg_ Csv Parameter.
Event value
[Config][Delete] Cdr_Pg_Csv Parameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config][Add] Cdr_Pg_Csv Field
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Add] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"var":"var","column":"column"}}}'
exampleSocket.send('{"event":"[Config][Add] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"var":"var","column":"column"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Add] Cdr_Pg_Csv Field",
"data": {
"id": 21,
"position": 1,
"enabled": true,
"var": "var",
"column": "column",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Add] Cdr_ Pg_ Csv Field.
Event value
[Config][Add] Cdr_Pg_Csv Field
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| field | Object | |
| - var | String | |
| - column | String |
Errors
[Config][Update] Cdr_Pg_Csv Field
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Update] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":21,"var":"var2","column":"column2"}}}'
exampleSocket.send('{"event":"[Config][Update] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":21,"var":"var2","column":"column2"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Update] Cdr_Pg_Csv Field",
"data": {
"id": 21,
"position": 1,
"enabled": true,
"var": "var2",
"column": "column2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Update] Cdr_ Pg_ Csv Field.
Event value
[Config][Update] Cdr_Pg_Csv Field
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| field | Object | |
| - column | String | |
| - id | Integer | Item ID. |
| - var | String |
Errors
[Config][Switch] Cdr_Pg_Csv Field
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Switch] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":21,"enabled":false}}}'
exampleSocket.send('{"event":"[Config][Switch] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":21,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Switch] Cdr_Pg_Csv Field",
"data": {
"id": 21,
"position": 1,
"enabled": false,
"var": "var2",
"column": "column2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Switch] Cdr_ Pg_ Csv Field.
Event value
[Config][Switch] Cdr_Pg_Csv Field
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| field | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config][Delete] Cdr_Pg_Csv Field
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Delete] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":2}}}'
exampleSocket.send('{"event":"[Config][Delete] Cdr_Pg_Csv Field","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","field":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Delete] Cdr_Pg_Csv Field",
"data": {
"id": 21,
"position": 1,
"enabled": false,
"var": "var2",
"column": "column2",
"description": "",
"parent": {
"id": 8,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Delete] Cdr_ Pg_ Csv Field.
Event value
[Config][Delete] Cdr_Pg_Csv Field
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| field | Object | |
| - id | Integer | Item ID. |
Errors
GetOdbcCdr
GetOdbcCdr
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOdbcCdr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetOdbcCdr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetOdbcCdr",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "safdfsadf",
"value": "dsafasdf",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "dfdsfd",
"value": "fdfd",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"tables": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "sfasf",
"log_leg": "asasasa2",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "cccc",
"log_leg": "",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Odbc Cdr.
Event value
GetOdbcCdr
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetOdbcCdrField
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetOdbcCdrField",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "gg",
"chan_var_name": "gddd",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "sss",
"chan_var_name": "ssss",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
}
}
}
Get Odbc Cdr Field.
Event value
GetOdbcCdrField
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddOdbcCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOdbcCdrParameter",
"data": {
"id": 7,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Odbc Cdr Parameter.
Event value
AddOdbcCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - name | String | Item name |
Errors
UpdateOdbcCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOdbcCdrParameter",
"data": {
"id": 7,
"position": 3,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Odbc Cdr Parameter.
Event value
UpdateOdbcCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchOdbcCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOdbcCdrParameter",
"data": {
"id": 7,
"position": 3,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Odbc Cdr Parameter.
Event value
SwitchOdbcCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
DeleteOdbcCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}'
exampleSocket.send('{"event":"DeleteOdbcCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}');
Returns JSON structured like this:
{
"MessageType": "DeleteOdbcCdrParameter",
"data": {
"id": 7,
"position": 3,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Delete Odbc Cdr Parameter.
Event value
DeleteOdbcCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
AddOdbcCdrTable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"name":"new_table"}}}'
exampleSocket.send('{"event":"AddOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"name":"new_table"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOdbcCdrTable",
"data": {
"id": 9,
"position": 3,
"enabled": true,
"name": "new_table",
"log_leg": "",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Odbc Cdr Table.
Event value
AddOdbcCdrTable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| table | Object | |
| - name | String | Item name |
Errors
UpdateOdbcCdrTable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"id":9,"name":"new_table2","log_leg":""}}}'
exampleSocket.send('{"event":"UpdateOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"id":9,"name":"new_table2","log_leg":""}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOdbcCdrTable",
"data": {
"id": 9,
"position": 3,
"enabled": true,
"name": "new_table2",
"log_leg": "",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Odbc Cdr Table.
Event value
UpdateOdbcCdrTable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| table | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - log_leg | String |
Errors
DeleteOdbcCdrTable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"id":9}}}'
exampleSocket.send('{"event":"DeleteOdbcCdrTable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","table":{"id":9}}}');
Returns JSON structured like this:
{
"MessageType": "DeleteOdbcCdrTable",
"data": {
"id": 9,
"position": 3,
"enabled": true,
"name": "new_table2",
"log_leg": "",
"description": "",
"parent": {
"id": 51,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Delete Odbc Cdr Table.
Event value
DeleteOdbcCdrTable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| table | Object | |
| - id | Integer | Item ID. |
Errors
AddOdbcCdrField
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"name":"new_field","chan_var_name":"New_chan_var_name"},"id":1}}'
exampleSocket.send('{"event":"AddOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"name":"new_field","chan_var_name":"New_chan_var_name"},"id":1}}');
Returns JSON structured like this:
{
"MessageType": "AddOdbcCdrField",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_field",
"chan_var_name": "New_chan_var_name",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
}
}
Add Odbc Cdr Field.
Event value
AddOdbcCdrField
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| odbc_cdr_field | Object | |
| - name | String | Item name |
| - chan_var_name | String |
Errors
UpdateOdbcCdrField
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4,"name":"new_field2","chan_var_name":"New_chan_var_name2"}}}'
exampleSocket.send('{"event":"UpdateOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4,"name":"new_field2","chan_var_name":"New_chan_var_name2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOdbcCdrField",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_field2",
"chan_var_name": "New_chan_var_name2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
}
}
Update Odbc Cdr Field.
Event value
UpdateOdbcCdrField
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| odbc_cdr_field | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - chan_var_name | String |
Errors
SwitchOdbcCdrField
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOdbcCdrField",
"data": {
"id": 4,
"position": 3,
"enabled": false,
"name": "new_field2",
"chan_var_name": "New_chan_var_name2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
}
}
Switch Odbc Cdr Field.
Event value
SwitchOdbcCdrField
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| odbc_cdr_field | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
DeleteOdbcCdrField
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DeleteOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4}}}'
exampleSocket.send('{"event":"DeleteOdbcCdrField","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","odbc_cdr_field":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DeleteOdbcCdrField",
"data": {
"id": 4,
"position": 3,
"enabled": false,
"name": "new_field2",
"chan_var_name": "New_chan_var_name2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"log_leg": "",
"description": "",
"parent": null
}
}
}
Delete Odbc Cdr Field.
Event value
DeleteOdbcCdrField
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| odbc_cdr_field | Object | |
| - id | Integer | Item ID. |
Errors
Verto
[Config][Verto][Get]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Get]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"[Config][Verto][Get]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Get]",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "debug",
"value": "0",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default-v4",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "default-v6",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
[ Config][ Verto][ Get].
Event value
[Config][Verto][Get]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
[Config][Verto][Profile][Parameters][Get]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Parameters][Get]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Parameters][Get]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Parameters][Get]",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "bind-local",
"value": "domain.com:8081",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"10": {
"id": 10,
"position": 9,
"enabled": true,
"name": "rtp-ip",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"11": {
"id": 11,
"position": 10,
"enabled": true,
"name": "ext-rtp-ip",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"12": {
"id": 12,
"position": 11,
"enabled": true,
"name": "local-network",
"value": "localnet.auto",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"13": {
"id": 13,
"position": 12,
"enabled": true,
"name": "outbound-codec-string",
"value": "opus,h264,vp8",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"14": {
"id": 14,
"position": 13,
"enabled": true,
"name": "inbound-codec-string",
"value": "opus,h264,vp8",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"15": {
"id": 15,
"position": 14,
"enabled": true,
"name": "apply-candidate-acl",
"value": "localnet.auto",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"19": {
"id": 19,
"position": 15,
"enabled": true,
"name": "timer-name",
"value": "soft",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 2,
"enabled": true,
"name": "force-register-domain",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 7,
"enabled": true,
"name": "secure-combined",
"value": "/etc/freeswitch/tls/wss.pem",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 3,
"enabled": true,
"name": "secure-chain",
"value": "/etc/freeswitch/tls/wss.pem",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 4,
"enabled": true,
"name": "userauth",
"value": "true",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 5,
"enabled": true,
"name": "blind-reg",
"value": "false",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"8": {
"id": 8,
"position": 6,
"enabled": true,
"name": "mcast-ip",
"value": "224.1.1.1",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"9": {
"id": 9,
"position": 8,
"enabled": true,
"name": "mcast-port",
"value": "1337",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
[ Config][ Verto][ Profile][ Parameters][ Get].
Event value
[Config][Verto][Profile][Parameters][Get]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
[Config][Verto][Settings][Update]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Settings][Update]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"debug","value":"1"}}}'
exampleSocket.send('{"event":"[Config][Verto][Settings][Update]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"debug","value":"1"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Settings][Update]",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "debug",
"value": "1",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Settings][ Update].
Event value
[Config][Verto][Settings][Update]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
[Config][Verto][Setting][Switch]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Setting][Switch]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"[Config][Verto][Setting][Switch]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Setting][Switch]",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "debug",
"value": "1",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Setting][ Switch].
Event value
[Config][Verto][Setting][Switch]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
[Config][Verto][Setting][Add]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Setting][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"param","value":"0"}}}'
exampleSocket.send('{"event":"[Config][Verto][Setting][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"param","value":"0"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Setting][Add]",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "param",
"value": "0",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Setting][ Add].
Event value
[Config][Verto][Setting][Add]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
[Config][Verto][Setting][Del]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Setting][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"[Config][Verto][Setting][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Setting][Del]",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "param",
"value": "0",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Setting][ Del].
Event value
[Config][Verto][Setting][Del]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config][Verto][Profile][Param][Add]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Param][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Param][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Param][Add]",
"data": {
"id": 39,
"position": 16,
"enabled": true,
"name": "paramn",
"value": "paramv",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Param][ Add].
Event value
[Config][Verto][Profile][Param][Add]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
MoveVertoProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"MoveVertoProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":16,"current_index":14,"id":39}}'
exampleSocket.send('{"event":"MoveVertoProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":16,"current_index":14,"id":39}}');
Returns JSON structured like this:
{
"MessageType": "MoveVertoProfileParameter",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "bind-local",
"value": "domain.com:8081",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"10": {
"id": 10,
"position": 9,
"enabled": true,
"name": "rtp-ip",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"11": {
"id": 11,
"position": 10,
"enabled": true,
"name": "ext-rtp-ip",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"12": {
"id": 12,
"position": 11,
"enabled": true,
"name": "local-network",
"value": "localnet.auto",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"13": {
"id": 13,
"position": 12,
"enabled": true,
"name": "outbound-codec-string",
"value": "opus,h264,vp8",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"14": {
"id": 14,
"position": 13,
"enabled": true,
"name": "inbound-codec-string",
"value": "opus,h264,vp8",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"15": {
"id": 15,
"position": 15,
"enabled": true,
"name": "apply-candidate-acl",
"value": "localnet.auto",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"19": {
"id": 19,
"position": 16,
"enabled": true,
"name": "timer-name",
"value": "soft",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 2,
"enabled": true,
"name": "force-register-domain",
"value": "domain.com",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"39": {
"id": 39,
"position": 14,
"enabled": true,
"name": "paramn",
"value": "paramv",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 7,
"enabled": true,
"name": "secure-combined",
"value": "/etc/freeswitch/tls/wss.pem",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 3,
"enabled": true,
"name": "secure-chain",
"value": "/etc/freeswitch/tls/wss.pem",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 4,
"enabled": true,
"name": "userauth",
"value": "true",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 5,
"enabled": true,
"name": "blind-reg",
"value": "false",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"8": {
"id": 8,
"position": 6,
"enabled": true,
"name": "mcast-ip",
"value": "224.1.1.1",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"9": {
"id": 9,
"position": 8,
"enabled": true,
"name": "mcast-port",
"value": "1337",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Move Verto Profile Parameter.
Event value
MoveVertoProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| previous_index | Integer | |
| current_index | Integer | |
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
[Config][Verto][Profile][Param][Del]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Param][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":39}}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Param][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":39}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Param][Del]",
"data": {
"id": 39,
"position": 14,
"enabled": true,
"name": "paramn",
"value": "paramv",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Param][ Del].
Event value
[Config][Verto][Profile][Param][Del]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
[Config][Verto][Profile][Param][Switch]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Param][Switch]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19,"enabled":false}}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Param][Switch]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Param][Switch]",
"data": {
"id": 19,
"position": 16,
"enabled": false,
"name": "timer-name",
"value": "soft",
"secure": "",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Param][ Switch].
Event value
[Config][Verto][Profile][Param][Switch]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
[Config][Verto][Profile][Update]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Update]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19,"name":"timer-name","value":"hard","secure":""}}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Update]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19,"name":"timer-name","value":"hard","secure":""}}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Update]",
"data": {
"id": 19,
"position": 19,
"enabled": true,
"name": "timer-name",
"value": "hard",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null,
"started": false,
"state": "",
"uri": ""
}
}
}
[ Config][ Verto][ Profile][ Update].
Event value
[Config][Verto][Profile][Update]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
| - secure | String |
Errors
[Config][Verto][Profile][Add]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Add]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Add]",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Add].
Event value
[Config][Verto][Profile][Add]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
[Config][Verto][Profile][Rename]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Rename]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"new_profile2"}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Rename]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Rename]",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Rename].
Event value
[Config][Verto][Profile][Rename]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
[Config][Verto][Profile][Del]
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Config][Verto][Profile][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}'
exampleSocket.send('{"event":"[Config][Verto][Profile][Del]","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}');
Returns JSON structured like this:
{
"MessageType": "[Config][Verto][Profile][Del]",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 46,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
[ Config][ Verto][ Profile][ Del].
Event value
[Config][Verto][Profile][Del]
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Callcenter
GetCallcenterQueues
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterQueues","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCallcenterQueues","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterQueues",
"data": {
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "ddaaaaw",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "ggdsf",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "a",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Callcenter Queues.
Event value
GetCallcenterQueues
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetCallcenterQueuesParams
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterQueuesParams","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"GetCallcenterQueuesParams","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterQueuesParams",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "ddd",
"value": "ddd",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Callcenter Queues Params.
Event value
GetCallcenterQueuesParams
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
GetCallcenterSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterSettings",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "qqq",
"value": "qqq",
"description": "qqq",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Callcenter Settings.
Event value
GetCallcenterSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateCallcenterSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"qqq2","value":"qqq2","description":"qqq"}}}'
exampleSocket.send('{"event":"UpdateCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"qqq2","value":"qqq2","description":"qqq"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCallcenterSettings",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "qqq2",
"value": "qqq2",
"description": "qqq",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Callcenter Settings.
Event value
UpdateCallcenterSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
| - description | String |
Errors
SwitchCallcenterSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCallcenterSettings",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "qqq2",
"value": "qqq2",
"description": "qqq",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Callcenter Settings.
Event value
SwitchCallcenterSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddCallcenterSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCallcenterSettings",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Callcenter Settings.
Event value
AddCallcenterSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCallcenterSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelCallcenterSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelCallcenterSettings",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Callcenter Settings.
Event value
DelCallcenterSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
AddCallcenterQueueParam
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCallcenterQueueParam",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Callcenter Queue Param.
Event value
AddCallcenterQueueParam
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCallcenterQueueParam
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelCallcenterQueueParam",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Callcenter Queue Param.
Event value
DelCallcenterQueueParam
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchCallcenterQueueParam
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCallcenterQueueParam",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "ddd",
"value": "ddd",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Callcenter Queue Param.
Event value
SwitchCallcenterQueueParam
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateCallcenterQueueParam
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"new_param","value":"new_value"}}}'
exampleSocket.send('{"event":"UpdateCallcenterQueueParam","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"new_param","value":"new_value"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCallcenterQueueParam",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "new_param",
"value": "new_value",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Callcenter Queue Param.
Event value
UpdateCallcenterQueueParam
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
AddCallcenterQueue
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_queue"}}'
exampleSocket.send('{"event":"AddCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_queue"}}');
Returns JSON structured like this:
{
"MessageType": "AddCallcenterQueue",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "new_queue",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Callcenter Queue.
Event value
AddCallcenterQueue
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
RenameCallcenterQueue
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"RenameCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_queue2"}}'
exampleSocket.send('{"event":"RenameCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_queue2"}}');
Returns JSON structured like this:
{
"MessageType": "RenameCallcenterQueue",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "new_queue2",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Rename Callcenter Queue.
Event value
RenameCallcenterQueue
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| token | String | User auth token. |
Errors
DelCallcenterQueue
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"DelCallcenterQueue","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "DelCallcenterQueue",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "new_queue2",
"description": "",
"parent": {
"id": 6,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Callcenter Queue.
Event value
DelCallcenterQueue
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
ImportCallcenterAgentsAndTiers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportCallcenterAgentsAndTiers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"ImportCallcenterAgentsAndTiers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "ImportCallcenterAgentsAndTiers",
"data": {
"callcenter_agents": {
"items": null,
"total": 0
},
"callcenter_tiers": {
"items": [
{
"id": 3,
"agent": "1007@domain.com",
"queue": "n",
"level": 4,
"position": 4,
"state": "Ready"
}
],
"total": 1
}
}
}
Import Callcenter Agents And Tiers.
Event value
ImportCallcenterAgentsAndTiers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetCallcenterAgents
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterAgents","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}'
exampleSocket.send('{"event":"GetCallcenterAgents","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterAgents",
"data": {
"items": [
{
"id": 34,
"name": "30",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 3,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
},
{
"id": 32,
"name": "28",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 7,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
},
{
"id": 6,
"name": "2",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 4,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
},
{
"id": 7,
"name": "1000@domain.com",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 0,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
}
],
"total": 30
}
}
Get Callcenter Agents.
Event value
GetCallcenterAgents
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| db_request | Object | |
| - limit | Integer | |
| - offset | Integer | |
| - filters | Array | |
| - order | Object | |
| - desc | Boolean | |
| - fields | Array |
Errors
AddCallcenterAgent
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCallcenterAgent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_agent"}}'
exampleSocket.send('{"event":"AddCallcenterAgent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_agent"}}');
Returns JSON structured like this:
{
"MessageType": "AddCallcenterAgent",
"data": {
"id": 35,
"name": "new_agent",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 0,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
}
}
Add Callcenter Agent.
Event value
AddCallcenterAgent
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateCallcenterAgent
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCallcenterAgent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":37,"name":"max_no_answer","value":"5"}}}'
exampleSocket.send('{"event":"UpdateCallcenterAgent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":37,"name":"max_no_answer","value":"5"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCallcenterAgent",
"data": {
"id": 37,
"name": "agent@domain",
"type": "callback",
"system": "single_box",
"instance_id": "single_box",
"uuid": "",
"contact": "",
"status": "On Break",
"state": "Waiting",
"max_no_answer": 5,
"wrap_up_time": 10,
"reject_delay_time": 0,
"busy_delay_time": 10,
"no_answer_delay_time": 10,
"last_bridge_start": 0,
"last_bridge_end": 0,
"last_offered_call": 0,
"last_status_change": 0,
"no_answer_count": 0,
"calls_answered": 0,
"talk_time": 0,
"ready_time": 10
}
}
Update Callcenter Agent.
Event value
UpdateCallcenterAgent
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
GetCallcenterTiers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterTiers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}'
exampleSocket.send('{"event":"GetCallcenterTiers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterTiers",
"data": {
"items": [
{
"id": 4,
"agent": "agent",
"queue": "ddaaaaw",
"level": 1,
"position": 1,
"state": "Ready"
}
],
"total": 1
}
}
Get Callcenter Tiers.
Event value
GetCallcenterTiers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| db_request | Object | |
| - limit | Integer | |
| - offset | Integer | |
| - filters | Array | |
| - order | Object | |
| - fields | Array | |
| - desc | Boolean |
Errors
AddCallcenterTier
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"name":"new_agent"}}'
exampleSocket.send('{"event":"AddCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"name":"new_agent"}}');
Returns JSON structured like this:
{
"MessageType": "AddCallcenterTier",
"data": {
"id": 5,
"agent": "new_agent",
"queue": "ddaaaaw",
"level": 1,
"position": 1,
"state": "Ready"
}
}
Add Callcenter Tier.
Event value
AddCallcenterTier
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
UpdateCallcenterTier
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"level","value":"2"}}}'
exampleSocket.send('{"event":"UpdateCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"level","value":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCallcenterTier",
"data": {
"id": 5,
"agent": "new_agent",
"queue": "ddaaaaw",
"level": 2,
"position": 7,
"state": "Ready"
}
}
Update Callcenter Tier.
Event value
UpdateCallcenterTier
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCallcenterTier
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"DelCallcenterTier","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "DelCallcenterTier",
"data": {
"id": 5,
"agent": "new_agent",
"queue": "ddaaaaw",
"level": 2,
"position": 7,
"state": "Ready"
}
}
Del Callcenter Tier.
Event value
DelCallcenterTier
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
GetCallcenterMembers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCallcenterMembers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}'
exampleSocket.send('{"event":"GetCallcenterMembers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","db_request":{"limit":25,"offset":0,"filters":[],"order":{"fields":[],"desc":false}}}}');
Returns JSON structured like this:
{
"MessageType": "GetCallcenterMembers",
"data": {
"items": null,
"total": 0
}
}
Get Callcenter Members.
Event value
GetCallcenterMembers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| db_request | Object | |
| - limit | Integer | |
| - offset | Integer | |
| - filters | Array | |
| - order | Object | |
| - fields | Array | |
| - desc | Boolean |
Errors
DelCallcenterMember
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCallcenterMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"DelCallcenterMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "DelCallcenterMember",
"data": {
"id": 5
}
}
Del Callcenter Member.
Event value
DelCallcenterMember
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
SendCallcenterCommand
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SendCallcenterCommand","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"load","id":2}}'
exampleSocket.send('{"event":"SendCallcenterCommand","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"load","id":2}}');
Returns JSON structured like this:
{
"MessageType": "SendCallcenterCommand"
}
Send Callcenter Command.
Event value
SendCallcenterCommand
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
LCR
GetLcr
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetLcr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetLcr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetLcr",
"data": {
"settings": {},
"profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "qual_rel",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "rel_qual",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Lcr.
Event value
GetLcr
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
GetLcrProfileParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetLcrProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetLcrProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetLcrProfileParameters",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "id",
"value": "0",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "order_by",
"value": "rate,quality,reliability",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Lcr Profile Parameters.
Event value
GetLcrProfileParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
UpdateLcrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateLcrParameter",
"data": {
"id": 7,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Lcr Parameter.
Event value
UpdateLcrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchLcrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchLcrParameter",
"data": {
"id": 7,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Lcr Parameter.
Event value
SwitchLcrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddLcrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddLcrParameter",
"data": {
"id": 7,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Lcr Parameter.
Event value
AddLcrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelLcrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}'
exampleSocket.send('{"event":"DelLcrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}');
Returns JSON structured like this:
{
"MessageType": "DelLcrParameter",
"data": {
"id": 7,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Lcr Parameter.
Event value
DelLcrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
AddLcrProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddLcrProfileParameter",
"data": {
"id": 16,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Lcr Profile Parameter.
Event value
AddLcrProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelLcrProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16}}}'
exampleSocket.send('{"event":"DelLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16}}}');
Returns JSON structured like this:
{
"MessageType": "DelLcrProfileParameter",
"data": {
"id": 16,
"position": 3,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Lcr Profile Parameter.
Event value
DelLcrProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchLcrProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchLcrProfileParameter",
"data": {
"id": 16,
"position": 3,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Lcr Profile Parameter.
Event value
SwitchLcrProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateLcrProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateLcrProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateLcrProfileParameter",
"data": {
"id": 16,
"position": 3,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Lcr Profile Parameter.
Event value
UpdateLcrProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
AddLcrProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"AddLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "AddLcrProfile",
"data": {
"id": 10,
"position": 4,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Lcr Profile.
Event value
AddLcrProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateLcrProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"name":"new_profile2"}}'
exampleSocket.send('{"event":"UpdateLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateLcrProfile",
"data": {
"id": 10,
"position": 4,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Lcr Profile.
Event value
UpdateLcrProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelLcrProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"DelLcrProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "DelLcrProfile",
"data": {
"id": 10,
"position": 4,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 24,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Lcr Profile.
Event value
DelLcrProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Shout
GetShout
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetShout","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetShout","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetShout",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 40,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Shout.
Event value
GetShout
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateShoutParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateShoutParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 40,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Shout Parameter.
Event value
UpdateShoutParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchShoutParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchShoutParameter",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 40,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Shout Parameter.
Event value
SwitchShoutParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddShoutParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddShoutParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 40,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Shout Parameter.
Event value
AddShoutParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelShoutParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelShoutParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelShoutParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 40,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Shout Parameter.
Event value
DelShoutParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Redis
GetRedis
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetRedis","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetRedis","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetRedis",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "host",
"value": "localhost",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "port",
"value": "6379",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "timeout",
"value": "10000",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Redis.
Event value
GetRedis
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateRedisParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"timeout","value":"100000"}}}'
exampleSocket.send('{"event":"UpdateRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"timeout","value":"100000"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateRedisParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "timeout",
"value": "100000",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Redis Parameter.
Event value
UpdateRedisParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchRedisParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchRedisParameter",
"data": {
"id": 3,
"position": 3,
"enabled": false,
"name": "timeout",
"value": "100000",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Redis Parameter.
Event value
SwitchRedisParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddRedisParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddRedisParameter",
"data": {
"id": 5,
"position": 4,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Redis Parameter.
Event value
AddRedisParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelRedisParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelRedisParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelRedisParameter",
"data": {
"id": 5,
"position": 4,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Redis Parameter.
Event value
DelRedisParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Nibblebill
GetNibblebill
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetNibblebill","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetNibblebill","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetNibblebill",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "odbc-dsn",
"value": "bandwidth.com",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "percall_max_amt",
"value": "100",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "percall_action",
"value": "hangup",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "db_table",
"value": "accounts",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "db_column_cash",
"value": "cash",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "db_column_account",
"value": "id",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "global_heartbeat",
"value": "60",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "lowbal_amt",
"value": "5",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "lowbal_action",
"value": "play ding",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "nobal_amt",
"value": "0",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "nobal_action",
"value": "hangup",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Nibblebill.
Event value
GetNibblebill
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateNibblebillParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10,"name":"percall_max_amt","value":"1000"}}}'
exampleSocket.send('{"event":"UpdateNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10,"name":"percall_max_amt","value":"1000"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateNibblebillParameter",
"data": {
"id": 10,
"position": 10,
"enabled": true,
"name": "percall_max_amt",
"value": "1000",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Nibblebill Parameter.
Event value
UpdateNibblebillParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchNibblebillParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchNibblebillParameter",
"data": {
"id": 11,
"position": 11,
"enabled": false,
"name": "percall_action",
"value": "hangup",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Nibblebill Parameter.
Event value
SwitchNibblebillParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddNibblebillParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddNibblebillParameter",
"data": {
"id": 14,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Nibblebill Parameter.
Event value
AddNibblebillParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelNibblebillParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}'
exampleSocket.send('{"event":"DelNibblebillParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}');
Returns JSON structured like this:
{
"MessageType": "DelNibblebillParameter",
"data": {
"id": 14,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 29,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Nibblebill Parameter.
Event value
DelNibblebillParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
DB
GetDb
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDb",
"data": {
"3": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 14,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Db.
Event value
GetDb
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateDbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDbParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 14,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Db Parameter.
Event value
UpdateDbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchDbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDbParameter",
"data": {
"id": 3,
"position": 1,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 14,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Db Parameter.
Event value
SwitchDbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddDbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddDbParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 14,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Db Parameter.
Event value
AddDbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelDbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}'
exampleSocket.send('{"event":"DelDbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}');
Returns JSON structured like this:
{
"MessageType": "DelDbParameter",
"data": {
"id": 3,
"position": 1,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 14,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Db Parameter.
Event value
DelDbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Memcache
GetMemcache
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetMemcache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetMemcache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetMemcache",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "memcache-servers",
"value": "localhost",
"description": "",
"parent": {
"id": 26,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Memcache.
Event value
GetMemcache
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateMemcacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"memcache-servers","value":"localhost"}}}'
exampleSocket.send('{"event":"UpdateMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"memcache-servers","value":"localhost"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateMemcacheParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "memcache-servers",
"value": "localhost",
"description": "",
"parent": {
"id": 26,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Memcache Parameter.
Event value
UpdateMemcacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
SwitchMemcacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchMemcacheParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "memcache-servers",
"value": "localhost",
"description": "",
"parent": {
"id": 26,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Memcache Parameter.
Event value
SwitchMemcacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddMemcacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddMemcacheParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 26,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Memcache Parameter.
Event value
AddMemcacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelMemcacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelMemcacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelMemcacheParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 26,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Memcache Parameter.
Event value
DelMemcacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Avmd
GetAvmd
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetAvmd","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetAvmd","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetAvmd",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "debug",
"value": "0",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "inbound_channel",
"value": "0",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "outbound_channel",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"12": {
"id": 12,
"position": 12,
"enabled": true,
"name": "detection_mode",
"value": "2",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"13": {
"id": 13,
"position": 13,
"enabled": true,
"name": "detectors_n",
"value": "36",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"14": {
"id": 14,
"position": 14,
"enabled": true,
"name": "detectors_lagged_n",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "report_status",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "fast_math",
"value": "0",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "require_continuous_streak",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "sample_n_continuous_streak",
"value": "3",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "sample_n_to_skip",
"value": "0",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "require_continuous_streak_amp",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "sample_n_continuous_streak_amp",
"value": "3",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "simplified_estimation",
"value": "1",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Avmd.
Event value
GetAvmd
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateAvmdParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"name":"detectors_lagged_n","value":"2"}}}'
exampleSocket.send('{"event":"UpdateAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"name":"detectors_lagged_n","value":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateAvmdParameter",
"data": {
"id": 14,
"position": 14,
"enabled": true,
"name": "detectors_lagged_n",
"value": "2",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Avmd Parameter.
Event value
UpdateAvmdParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchAvmdParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchAvmdParameter",
"data": {
"id": 14,
"position": 14,
"enabled": false,
"name": "detectors_lagged_n",
"value": "2",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Avmd Parameter.
Event value
SwitchAvmdParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddAvmdParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddAvmdParameter",
"data": {
"id": 17,
"position": 15,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Avmd Parameter.
Event value
AddAvmdParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelAvmdParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":17}}}'
exampleSocket.send('{"event":"DelAvmdParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":17}}}');
Returns JSON structured like this:
{
"MessageType": "DelAvmdParameter",
"data": {
"id": 17,
"position": 15,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 5,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Avmd Parameter.
Event value
DelAvmdParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Tts Commandline
GetTtsCommandline
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetTtsCommandline","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetTtsCommandline","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetTtsCommandline",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "command",
"value": "echo ${text} | text2wave -f ${rate} \u003e ${file}",
"description": "",
"parent": {
"id": 44,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Tts Commandline.
Event value
GetTtsCommandline
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateTtsCommandlineParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"command","value":"echo ${text} | text2wave -f ${rate} > ${file}"}}}'
exampleSocket.send('{"event":"UpdateTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"command","value":"echo ${text} | text2wave -f ${rate} > ${file}"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateTtsCommandlineParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "command",
"value": "echo ${text} | text2wave -f ${rate} \u003e ${file}",
"description": "",
"parent": {
"id": 44,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Tts Commandline Parameter.
Event value
UpdateTtsCommandlineParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchTtsCommandlineParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchTtsCommandlineParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "command",
"value": "echo ${text} | text2wave -f ${rate} \u003e ${file}",
"description": "",
"parent": {
"id": 44,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Tts Commandline Parameter.
Event value
SwitchTtsCommandlineParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddTtsCommandlineParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddTtsCommandlineParameter",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 44,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Tts Commandline Parameter.
Event value
AddTtsCommandlineParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelTtsCommandlineParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelTtsCommandlineParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelTtsCommandlineParameter",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 44,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Tts Commandline Parameter.
Event value
DelTtsCommandlineParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
CDR Mongodb
GetCdrMongodb
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCdrMongodb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCdrMongodb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCdrMongodb",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "host",
"value": "127.0.0.1",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "port",
"value": "27017",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "namespace",
"value": "test.cdr",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "log-b-leg",
"value": "false",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Cdr Mongodb.
Event value
GetCdrMongodb
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateCdrMongodbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"log-b-leg","value":"true"}}}'
exampleSocket.send('{"event":"UpdateCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"log-b-leg","value":"true"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCdrMongodbParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "log-b-leg",
"value": "true",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Cdr Mongodb Parameter.
Event value
UpdateCdrMongodbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchCdrMongodbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCdrMongodbParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "log-b-leg",
"value": "true",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Cdr Mongodb Parameter.
Event value
SwitchCdrMongodbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddCdrMongodbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCdrMongodbParameter",
"data": {
"id": 7,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Cdr Mongodb Parameter.
Event value
AddCdrMongodbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCdrMongodbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}'
exampleSocket.send('{"event":"DelCdrMongodbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}');
Returns JSON structured like this:
{
"MessageType": "DelCdrMongodbParameter",
"data": {
"id": 7,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 7,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Cdr Mongodb Parameter.
Event value
DelCdrMongodbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
HTTP Cache
GetHttpCache
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetHttpCache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetHttpCache","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetHttpCache",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "enable-file-formats",
"value": "false",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "max-urls",
"value": "10000",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "location",
"value": "/var/cache/freeswitch",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "default-max-age",
"value": "86400",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "prefetch-thread-count",
"value": "8",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "prefetch-queue-size",
"value": "100",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "ssl-cacert",
"value": "/etc/freeswitch/tls/cacert.pem",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "ssl-verifypeer",
"value": "true",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "ssl-verifyhost",
"value": "true",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Http Cache.
Event value
GetHttpCache
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateHttpCacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9,"name":"ssl-verifyhost","value":"false"}}}'
exampleSocket.send('{"event":"UpdateHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9,"name":"ssl-verifyhost","value":"false"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateHttpCacheParameter",
"data": {
"id": 9,
"position": 9,
"enabled": true,
"name": "ssl-verifyhost",
"value": "false",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Http Cache Parameter.
Event value
UpdateHttpCacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchHttpCacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchHttpCacheParameter",
"data": {
"id": 9,
"position": 9,
"enabled": false,
"name": "ssl-verifyhost",
"value": "false",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Http Cache Parameter.
Event value
SwitchHttpCacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddHttpCacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddHttpCacheParameter",
"data": {
"id": 12,
"position": 10,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Http Cache Parameter.
Event value
AddHttpCacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelHttpCacheParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}'
exampleSocket.send('{"event":"DelHttpCacheParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}');
Returns JSON structured like this:
{
"MessageType": "DelHttpCacheParameter",
"data": {
"id": 12,
"position": 10,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 23,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Http Cache Parameter.
Event value
DelHttpCacheParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Opus
GetOpus
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOpus","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetOpus","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetOpus",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "use-vbr",
"value": "1",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "complexity",
"value": "10",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "keep-fec-enabled",
"value": "1",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "maxaveragebitrate",
"value": "0",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "maxplaybackrate",
"value": "0",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Opus.
Event value
GetOpus
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateOpusParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"maxplaybackrate","value":"512"}}}'
exampleSocket.send('{"event":"UpdateOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"maxplaybackrate","value":"512"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOpusParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "maxplaybackrate",
"value": "512",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Opus Parameter.
Event value
UpdateOpusParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
SwitchOpusParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOpusParameter",
"data": {
"id": 5,
"position": 5,
"enabled": false,
"name": "maxplaybackrate",
"value": "512",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Opus Parameter.
Event value
SwitchOpusParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddOpusParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOpusParameter",
"data": {
"id": 8,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Opus Parameter.
Event value
AddOpusParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelOpusParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8}}}'
exampleSocket.send('{"event":"DelOpusParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8}}}');
Returns JSON structured like this:
{
"MessageType": "DelOpusParameter",
"data": {
"id": 8,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 31,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Opus Parameter.
Event value
DelOpusParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Python
GetPython
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetPython","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetPython","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetPython",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 37,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Python.
Event value
GetPython
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdatePythonParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdatePythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePythonParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 37,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Python Parameter.
Event value
UpdatePythonParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
SwitchPythonParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPythonParameter",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 37,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Python Parameter.
Event value
SwitchPythonParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddPythonParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPythonParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 37,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Python Parameter.
Event value
AddPythonParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelPythonParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelPythonParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelPythonParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 37,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Python Parameter.
Event value
DelPythonParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
ALsa
GetAlsa
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetAlsa","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetAlsa","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetAlsa",
"data": {
"16": {
"id": 16,
"position": 1,
"enabled": true,
"name": "dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"17": {
"id": 17,
"position": 2,
"enabled": true,
"name": "cid-name",
"value": "N800 Alsa",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"18": {
"id": 18,
"position": 3,
"enabled": true,
"name": "cid-num",
"value": "5555551212",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"19": {
"id": 19,
"position": 4,
"enabled": true,
"name": "sample-rate",
"value": "8000",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"20": {
"id": 20,
"position": 5,
"enabled": true,
"name": "codec-ms",
"value": "20",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Alsa.
Event value
GetAlsa
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateAlsaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":17,"name":"cid-name","value":"N800 Alsa2"}}}'
exampleSocket.send('{"event":"UpdateAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":17,"name":"cid-name","value":"N800 Alsa2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateAlsaParameter",
"data": {
"id": 17,
"position": 2,
"enabled": true,
"name": "cid-name",
"value": "N800 Alsa2",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Alsa Parameter.
Event value
UpdateAlsaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchAlsaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":18,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":18,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchAlsaParameter",
"data": {
"id": 18,
"position": 3,
"enabled": false,
"name": "cid-num",
"value": "5555551212",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Alsa Parameter.
Event value
SwitchAlsaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddAlsaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddAlsaParameter",
"data": {
"id": 21,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Alsa Parameter.
Event value
AddAlsaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelAlsaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21}}}'
exampleSocket.send('{"event":"DelAlsaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":21}}}');
Returns JSON structured like this:
{
"MessageType": "DelAlsaParameter",
"data": {
"id": 21,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 55,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Alsa Parameter.
Event value
DelAlsaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Amr
GetAmr
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetAmr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetAmr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetAmr",
"data": {
"10": {
"id": 10,
"position": 3,
"enabled": true,
"name": "adjust-bitrate",
"value": "0",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 4,
"enabled": true,
"name": "force-oa",
"value": "0",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 1,
"enabled": true,
"name": "default-bitrate",
"value": "7",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 2,
"enabled": true,
"name": "volte",
"value": "0",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Amr.
Event value
GetAmr
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateAmrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"name":"force-oa","value":"1"}}}'
exampleSocket.send('{"event":"UpdateAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"name":"force-oa","value":"1"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateAmrParameter",
"data": {
"id": 11,
"position": 4,
"enabled": true,
"name": "force-oa",
"value": "1",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Amr Parameter.
Event value
UpdateAmrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchAmrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchAmrParameter",
"data": {
"id": 11,
"position": 4,
"enabled": false,
"name": "force-oa",
"value": "1",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Amr Parameter.
Event value
SwitchAmrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddAmrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddAmrParameter",
"data": {
"id": 12,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Amr Parameter.
Event value
AddAmrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelAmrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}'
exampleSocket.send('{"event":"DelAmrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}');
Returns JSON structured like this:
{
"MessageType": "DelAmrParameter",
"data": {
"id": 12,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 52,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Amr Parameter.
Event value
DelAmrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Amrwb
GetAmrwb
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetAmrwb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetAmrwb","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetAmrwb",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default-bitrate",
"value": "8",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "volte",
"value": "1",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "adjust-bitrate",
"value": "0",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "force-oa",
"value": "0",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Amrwb.
Event value
GetAmrwb
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateAmrwbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"force-oa","value":"1"}}}'
exampleSocket.send('{"event":"UpdateAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"force-oa","value":"1"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateAmrwbParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "force-oa",
"value": "1",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Amrwb Parameter.
Event value
UpdateAmrwbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchAmrwbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchAmrwbParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "force-oa",
"value": "1",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Amrwb Parameter.
Event value
SwitchAmrwbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddAmrwbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddAmrwbParameter",
"data": {
"id": 10,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Amrwb Parameter.
Event value
AddAmrwbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelAmrwbParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}'
exampleSocket.send('{"event":"DelAmrwbParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}');
Returns JSON structured like this:
{
"MessageType": "DelAmrwbParameter",
"data": {
"id": 10,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 4,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Amrwb Parameter.
Event value
DelAmrwbParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Cepstral
GetCepstral
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCepstral","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCepstral","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCepstral",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "encoding",
"value": "utf-8",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Cepstral.
Event value
GetCepstral
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateCepstralParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"encoding","value":"utf-8"}}}'
exampleSocket.send('{"event":"UpdateCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"encoding","value":"utf-8"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCepstralParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "encoding",
"value": "utf-8",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Cepstral Parameter.
Event value
UpdateCepstralParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchCepstralParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCepstralParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "encoding",
"value": "utf-8",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Cepstral Parameter.
Event value
SwitchCepstralParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddCepstralParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCepstralParameter",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Cepstral Parameter.
Event value
AddCepstralParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCepstralParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelCepstralParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelCepstralParameter",
"data": {
"id": 5,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 9,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Cepstral Parameter.
Event value
DelCepstralParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Cidlookup
GetCidlookup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCidlookup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCidlookup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCidlookup",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "url",
"value": "http://query.voipcnam.com/query.php?api_key=MYAPIKEY\u0026number=${caller_id_number}",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "whitepages-apikey",
"value": "MYAPIKEY",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "cache",
"value": "true",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "cache-expire",
"value": "86400",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "odbc-dsn",
"value": "phone:phone:phone",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "sql",
"value": " SELECT name||' ('||type||')' AS name FROM phonebook p JOIN numbers n ON p.id = n.phonebook_id WHERE n.number='${caller_id_number}' LIMIT 1 ",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "citystate-sql",
"value": " SELECT ratecenter||' '||state as name FROM npa_nxx_company_ocn WHERE npa = ${caller_id_number:1:3} AND nxx = ${caller_id_number:4:3} LIMIT 1 ",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Cidlookup.
Event value
GetCidlookup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateCidlookupParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"cache-expire","value":"86421"}}}'
exampleSocket.send('{"event":"UpdateCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"cache-expire","value":"86421"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCidlookupParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "cache-expire",
"value": "86421",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Cidlookup Parameter.
Event value
UpdateCidlookupParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchCidlookupParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCidlookupParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "cache-expire",
"value": "86421",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Cidlookup Parameter.
Event value
SwitchCidlookupParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddCidlookupParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCidlookupParameter",
"data": {
"id": 12,
"position": 8,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Cidlookup Parameter.
Event value
AddCidlookupParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCidlookupParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}'
exampleSocket.send('{"event":"DelCidlookupParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12}}}');
Returns JSON structured like this:
{
"MessageType": "DelCidlookupParameter",
"data": {
"id": 12,
"position": 8,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Cidlookup Parameter.
Event value
DelCidlookupParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Curl
GetCurl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetCurl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetCurl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetCurl",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "max-bytes",
"value": "64000",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Curl.
Event value
GetCurl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateCurlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"max-bytes","value":"64001"}}}'
exampleSocket.send('{"event":"UpdateCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"max-bytes","value":"64001"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateCurlParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "max-bytes",
"value": "64001",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Curl Parameter.
Event value
UpdateCurlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchCurlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchCurlParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "max-bytes",
"value": "64001",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Curl Parameter.
Event value
SwitchCurlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddCurlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddCurlParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Curl Parameter.
Event value
AddCurlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelCurlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelCurlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelCurlParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 13,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Curl Parameter.
Event value
DelCurlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
DDialplan Directory
GetDialplanDirectory
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDialplanDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDialplanDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDialplanDirectory",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "directory-name",
"value": "ldap",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "host",
"value": "ldap.freeswitch.org",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "dn",
"value": "cn=Manager,dc=freeswitch,dc=org",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "pass",
"value": "test",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "base",
"value": "dc=freeswitch,dc=org",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Dialplan Directory.
Event value
GetDialplanDirectory
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateDialplanDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"pass","value":"test2"}}}'
exampleSocket.send('{"event":"UpdateDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"pass","value":"test2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDialplanDirectoryParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "pass",
"value": "test2",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Dialplan Directory Parameter.
Event value
UpdateDialplanDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchDialplanDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDialplanDirectoryParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "pass",
"value": "test2",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Dialplan Directory Parameter.
Event value
SwitchDialplanDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddDialplanDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddDialplanDirectoryParameter",
"data": {
"id": 8,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Dialplan Directory Parameter.
Event value
AddDialplanDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelDialplanDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8}}}'
exampleSocket.send('{"event":"DelDialplanDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8}}}');
Returns JSON structured like this:
{
"MessageType": "DelDialplanDirectoryParameter",
"data": {
"id": 8,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Dialplan Directory Parameter.
Event value
DelDialplanDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Easyroute
GetEasyroute
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetEasyroute","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetEasyroute","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetEasyroute",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "db-username",
"value": "root",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "db-password",
"value": "password",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "db-dsn",
"value": "easyroute",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "default-techprofile",
"value": "sofia/default",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "default-gateway",
"value": "192.168.66.6",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "odbc-retries",
"value": "120",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Easyroute.
Event value
GetEasyroute
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateEasyrouteParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"name":"odbc-retries","value":"125"}}}'
exampleSocket.send('{"event":"UpdateEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"name":"odbc-retries","value":"125"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateEasyrouteParameter",
"data": {
"id": 6,
"position": 6,
"enabled": true,
"name": "odbc-retries",
"value": "125",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Easyroute Parameter.
Event value
UpdateEasyrouteParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchEasyrouteParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchEasyrouteParameter",
"data": {
"id": 6,
"position": 6,
"enabled": false,
"name": "odbc-retries",
"value": "125",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Easyroute Parameter.
Event value
SwitchEasyrouteParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddEasyrouteParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddEasyrouteParameter",
"data": {
"id": 9,
"position": 7,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Easyroute Parameter.
Event value
AddEasyrouteParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelEasyrouteParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9}}}'
exampleSocket.send('{"event":"DelEasyrouteParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9}}}');
Returns JSON structured like this:
{
"MessageType": "DelEasyrouteParameter",
"data": {
"id": 9,
"position": 7,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 18,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Easyroute Parameter.
Event value
DelEasyrouteParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Erlang Event
GetErlangEvent
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetErlangEvent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetErlangEvent","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetErlangEvent",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "listen-ip",
"value": "0.0.0.0",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "listen-port",
"value": "8031",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "nodename",
"value": "freeswitch",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "cookie",
"value": "ClueCon",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "shortname",
"value": "true",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Erlang Event.
Event value
GetErlangEvent
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateErlangEventParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"shortname","value":"false"}}}'
exampleSocket.send('{"event":"UpdateErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"shortname","value":"false"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateErlangEventParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "shortname",
"value": "false",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Erlang Event Parameter.
Event value
UpdateErlangEventParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchErlangEventParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchErlangEventParameter",
"data": {
"id": 5,
"position": 5,
"enabled": false,
"name": "shortname",
"value": "false",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Erlang Event Parameter.
Event value
SwitchErlangEventParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddErlangEventParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddErlangEventParameter",
"data": {
"id": 10,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Erlang Event Parameter.
Event value
AddErlangEventParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelErlangEventParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}'
exampleSocket.send('{"event":"DelErlangEventParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}');
Returns JSON structured like this:
{
"MessageType": "DelErlangEventParameter",
"data": {
"id": 10,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 19,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Erlang Event Parameter.
Event value
DelErlangEventParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Event Multicast
GetEventMulticast
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetEventMulticast","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetEventMulticast","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetEventMulticast",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "address",
"value": "225.1.1.1",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "port",
"value": "4242",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "bindings",
"value": "all",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "ttl",
"value": "1",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Event Multicast.
Event value
GetEventMulticast
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateEventMulticastParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"ttl","value":"2"}}}'
exampleSocket.send('{"event":"UpdateEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"ttl","value":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateEventMulticastParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "ttl",
"value": "2",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Event Multicast Parameter.
Event value
UpdateEventMulticastParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchEventMulticastParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchEventMulticastParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "ttl",
"value": "2",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Event Multicast Parameter.
Event value
SwitchEventMulticastParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddEventMulticastParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddEventMulticastParameter",
"data": {
"id": 7,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Event Multicast Parameter.
Event value
AddEventMulticastParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelEventMulticastParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}'
exampleSocket.send('{"event":"DelEventMulticastParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}');
Returns JSON structured like this:
{
"MessageType": "DelEventMulticastParameter",
"data": {
"id": 7,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 20,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Event Multicast Parameter.
Event value
DelEventMulticastParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Fax
GetFax
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetFax","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetFax","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetFax",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "use-ecm",
"value": "true",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "verbose",
"value": "false",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "disable-v17",
"value": "false",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "ident",
"value": "SpanDSP Fax Ident",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "header",
"value": "SpanDSP Fax Header",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "spool-dir",
"value": "/tmp",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "file-prefix",
"value": "faxrx",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Fax.
Event value
GetFax
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateFaxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"verbose","value":"true"}}}'
exampleSocket.send('{"event":"UpdateFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"verbose","value":"true"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateFaxParameter",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "verbose",
"value": "true",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Fax Parameter.
Event value
UpdateFaxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchFaxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchFaxParameter",
"data": {
"id": 3,
"position": 3,
"enabled": false,
"name": "disable-v17",
"value": "false",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Fax Parameter.
Event value
SwitchFaxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddFaxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddFaxParameter",
"data": {
"id": 10,
"position": 8,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Fax Parameter.
Event value
AddFaxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelFaxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}'
exampleSocket.send('{"event":"DelFaxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}');
Returns JSON structured like this:
{
"MessageType": "DelFaxParameter",
"data": {
"id": 10,
"position": 8,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 21,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Fax Parameter.
Event value
DelFaxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Lua
GetLua
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetLua","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetLua","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetLua",
"data": {
"3": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 25,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Lua.
Event value
GetLua
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateLuaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateLuaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 25,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Lua Parameter.
Event value
UpdateLuaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchLuaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchLuaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 25,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Lua Parameter.
Event value
SwitchLuaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddLuaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddLuaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 25,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Lua Parameter.
Event value
AddLuaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelLuaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}'
exampleSocket.send('{"event":"DelLuaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}');
Returns JSON structured like this:
{
"MessageType": "DelLuaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 25,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Lua Parameter.
Event value
DelLuaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Mongo
GetMongo
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetMongo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetMongo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetMongo",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "connection-string",
"value": "mongodb://127.0.0.1:27017/?connectTimeoutMS=10000",
"description": "",
"parent": {
"id": 27,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Mongo.
Event value
GetMongo
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateMongoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"connection-string","value":"mongodb://127.0.0.1:27017/?connectTimeoutMS=10001"}}}'
exampleSocket.send('{"event":"UpdateMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"connection-string","value":"mongodb://127.0.0.1:27017/?connectTimeoutMS=10001"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateMongoParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "connection-string",
"value": "mongodb://127.0.0.1:27017/?connectTimeoutMS=10001",
"description": "",
"parent": {
"id": 27,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Mongo Parameter.
Event value
UpdateMongoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchMongoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchMongoParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "connection-string",
"value": "mongodb://127.0.0.1:27017/?connectTimeoutMS=10001",
"description": "",
"parent": {
"id": 27,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Mongo Parameter.
Event value
SwitchMongoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddMongoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddMongoParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 27,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Mongo Parameter.
Event value
AddMongoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelMongoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelMongoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelMongoParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 27,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Mongo Parameter.
Event value
DelMongoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Msrp
GetMsrp
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetMsrp","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetMsrp","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetMsrp",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "listen-ip",
"value": "domain.com",
"description": "",
"parent": {
"id": 28,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Msrp.
Event value
GetMsrp
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateMsrpParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"listen-ip","value":"127.0.0.1"}}}'
exampleSocket.send('{"event":"UpdateMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"listen-ip","value":"127.0.0.1"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateMsrpParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "listen-ip",
"value": "127.0.0.1",
"description": "",
"parent": {
"id": 28,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Msrp Parameter.
Event value
UpdateMsrpParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
SwitchMsrpParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchMsrpParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "listen-ip",
"value": "127.0.0.1",
"description": "",
"parent": {
"id": 28,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Msrp Parameter.
Event value
SwitchMsrpParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddMsrpParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddMsrpParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 28,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Msrp Parameter.
Event value
AddMsrpParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - name | String | Item name |
Errors
DelMsrpParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelMsrpParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelMsrpParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 28,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Msrp Parameter.
Event value
DelMsrpParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Oreka
GetOreka
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOreka","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetOreka","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetOreka",
"data": {
"3": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 32,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Oreka.
Event value
GetOreka
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateOrekaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOrekaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 32,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Oreka Parameter.
Event value
UpdateOrekaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchOrekaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOrekaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 32,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Oreka Parameter.
Event value
SwitchOrekaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddOrekaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOrekaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 32,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Oreka Parameter.
Event value
AddOrekaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelOrekaParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}'
exampleSocket.send('{"event":"DelOrekaParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}');
Returns JSON structured like this:
{
"MessageType": "DelOrekaParameter",
"data": {
"id": 3,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 32,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Oreka Parameter.
Event value
DelOrekaParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Perl
GetPerl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetPerl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetPerl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetPerl",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 34,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Perl.
Event value
GetPerl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdatePerlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdatePerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePerlParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 34,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Perl Parameter.
Event value
UpdatePerlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchPerlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPerlParameter",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 34,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Perl Parameter.
Event value
SwitchPerlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddPerlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPerlParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 34,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Perl Parameter.
Event value
AddPerlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelPerlParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelPerlParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelPerlParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 34,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Perl Parameter.
Event value
DelPerlParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Pocketsphinx
GetPocketsphinx
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetPocketsphinx","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetPocketsphinx","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetPocketsphinx",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "threshold",
"value": "400",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "silence-hits",
"value": "25",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "listen-hits",
"value": "1",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "auto-reload",
"value": "true",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Pocketsphinx.
Event value
GetPocketsphinx
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdatePocketsphinxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"listen-hits","value":"2"}}}'
exampleSocket.send('{"event":"UpdatePocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"listen-hits","value":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePocketsphinxParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "listen-hits",
"value": "2",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Pocketsphinx Parameter.
Event value
UpdatePocketsphinxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchPocketsphinxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPocketsphinxParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "auto-reload",
"value": "true",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Pocketsphinx Parameter.
Event value
SwitchPocketsphinxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddPocketsphinxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPocketsphinxParameter",
"data": {
"id": 6,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Pocketsphinx Parameter.
Event value
AddPocketsphinxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelPocketsphinxParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6}}}'
exampleSocket.send('{"event":"DelPocketsphinxParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6}}}');
Returns JSON structured like this:
{
"MessageType": "DelPocketsphinxParameter",
"data": {
"id": 6,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 35,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Pocketsphinx Parameter.
Event value
DelPocketsphinxParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Sangoma Codec
GetSangomaCodec
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetSangomaCodec","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetSangomaCodec","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetSangomaCodec",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Sangoma Codec.
Event value
GetSangomaCodec
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateSangomaCodecParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"UpdateSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateSangomaCodecParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Sangoma Codec Parameter.
Event value
UpdateSangomaCodecParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchSangomaCodecParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchSangomaCodecParameter",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Sangoma Codec Parameter.
Event value
SwitchSangomaCodecParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddSangomaCodecParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddSangomaCodecParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Sangoma Codec Parameter.
Event value
AddSangomaCodecParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelSangomaCodecParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelSangomaCodecParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelSangomaCodecParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 38,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Sangoma Codec Parameter.
Event value
DelSangomaCodecParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Sndfile
GetSndfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetSndfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetSndfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetSndfile",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 41,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Sndfile.
Event value
GetSndfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateSndfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateSndfileParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 41,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Sndfile Parameter.
Event value
UpdateSndfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
SwitchSndfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchSndfileParameter",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 41,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Sndfile Parameter.
Event value
SwitchSndfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddSndfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddSndfileParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 41,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Sndfile Parameter.
Event value
AddSndfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelSndfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}'
exampleSocket.send('{"event":"DelSndfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2}}}');
Returns JSON structured like this:
{
"MessageType": "DelSndfileParameter",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 41,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Sndfile Parameter.
Event value
DelSndfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
XML CDR
GetXmlCdr
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetXmlCdr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetXmlCdr","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetXmlCdr",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "log-dir",
"value": "",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "log-b-leg",
"value": "false",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "prefix-a-leg",
"value": "true",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "encode",
"value": "true",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Xml Cdr.
Event value
GetXmlCdr
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateXmlCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"encode","value":"false"}}}'
exampleSocket.send('{"event":"UpdateXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"encode","value":"false"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateXmlCdrParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "encode",
"value": "false",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Xml Cdr Parameter.
Event value
UpdateXmlCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchXmlCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchXmlCdrParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "encode",
"value": "false",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Xml Cdr Parameter.
Event value
SwitchXmlCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddXmlCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddXmlCdrParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Xml Cdr Parameter.
Event value
AddXmlCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelXmlCdrParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelXmlCdrParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelXmlCdrParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 48,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Xml Cdr Parameter.
Event value
DelXmlCdrParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
XML RPC
GetXmlRpc
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetXmlRpc","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetXmlRpc","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetXmlRpc",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "http-port",
"value": "8080",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "auth-realm",
"value": "freeswitch",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "auth-user",
"value": "freeswitch",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "auth-pass",
"value": "works",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Xml Rpc.
Event value
GetXmlRpc
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateXmlRpcParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":true,"name":"auth-user","value":"freeswitch2"}}}'
exampleSocket.send('{"event":"UpdateXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":true,"name":"auth-user","value":"freeswitch2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateXmlRpcParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "auth-user",
"value": "freeswitch2",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Xml Rpc Parameter.
Event value
UpdateXmlRpcParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchXmlRpcParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchXmlRpcParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "auth-pass",
"value": "works",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Xml Rpc Parameter.
Event value
SwitchXmlRpcParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddXmlRpcParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddXmlRpcParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Xml Rpc Parameter.
Event value
AddXmlRpcParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelXmlRpcParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelXmlRpcParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelXmlRpcParameter",
"data": {
"id": 5,
"position": 5,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 49,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Xml Rpc Parameter.
Event value
DelXmlRpcParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Zeroconf
GetZeroconf
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetZeroconf","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetZeroconf","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetZeroconf",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "publish",
"value": "yes",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "browse",
"value": "_sip._udp",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Zeroconf.
Event value
GetZeroconf
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateZeroconfParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"publish","value":"no"}}}'
exampleSocket.send('{"event":"UpdateZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"publish","value":"no"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateZeroconfParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "publish",
"value": "no",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Zeroconf Parameter.
Event value
UpdateZeroconfParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchZeroconfParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchZeroconfParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "publish",
"value": "no",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Zeroconf Parameter.
Event value
SwitchZeroconfParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddZeroconfParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddZeroconfParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Zeroconf Parameter.
Event value
AddZeroconfParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelZeroconfParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}'
exampleSocket.send('{"event":"DelZeroconfParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3}}}');
Returns JSON structured like this:
{
"MessageType": "DelZeroconfParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 50,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Zeroconf Parameter.
Event value
DelZeroconfParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Post Load Switch
GetPostSwitch
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetPostSwitch","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetPostSwitch","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetPostSwitch",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "colorize-console",
"value": "true",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "dump-cores",
"value": "yes",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "rtp-enable-zrtp",
"value": "false",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "dialplan-timestamps",
"value": "false",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "max-db-handles",
"value": "50",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "db-handle-timeout",
"value": "10",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "max-sessions",
"value": "1000",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "sessions-per-second",
"value": "30",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "loglevel",
"value": "debug",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "mailer-app",
"value": "sendmail",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "mailer-app-args",
"value": "-t",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"cli_keybinding": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "1",
"value": "help",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "10",
"value": "sofia profile internal siptrace on",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "11",
"value": "sofia profile internal siptrace off",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"12": {
"id": 12,
"position": 12,
"enabled": true,
"name": "12",
"value": "version",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "2",
"value": "status",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "3",
"value": "show channels",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "4",
"value": "show calls",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "5",
"value": "sofia status",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "6",
"value": "reloadxml",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "7",
"value": "console loglevel 0",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "8",
"value": "console loglevel 7",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "9",
"value": "sofia status profile internal",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"default_ptime": {}
}
}
Get Post Switch.
Event value
GetPostSwitch
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdatePostSwitchParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":true}}}'
exampleSocket.send('{"event":"UpdatePostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":true}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePostSwitchParameter",
"data": {
"id": 6,
"position": 6,
"enabled": true,
"name": "sessions-per-second",
"value": "35",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Post Switch Parameter.
Event value
UpdatePostSwitchParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
SwitchPostSwitchParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPostSwitchParameter",
"data": {
"id": 6,
"position": 6,
"enabled": false,
"name": "sessions-per-second",
"value": "35",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Post Switch Parameter.
Event value
SwitchPostSwitchParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddPostSwitchParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPostSwitchParameter",
"data": {
"id": 13,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Post Switch Parameter.
Event value
AddPostSwitchParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelPostSwitchParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13}}}'
exampleSocket.send('{"event":"DelPostSwitchParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13}}}');
Returns JSON structured like this:
{
"MessageType": "DelPostSwitchParameter",
"data": {
"id": 13,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Post Switch Parameter.
Event value
DelPostSwitchParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
UpdatePostSwitchCliKeybinding
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":true}}}'
exampleSocket.send('{"event":"UpdatePostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":true}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePostSwitchCliKeybinding",
"data": {
"id": 7,
"position": 7,
"enabled": true,
"name": "7",
"value": "console loglevel 1",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Post Switch Cli Keybinding.
Event value
UpdatePostSwitchCliKeybinding
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
SwitchPostSwitchCliKeybinding
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPostSwitchCliKeybinding",
"data": {
"id": 7,
"position": 7,
"enabled": false,
"name": "7",
"value": "console loglevel 1",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Post Switch Cli Keybinding.
Event value
SwitchPostSwitchCliKeybinding
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddPostSwitchCliKeybinding
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPostSwitchCliKeybinding",
"data": {
"id": 15,
"position": 13,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Post Switch Cli Keybinding.
Event value
AddPostSwitchCliKeybinding
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelPostSwitchCliKeybinding
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":15}}}'
exampleSocket.send('{"event":"DelPostSwitchCliKeybinding","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":15}}}');
Returns JSON structured like this:
{
"MessageType": "DelPostSwitchCliKeybinding",
"data": {
"id": 15,
"position": 13,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Post Switch Cli Keybinding.
Event value
DelPostSwitchCliKeybinding
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
UpdatePostSwitchDefaultPtime
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdatePostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePostSwitchDefaultPtime",
"data": {
"id": 4,
"position": 1,
"enabled": true,
"codec_name": "paramn2",
"codec_ptime": "paramv2",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Post Switch Default Ptime.
Event value
UpdatePostSwitchDefaultPtime
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
SwitchPostSwitchDefaultPtime
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPostSwitchDefaultPtime",
"data": {
"id": 4,
"position": 1,
"enabled": false,
"codec_name": "paramn",
"codec_ptime": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Post Switch Default Ptime.
Event value
SwitchPostSwitchDefaultPtime
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddPostSwitchDefaultPtime
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"enabled":true,"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddPostSwitchDefaultPtime",
"data": {
"id": 4,
"position": 1,
"enabled": true,
"codec_name": "paramn",
"codec_ptime": "paramv",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Post Switch Default Ptime.
Event value
AddPostSwitchDefaultPtime
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - name | String | Item name |
Errors
DelPostSwitchDefaultPtime
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9}}}'
exampleSocket.send('{"event":"DelPostSwitchDefaultPtime","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":9}}}');
Returns JSON structured like this:
{
"MessageType": "DelPostSwitchDefaultPtime",
"data": {
"id": 9,
"position": 2,
"enabled": true,
"codec_name": "dfsdfs",
"codec_ptime": "sfsfsd",
"description": "",
"parent": {
"id": 43,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Post Switch Default Ptime.
Event value
DelPostSwitchDefaultPtime
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Distributor
GetDistributorConfig
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDistributorConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDistributorConfig","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDistributorConfig",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "test",
"description": "",
"parent": {
"id": 17,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Distributor Config.
Event value
GetDistributorConfig
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
AddDistributorList
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_list"}}'
exampleSocket.send('{"event":"AddDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_list"}}');
Returns JSON structured like this:
{
"MessageType": "AddDistributorList",
"data": {
"id": 7,
"position": 2,
"enabled": true,
"name": "new_list",
"description": "",
"parent": {
"id": 17,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Distributor List.
Event value
AddDistributorList
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateDistributorList
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":7,"name":"new_list2"}}'
exampleSocket.send('{"event":"UpdateDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":7,"name":"new_list2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDistributorList",
"data": {
"id": 7,
"position": 2,
"enabled": true,
"name": "new_list2",
"description": "",
"parent": {
"id": 17,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Distributor List.
Event value
UpdateDistributorList
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| token | String | User auth token. |
Errors
DelDistributorList
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":7}}'
exampleSocket.send('{"event":"DelDistributorList","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":7}}');
Returns JSON structured like this:
{
"MessageType": "DelDistributorList",
"data": {
"id": 7,
"position": 2,
"enabled": true,
"name": "new_list2",
"description": "",
"parent": {
"id": 17,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Distributor List.
Event value
DelDistributorList
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
GetDistributorNodes
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDistributorNodes","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetDistributorNodes","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetDistributorNodes",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "foo1",
"weight": "1",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "foo2",
"weight": "9",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Distributor Nodes.
Event value
GetDistributorNodes
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddDistributorNode
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"distributor_node":{"name":"paramn","weight":"paramv"}}}'
exampleSocket.send('{"event":"AddDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"distributor_node":{"name":"paramn","weight":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddDistributorNode",
"data": {
"id": 15,
"position": 3,
"enabled": true,
"name": "paramn",
"weight": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Distributor Node.
Event value
AddDistributorNode
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| distributor_node | Object | |
| - name | String | Item name |
| - weight | String |
Errors
DelDistributorNode
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":15}}}'
exampleSocket.send('{"event":"DelDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":15}}}');
Returns JSON structured like this:
{
"MessageType": "DelDistributorNode",
"data": {
"id": 15,
"position": 3,
"enabled": true,
"name": "paramn",
"weight": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Distributor Node.
Event value
DelDistributorNode
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| distributor_node | Object | |
| - id | Integer | Item ID. |
Errors
UpdateDistributorNode
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":2,"name":"foo2","weight":"2"}}}'
exampleSocket.send('{"event":"UpdateDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":2,"name":"foo2","weight":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDistributorNode",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "foo2",
"weight": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Distributor Node.
Event value
UpdateDistributorNode
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| distributor_node | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - weight | String |
Errors
SwitchDistributorNode
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchDistributorNode","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","distributor_node":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDistributorNode",
"data": {
"id": 2,
"position": 2,
"enabled": false,
"name": "foo2",
"weight": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Distributor Node.
Event value
SwitchDistributorNode
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| distributor_node | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
Directory
GetDirectory
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetDirectory","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectory",
"data": {
"settings": {},
"profiles": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "ccvcx",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 2,
"enabled": true,
"name": "sefsef",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Directory.
Event value
GetDirectory
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryParameter",
"data": {
"id": 8,
"position": 8,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Directory Parameter.
Event value
UpdateDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":8,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryParameter",
"data": {
"id": 8,
"position": 1,
"enabled": false,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Directory Parameter.
Event value
SwitchDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddDirectoryParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddDirectoryParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryParameter",
"data": {
"id": 8,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Directory Parameter.
Event value
AddDirectoryParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
GetDirectoryProfileParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetDirectoryProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"GetDirectoryProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "GetDirectoryProfileParameters",
"data": {
"14": {
"id": 14,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Directory Profile Parameters.
Event value
GetDirectoryProfileParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddDirectoryProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryProfileParameter",
"data": {
"id": 14,
"position": 1,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Directory Profile Parameter.
Event value
AddDirectoryProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelDirectoryProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}'
exampleSocket.send('{"event":"DelDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}');
Returns JSON structured like this:
{
"MessageType": "DelDirectoryProfileParameter",
"data": {
"id": 14,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Directory Profile Parameter.
Event value
DelDirectoryProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchDirectoryProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchDirectoryProfileParameter",
"data": {
"id": 14,
"position": 1,
"enabled": false,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Directory Profile Parameter.
Event value
SwitchDirectoryProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateDirectoryProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"name":"paramn2","value":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateDirectoryProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14,"name":"paramn2","value":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryProfileParameter",
"data": {
"id": 14,
"position": 1,
"enabled": true,
"name": "paramn2",
"value": "paramv2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Directory Profile Parameter.
Event value
UpdateDirectoryProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
AddDirectoryProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"AddDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "AddDirectoryProfile",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Directory Profile.
Event value
AddDirectoryProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateDirectoryProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_profile2"}}'
exampleSocket.send('{"event":"UpdateDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateDirectoryProfile",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Directory Profile.
Event value
UpdateDirectoryProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelDirectoryProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"DelDirectoryProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "DelDirectoryProfile",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 15,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Directory Profile.
Event value
DelDirectoryProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
Fifo
GetFifo
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetFifo",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "delete-all-outbound-member-on-startup",
"value": "false",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "cool_fifo@domain.com",
"importance": "444",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Fifo.
Event value
GetFifo
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateFifoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"delete-all-outbound-member-on-startup","value":"true"}}}'
exampleSocket.send('{"event":"UpdateFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"delete-all-outbound-member-on-startup","value":"true"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateFifoParameter",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "delete-all-outbound-member-on-startup",
"value": "true",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Fifo Parameter.
Event value
UpdateFifoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchFifoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchFifoParameter",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "delete-all-outbound-member-on-startup",
"value": "true",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Fifo Parameter.
Event value
SwitchFifoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddFifoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddFifoParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Fifo Parameter.
Event value
AddFifoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelFifoParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelFifoParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelFifoParameter",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Fifo Parameter.
Event value
DelFifoParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetFifoFifoMembers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetFifoFifoMembers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetFifoFifoMembers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetFifoFifoMembers",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"timeout": "3",
"simo": "3",
"lag": "user",
"body": "user",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"importance": "",
"description": "",
"parent": null
}
}
}
}
Get Fifo Fifo Members.
Event value
GetFifoFifoMembers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddFifoFifoMember
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"fifo_fifo_member":{"timeout":"3","simo":"3","lag":"3","body":"user"}}}'
exampleSocket.send('{"event":"AddFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"fifo_fifo_member":{"timeout":"3","simo":"3","lag":"3","body":"user"}}}');
Returns JSON structured like this:
{
"MessageType": "AddFifoFifoMember",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"timeout": "3",
"simo": "3",
"lag": "user",
"body": "3",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"importance": "",
"description": "",
"parent": null
}
}
}
Add Fifo Fifo Member.
Event value
AddFifoFifoMember
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| fifo_fifo_member | Object | |
| - timeout | String | |
| - simo | String | |
| - lag | String | |
| - body | String |
Errors
DelFifoFifoMember
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":5}}}'
exampleSocket.send('{"event":"DelFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelFifoFifoMember",
"data": {
"id": 5,
"position": 1,
"enabled": true,
"timeout": "3",
"simo": "3",
"lag": "3",
"body": "user",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"importance": "",
"description": "",
"parent": null
}
}
}
Del Fifo Fifo Member.
Event value
DelFifoFifoMember
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| fifo_fifo_member | Object | |
| - id | Integer | Item ID. |
Errors
SwitchFifoFifoMember
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchFifoFifoMember",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"timeout": "3",
"simo": "3",
"lag": "user",
"body": "user",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"importance": "",
"description": "",
"parent": null
}
}
}
Switch Fifo Fifo Member.
Event value
SwitchFifoFifoMember
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| fifo_fifo_member | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateFifoFifoMember
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":2,"timeout":"5","simo":"5","lag":"4","body":"user"}}}'
exampleSocket.send('{"event":"UpdateFifoFifoMember","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","fifo_fifo_member":{"id":2,"timeout":"5","simo":"5","lag":"4","body":"user"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateFifoFifoMember",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"timeout": "5",
"simo": "5",
"lag": "4",
"body": "user",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"importance": "",
"description": "",
"parent": null
}
}
}
Update Fifo Fifo Member.
Event value
UpdateFifoFifoMember
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| fifo_fifo_member | Object | |
| - id | Integer | Item ID. |
| - timeout | String | |
| - simo | String | |
| - lag | String | |
| - body | String |
Errors
AddFifoFifo
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_fifo"}}'
exampleSocket.send('{"event":"AddFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_fifo"}}');
Returns JSON structured like this:
{
"MessageType": "AddFifoFifo",
"data": {
"id": 3,
"position": 2,
"enabled": true,
"name": "new_fifo",
"importance": "0",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Fifo Fifo.
Event value
AddFifoFifo
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateFifoFifo
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3,"name":"new_fifo2"}}'
exampleSocket.send('{"event":"UpdateFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3,"name":"new_fifo2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateFifoFifo",
"data": {
"id": 3,
"position": 2,
"enabled": true,
"name": "new_fifo2",
"importance": "0",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Fifo Fifo.
Event value
UpdateFifoFifo
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelFifoFifo
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3}}'
exampleSocket.send('{"event":"DelFifoFifo","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":3}}');
Returns JSON structured like this:
{
"MessageType": "DelFifoFifo",
"data": {
"id": 3,
"position": 2,
"enabled": true,
"name": "new_fifo2",
"importance": "0",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Fifo Fifo.
Event value
DelFifoFifo
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
UpdateFifoFifoImportance
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateFifoFifoImportance","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"5","id":1}}'
exampleSocket.send('{"event":"UpdateFifoFifoImportance","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","value":"5","id":1}}');
Returns JSON structured like this:
{
"MessageType": "UpdateFifoFifoImportance",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "cool_fifo@domain.com",
"importance": "5",
"description": "",
"parent": {
"id": 22,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Fifo Fifo Importance.
Event value
UpdateFifoFifoImportance
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
| value | String | Item value |
Errors
Opal
GetOpal
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOpal","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetOpal","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetOpal",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "trace-level",
"value": "3",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "context",
"value": "default",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "dtmf-type",
"value": "signal",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "jitter-size",
"value": "40,100",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "gk-address",
"value": "",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "gk-identifer",
"value": "",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "gk-interface",
"value": "domain.com",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"listeners": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "fsfsdf",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Opal.
Event value
GetOpal
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateOpalParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"jitter-size","value":"40,101"}}}'
exampleSocket.send('{"event":"UpdateOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5,"name":"jitter-size","value":"40,101"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOpalParameter",
"error": "can't get updated item"
}
Update Opal Parameter.
Event value
UpdateOpalParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchOpalParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOpalParameter",
"data": {
"id": 4,
"position": 4,
"enabled": false,
"name": "dtmf-type",
"value": "signal",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Opal Parameter.
Event value
SwitchOpalParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddOpalParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOpalParameter",
"data": {
"id": 11,
"position": 9,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Opal Parameter.
Event value
AddOpalParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelOpalParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11}}}'
exampleSocket.send('{"event":"DelOpalParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11}}}');
Returns JSON structured like this:
{
"MessageType": "DelOpalParameter",
"data": {
"id": 11,
"position": 9,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Opal Parameter.
Event value
DelOpalParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetOpalListenerParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOpalListenerParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetOpalListenerParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetOpalListenerParameters",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "h323-ip",
"value": "domain.com",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "h323-port",
"value": "1720",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Opal Listener Parameters.
Event value
GetOpalListenerParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
AddOpalListenerParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOpalListenerParameter",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Opal Listener Parameter.
Event value
AddOpalListenerParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - value | String | Item value |
| - name | String | Item name |
Errors
DelOpalListenerParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelOpalListenerParameter",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Opal Listener Parameter.
Event value
DelOpalListenerParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchOpalListenerParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOpalListenerParameter",
"data": {
"id": 2,
"position": 2,
"enabled": false,
"name": "h323-port",
"value": "1720",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Opal Listener Parameter.
Event value
SwitchOpalListenerParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateOpalListenerParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"h323-port","value":"1721"}}}'
exampleSocket.send('{"event":"UpdateOpalListenerParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"h323-port","value":"1721"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOpalListenerParameter",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "h323-port",
"value": "1721",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Opal Listener Parameter.
Event value
UpdateOpalListenerParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
AddOpalListener
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_listener"}}'
exampleSocket.send('{"event":"AddOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_listener"}}');
Returns JSON structured like this:
{
"MessageType": "AddOpalListener",
"data": {
"id": 6,
"position": 3,
"enabled": true,
"name": "new_listener",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Opal Listener.
Event value
AddOpalListener
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateOpalListener
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_listener2"}}'
exampleSocket.send('{"event":"UpdateOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_listener2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOpalListener",
"data": {
"id": 6,
"position": 3,
"enabled": true,
"name": "new_listener2",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Opal Listener.
Event value
UpdateOpalListener
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| token | String | User auth token. |
Errors
DelOpalListener
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}'
exampleSocket.send('{"event":"DelOpalListener","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}');
Returns JSON structured like this:
{
"MessageType": "DelOpalListener",
"data": {
"id": 6,
"position": 3,
"enabled": true,
"name": "new_listener2",
"description": "",
"parent": {
"id": 30,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Opal Listener.
Event value
DelOpalListener
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Osp
GetOsp
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOsp","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetOsp","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetOsp",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "debug-info",
"value": "disabled",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "log-level",
"value": "info",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "crypto-hardware",
"value": "disabled",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "sip",
"value": "",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "default-protocol",
"value": "sip",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Osp.
Event value
GetOsp
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateOspParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"log-level","value":"debug"}}}'
exampleSocket.send('{"event":"UpdateOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"log-level","value":"debug"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOspParameter",
"data": {
"id": 2,
"position": 2,
"enabled": true,
"name": "log-level",
"value": "debug",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Osp Parameter.
Event value
UpdateOspParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchOspParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOspParameter",
"data": {
"id": 3,
"position": 3,
"enabled": false,
"name": "crypto-hardware",
"value": "disabled",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Osp Parameter.
Event value
SwitchOspParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddOspParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOspParameter",
"data": {
"id": 10,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Osp Parameter.
Event value
AddOspParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelOspParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}'
exampleSocket.send('{"event":"DelOspParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":10}}}');
Returns JSON structured like this:
{
"MessageType": "DelOspParameter",
"data": {
"id": 10,
"position": 6,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Osp Parameter.
Event value
DelOspParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetOspProfileParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetOspProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetOspProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetOspProfileParameters",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "service-point-url",
"value": "http://127.0.0.1:5045/osp",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "service-type",
"value": "voice",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "max-destinations",
"value": "12",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "device-ip",
"value": "127.0.0.1:5080",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "ssl-lifetime",
"value": "300",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "http-max-connections",
"value": "20",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "http-persistence",
"value": "60",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "http-retry-delay",
"value": "0",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "http-retry-limit",
"value": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "http-timeout",
"value": "10000",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "work-mode",
"value": "direct",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Osp Profile Parameters.
Event value
GetOspProfileParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddOspProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddOspProfileParameter",
"data": {
"id": 19,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Osp Profile Parameter.
Event value
AddOspProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelOspProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19}}}'
exampleSocket.send('{"event":"DelOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19}}}');
Returns JSON structured like this:
{
"MessageType": "DelOspProfileParameter",
"data": {
"id": 19,
"position": 12,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Osp Profile Parameter.
Event value
DelOspProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchOspProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchOspProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchOspProfileParameter",
"data": {
"id": 11,
"position": 11,
"enabled": false,
"name": "max-destinations",
"value": "12",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Osp Profile Parameter.
Event value
SwitchOspProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddOspProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"AddOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "AddOspProfile",
"data": {
"id": 6,
"position": 2,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Osp Profile.
Event value
AddOspProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateOspProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_profile2"}}'
exampleSocket.send('{"event":"UpdateOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateOspProfile",
"data": {
"id": 6,
"position": 2,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Osp Profile.
Event value
UpdateOspProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | Item name |
| token | String | User auth token. |
Errors
DelOspProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}'
exampleSocket.send('{"event":"DelOspProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":6}}');
Returns JSON structured like this:
{
"MessageType": "DelOspProfile",
"data": {
"id": 6,
"position": 2,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 33,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Osp Profile.
Event value
DelOspProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Unicall
GetUnicall
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetUnicall","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetUnicall","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetUnicall",
"data": {
"settings": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "context",
"value": "default",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "suppress-dtmf-tone",
"value": "true",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"span_id": "1",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"span_id": "2",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Unicall.
Event value
GetUnicall
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateUnicallParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"suppress-dtmf-tone","value":"truefalse"}}}'
exampleSocket.send('{"event":"UpdateUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"name":"suppress-dtmf-tone","value":"truefalse"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateUnicallParameter",
"data": {
"id": 3,
"position": 3,
"enabled": true,
"name": "suppress-dtmf-tone",
"value": "truefalse",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Unicall Parameter.
Event value
UpdateUnicallParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
SwitchUnicallParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":3,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchUnicallParameter",
"data": {
"id": 3,
"position": 3,
"enabled": false,
"name": "suppress-dtmf-tone",
"value": "truefalse",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Unicall Parameter.
Event value
SwitchUnicallParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddUnicallParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddUnicallParameter",
"data": {
"id": 5,
"position": 4,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Unicall Parameter.
Event value
AddUnicallParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelUnicallParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}'
exampleSocket.send('{"event":"DelUnicallParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":5}}}');
Returns JSON structured like this:
{
"MessageType": "DelUnicallParameter",
"data": {
"id": 5,
"position": 4,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Unicall Parameter.
Event value
DelUnicallParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetUnicallSpanParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetUnicallSpanParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetUnicallSpanParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetUnicallSpanParameters",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "protocol-class",
"value": "mfcr2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "protocol-variant",
"value": "ar",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "protocol-end",
"value": "peer",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "outgoing-allowed",
"value": "true",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "context",
"value": "default",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
}
}
}
Get Unicall Span Parameters.
Event value
GetUnicallSpanParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddUnicallSpanParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddUnicallSpanParameter",
"data": {
"id": 14,
"position": 7,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
}
}
Add Unicall Span Parameter.
Event value
AddUnicallSpanParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelUnicallSpanParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}'
exampleSocket.send('{"event":"DelUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":14}}}');
Returns JSON structured like this:
{
"MessageType": "DelUnicallSpanParameter",
"data": {
"id": 14,
"position": 7,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
}
}
Del Unicall Span Parameter.
Event value
DelUnicallSpanParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchUnicallSpanParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":6,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchUnicallSpanParameter",
"data": {
"id": 6,
"position": 6,
"enabled": false,
"name": "context",
"value": "default",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
}
}
Switch Unicall Span Parameter.
Event value
SwitchUnicallSpanParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateUnicallSpanParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"outgoing-allowed","value":"false"}}}'
exampleSocket.send('{"event":"UpdateUnicallSpanParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4,"name":"outgoing-allowed","value":"false"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateUnicallSpanParameter",
"data": {
"id": 4,
"position": 4,
"enabled": true,
"name": "outgoing-allowed",
"value": "false",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"span_id": "",
"description": "",
"parent": null
}
}
}
Update Unicall Span Parameter.
Event value
UpdateUnicallSpanParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
AddUnicallSpan
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_span"}}'
exampleSocket.send('{"event":"AddUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_span"}}');
Returns JSON structured like this:
{
"MessageType": "AddUnicallSpan",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"span_id": "new_span",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Unicall Span.
Event value
AddUnicallSpan
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateUnicallSpan
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_span3"}}'
exampleSocket.send('{"event":"UpdateUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5,"name":"new_span3"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateUnicallSpan",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"span_id": "new_span3",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Unicall Span.
Event value
UpdateUnicallSpan
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelUnicallSpan
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}'
exampleSocket.send('{"event":"DelUnicallSpan","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":5}}');
Returns JSON structured like this:
{
"MessageType": "DelUnicallSpan",
"data": {
"id": 5,
"position": 3,
"enabled": true,
"span_id": "new_span3",
"description": "",
"parent": {
"id": 45,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Unicall Span.
Event value
DelUnicallSpan
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Conference
GetConference
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetConference","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetConference","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetConference",
"data": {
"conference_rooms": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "3001@domain.com",
"status": "FreeSWITCH",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"conference_profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "a1",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "wideband",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "ultrawideband",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "cdquality",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "video-mcu-stereo",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "video-mcu-stereo-720",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "video-mcu-stereo-480",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "video-mcu-stereo-320",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "sla",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"conference_caller_control_groups": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "s2",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
},
"conference_chat_permissions_profiles": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "a1",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "wideband",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "ultrawideband",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "cdquality",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "video-mcu-stereo",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "video-mcu-stereo-720",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "video-mcu-stereo-480",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "video-mcu-stereo-320",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "sla",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
}
Get Conference.
Event value
GetConference
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateConferenceRoom
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":true,"name":"3001@domain.com","status":"FreeSWITCH2"}}}'
exampleSocket.send('{"event":"UpdateConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":true,"name":"3001@domain.com","status":"FreeSWITCH2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceRoom",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "3001@domain.com",
"status": "",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Conference Room.
Event value
UpdateConferenceRoom
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - name | String | Item name |
| - status | String |
Errors
SwitchConferenceRoom
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchConferenceRoom",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "3001@domain.com",
"status": "",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Conference Room.
Event value
SwitchConferenceRoom
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - id | Integer | Item ID. |
Errors
AddConferenceRoom
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"room","value":"status"}}}'
exampleSocket.send('{"event":"AddConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"room","value":"status"}}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceRoom",
"data": {
"id": 7,
"position": 2,
"enabled": true,
"name": "room",
"status": "status",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Conference Room.
Event value
AddConferenceRoom
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelConferenceRoom
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}'
exampleSocket.send('{"event":"DelConferenceRoom","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":7}}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceRoom",
"data": {
"id": 7,
"position": 2,
"enabled": true,
"name": "room",
"status": "status",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Conference Room.
Event value
DelConferenceRoom
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetConferenceCallerControls
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetConferenceCallerControls","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"GetConferenceCallerControls","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "GetConferenceCallerControls",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"action": "mute",
"digits": "0",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"action": "vol listen zero",
"digits": "5",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"action": "vol listen dn",
"digits": "4",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"12": {
"id": 12,
"position": 12,
"enabled": true,
"action": "hangup",
"digits": "#",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"action": "deaf mute",
"digits": "*",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"action": "energy up",
"digits": "9",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"action": "energy equ",
"digits": "8",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"action": "energy dn",
"digits": "7",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"action": "vol talk up",
"digits": "3",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"action": "vol talk zero",
"digits": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"action": "vol talk dn",
"digits": "1",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"action": "vol listen up",
"digits": "6",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Conference Caller Controls.
Event value
GetConferenceCallerControls
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddConferenceCallerControl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"action","value":"2"}}}'
exampleSocket.send('{"event":"AddConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1,"param":{"name":"action","value":"2"}}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceCallerControl",
"data": {
"id": 19,
"position": 13,
"enabled": true,
"action": "action",
"digits": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Conference Caller Control.
Event value
AddConferenceCallerControl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelConferenceCallerControl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19}}}'
exampleSocket.send('{"event":"DelConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":19}}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceCallerControl",
"data": {
"id": 19,
"position": 13,
"enabled": true,
"action": "action",
"digits": "2",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Conference Caller Control.
Event value
DelConferenceCallerControl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchConferenceCallerControl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":12,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchConferenceCallerControl",
"data": {
"id": 12,
"position": 12,
"enabled": false,
"action": "hangup",
"digits": "#",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Conference Caller Control.
Event value
SwitchConferenceCallerControl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateConferenceCallerControl
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"name":"vol listen dn","value":"4"}}}'
exampleSocket.send('{"event":"UpdateConferenceCallerControl","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":11,"name":"vol listen dn","value":"4"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceCallerControl",
"data": {
"id": 11,
"position": 11,
"enabled": true,
"action": "vol listen dn",
"digits": "4",
"description": "",
"parent": {
"id": 1,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Conference Caller Control.
Event value
UpdateConferenceCallerControl
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
AddConferenceCallerControlGroup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_group"}}'
exampleSocket.send('{"event":"AddConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_group"}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceCallerControlGroup",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_group",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Conference Caller Control Group.
Event value
AddConferenceCallerControlGroup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateConferenceCallerControlGroup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"new_group2"}}'
exampleSocket.send('{"event":"UpdateConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4,"name":"new_group2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceCallerControlGroup",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_group2",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Conference Caller Control Group.
Event value
UpdateConferenceCallerControlGroup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelConferenceCallerControlGroup
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}'
exampleSocket.send('{"event":"DelConferenceCallerControlGroup","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":4}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceCallerControlGroup",
"data": {
"id": 4,
"position": 3,
"enabled": true,
"name": "new_group2",
"description": "",
"parent": {
"id": 11,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Conference Caller Control Group.
Event value
DelConferenceCallerControlGroup
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
GetConferenceProfileParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetConferenceProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10}}'
exampleSocket.send('{"event":"GetConferenceProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10}}');
Returns JSON structured like this:
{
"MessageType": "GetConferenceProfileParameters",
"data": {
"204": {
"id": 204,
"position": 1,
"enabled": true,
"name": "domain",
"value": "domain.com",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"205": {
"id": 205,
"position": 2,
"enabled": true,
"name": "rate",
"value": "8000",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"206": {
"id": 206,
"position": 3,
"enabled": true,
"name": "interval",
"value": "20",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"207": {
"id": 207,
"position": 4,
"enabled": true,
"name": "energy-level",
"value": "100",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"208": {
"id": 208,
"position": 5,
"enabled": true,
"name": "muted-sound",
"value": "conference/conf-muted.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"209": {
"id": 209,
"position": 6,
"enabled": true,
"name": "unmuted-sound",
"value": "conference/conf-unmuted.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"210": {
"id": 210,
"position": 7,
"enabled": true,
"name": "alone-sound",
"value": "conference/conf-alone.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"211": {
"id": 211,
"position": 8,
"enabled": true,
"name": "moh-sound",
"value": "local_stream://moh",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"212": {
"id": 212,
"position": 9,
"enabled": true,
"name": "enter-sound",
"value": "tone_stream://%(200,0,500,600,700)",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"213": {
"id": 213,
"position": 10,
"enabled": true,
"name": "exit-sound",
"value": "tone_stream://%(500,0,300,200,100,50,25)",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"214": {
"id": 214,
"position": 11,
"enabled": true,
"name": "kicked-sound",
"value": "conference/conf-kicked.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"215": {
"id": 215,
"position": 12,
"enabled": true,
"name": "locked-sound",
"value": "conference/conf-locked.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"216": {
"id": 216,
"position": 13,
"enabled": true,
"name": "is-locked-sound",
"value": "conference/conf-is-locked.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"217": {
"id": 217,
"position": 14,
"enabled": true,
"name": "is-unlocked-sound",
"value": "conference/conf-is-unlocked.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"218": {
"id": 218,
"position": 15,
"enabled": true,
"name": "pin-sound",
"value": "conference/conf-pin.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"219": {
"id": 219,
"position": 16,
"enabled": true,
"name": "bad-pin-sound",
"value": "conference/conf-bad-pin.wav",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"220": {
"id": 220,
"position": 17,
"enabled": true,
"name": "caller-id-name",
"value": "FreeSWITCH",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"221": {
"id": 221,
"position": 18,
"enabled": true,
"name": "caller-id-number",
"value": "0000000000",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"222": {
"id": 222,
"position": 19,
"enabled": true,
"name": "comfort-noise",
"value": "true",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Conference Profile Parameters.
Event value
GetConferenceProfileParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddConferenceProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceProfileParameter",
"data": {
"id": 407,
"position": 20,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Conference Profile Parameter.
Event value
AddConferenceProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelConferenceProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":407}}}'
exampleSocket.send('{"event":"DelConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":407}}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceProfileParameter",
"data": {
"id": 407,
"position": 20,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Conference Profile Parameter.
Event value
DelConferenceProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchConferenceProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":222,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":222,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchConferenceProfileParameter",
"data": {
"id": 222,
"position": 19,
"enabled": false,
"name": "comfort-noise",
"value": "true",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Conference Profile Parameter.
Event value
SwitchConferenceProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateConferenceProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":222,"name":"comfort-noise","value":"false"}}}'
exampleSocket.send('{"event":"UpdateConferenceProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":222,"name":"comfort-noise","value":"false"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceProfileParameter",
"data": {
"id": 222,
"position": 19,
"enabled": true,
"name": "comfort-noise",
"value": "false",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Conference Profile Parameter.
Event value
UpdateConferenceProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
| - value | String | Item value |
Errors
AddConferenceProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"AddConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceProfile",
"data": {
"id": 19,
"position": 10,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Conference Profile.
Event value
AddConferenceProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| token | String | User auth token. |
Errors
UpdateConferenceProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":19,"name":"new_profile2"}}'
exampleSocket.send('{"event":"UpdateConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":19,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceProfile",
"data": {
"id": 19,
"position": 10,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Conference Profile.
Event value
UpdateConferenceProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelConferenceProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}'
exampleSocket.send('{"event":"DelConferenceProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":1}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceProfile",
"data": {
"id": 19,
"position": 10,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Conference Profile.
Event value
DelConferenceProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
GetConferenceChatPermissionUsers
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetConferenceChatPermissionUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10}}'
exampleSocket.send('{"event":"GetConferenceChatPermissionUsers","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10}}');
Returns JSON structured like this:
{
"MessageType": "GetConferenceChatPermissionUsers",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "paramn",
"commands": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Conference Chat Permission Users.
Event value
GetConferenceChatPermissionUsers
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddConferenceChatPermissionUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":10,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceChatPermissionUser",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "paramn",
"commands": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Conference Chat Permission User.
Event value
AddConferenceChatPermissionUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelConferenceChatPermissionUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1}}}'
exampleSocket.send('{"event":"DelConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1}}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceChatPermissionUser",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "paramn2",
"commands": "",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Conference Chat Permission User.
Event value
DelConferenceChatPermissionUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchConferenceChatPermissionUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchConferenceChatPermissionUser",
"data": {
"id": 1,
"position": 1,
"enabled": false,
"name": "paramn",
"commands": "paramv",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Conference Chat Permission User.
Event value
SwitchConferenceChatPermissionUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateConferenceChatPermissionUser
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"paramn2","commands":"paramv2"}}}'
exampleSocket.send('{"event":"UpdateConferenceChatPermissionUser","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":1,"name":"paramn2","commands":"paramv2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceChatPermissionUser",
"data": {
"id": 1,
"position": 1,
"enabled": true,
"name": "paramn2",
"commands": "",
"description": "",
"parent": {
"id": 10,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Conference Chat Permission User.
Event value
UpdateConferenceChatPermissionUser
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - commands | String | |
| - id | Integer | Item ID. |
Errors
AddConferenceChatPermission
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_permission"}}'
exampleSocket.send('{"event":"AddConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_permission"}}');
Returns JSON structured like this:
{
"MessageType": "AddConferenceChatPermission",
"data": {
"id": 20,
"position": 10,
"enabled": true,
"name": "new_permission",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Conference Chat Permission.
Event value
AddConferenceChatPermission
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| name | String | Item name |
| token | String | User auth token. |
Errors
UpdateConferenceChatPermission
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":20,"name":"new_permission2"}}'
exampleSocket.send('{"event":"UpdateConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":20,"name":"new_permission2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateConferenceChatPermission",
"data": {
"id": 20,
"position": 10,
"enabled": true,
"name": "new_permission2",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Conference Chat Permission.
Event value
UpdateConferenceChatPermission
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelConferenceChatPermission
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"DelConferenceChatPermission","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "DelConferenceChatPermission",
"data": {
"id": 20,
"position": 10,
"enabled": true,
"name": "new_permission2",
"description": "",
"parent": {
"id": 57,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Conference Chat Permission.
Event value
DelConferenceChatPermission
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
Post Load Modules
GetPostLoadModules
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetPostLoadModules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetPostLoadModules","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetPostLoadModules",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": false,
"name": "mod_sofia",
"description": " ",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"10": {
"id": 10,
"position": 7,
"enabled": false,
"name": "mod_unicall",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"11": {
"id": 11,
"position": 8,
"enabled": false,
"name": "mod_xml_cdr",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"12": {
"id": 12,
"position": 9,
"enabled": false,
"name": "mod_xml_rpc",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"13": {
"id": 13,
"position": 10,
"enabled": true,
"name": "mod_shout",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"14": {
"id": 14,
"position": 11,
"enabled": true,
"name": "mod_pocketsphinx",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"15": {
"id": 15,
"position": 12,
"enabled": true,
"name": "mod_alsa",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": false,
"name": "mod_amr",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"4": {
"id": 4,
"position": 3,
"enabled": false,
"name": "mod_db",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 4,
"enabled": false,
"name": "mod_verto",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"8": {
"id": 8,
"position": 5,
"enabled": true,
"name": "mod_voicemail",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"9": {
"id": 9,
"position": 6,
"enabled": false,
"name": "mod_zeroconf",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Post Load Modules.
Event value
GetPostLoadModules
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdatePostLoadModule
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdatePostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13,"name":"mod_shout"}}}'
exampleSocket.send('{"event":"UpdatePostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13,"name":"mod_shout"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdatePostLoadModule",
"data": {
"id": 13,
"position": 10,
"enabled": true,
"name": "mod_shout",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Post Load Module.
Event value
UpdatePostLoadModule
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
SwitchPostLoadModule
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchPostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchPostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":13,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchPostLoadModule",
"data": {
"id": 13,
"position": 10,
"enabled": false,
"name": "mod_shout",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Post Load Module.
Event value
SwitchPostLoadModule
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
GetVoicemailSettings
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetVoicemailSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetVoicemailSettings","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetVoicemailSettings",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "dsfsdf2",
"value": "sdfsfs2",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Voicemail Settings.
Event value
GetVoicemailSettings
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
DelPostLoadModule
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelPostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16}}}'
exampleSocket.send('{"event":"DelPostLoadModule","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":16}}}');
Returns JSON structured like this:
{
"MessageType": "DelPostLoadModule",
"data": {
"id": 16,
"position": 13,
"enabled": true,
"name": "mod_fifo",
"description": "",
"parent": {
"id": 36,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Post Load Module.
Event value
DelPostLoadModule
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
Voicemail
GetVoicemailProfiles
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetVoicemailProfiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetVoicemailProfiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetVoicemailProfiles",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 2,
"enabled": true,
"name": "ccc",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Voicemail Profiles.
Event value
GetVoicemailProfiles
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
UpdateVoicemailSetting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"dsfsdf2","value":"sdfsfs2"}}}'
exampleSocket.send('{"event":"UpdateVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"name":"dsfsdf2","value":"sdfsfs2"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateVoicemailSetting",
"data": {
"id": 2,
"position": 1,
"enabled": true,
"name": "dsfsdf2",
"value": "sdfsfs2",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Voicemail Setting.
Event value
UpdateVoicemailSetting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - value | String | Item value |
| - id | Integer | Item ID. |
| - name | String | Item name |
Errors
SwitchVoicemailSetting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":2,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchVoicemailSetting",
"data": {
"id": 2,
"position": 1,
"enabled": false,
"name": "dsfsdf2",
"value": "sdfsfs2",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Switch Voicemail Setting.
Event value
SwitchVoicemailSetting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddVoicemailSetting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddVoicemailSetting",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Voicemail Setting.
Event value
AddVoicemailSetting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelVoicemailSetting
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}'
exampleSocket.send('{"event":"DelVoicemailSetting","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":4}}}');
Returns JSON structured like this:
{
"MessageType": "DelVoicemailSetting",
"data": {
"id": 4,
"position": 2,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Voicemail Setting.
Event value
DelVoicemailSetting
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
GetVoicemailProfiles
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetVoicemailProfiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"GetVoicemailProfiles","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "GetVoicemailProfiles",
"data": {
"2": {
"id": 2,
"position": 1,
"enabled": true,
"name": "default",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
},
"5": {
"id": 5,
"position": 2,
"enabled": true,
"name": "ccc",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
}
Get Voicemail Profiles.
Event value
GetVoicemailProfiles
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
AddVoicemailProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}'
exampleSocket.send('{"event":"AddVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","name":"new_profile"}}');
Returns JSON structured like this:
{
"MessageType": "AddVoicemailProfile",
"data": {
"id": 8,
"position": 3,
"enabled": true,
"name": "new_profile",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Add Voicemail Profile.
Event value
AddVoicemailProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | Item name |
Errors
UpdateVoicemailProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8,"name":"new_profile2"}}'
exampleSocket.send('{"event":"UpdateVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8,"name":"new_profile2"}}');
Returns JSON structured like this:
{
"MessageType": "UpdateVoicemailProfile",
"data": {
"id": 8,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Update Voicemail Profile.
Event value
UpdateVoicemailProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String | Item name |
Errors
DelVoicemailProfile
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8}}'
exampleSocket.send('{"event":"DelVoicemailProfile","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":8}}');
Returns JSON structured like this:
{
"MessageType": "DelVoicemailProfile",
"data": {
"id": 8,
"position": 3,
"enabled": true,
"name": "new_profile2",
"description": "",
"parent": {
"id": 47,
"position": 0,
"enabled": false,
"name": "",
"module": "",
"loaded": false,
"unloadable": false,
"parent": null
}
}
}
Del Voicemail Profile.
Event value
DelVoicemailProfile
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
Errors
GetVoicemailProfileParameters
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"GetVoicemailProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}'
exampleSocket.send('{"event":"GetVoicemailProfileParameters","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2}}');
Returns JSON structured like this:
{
"MessageType": "GetVoicemailProfileParameters",
"data": {
"1": {
"id": 1,
"position": 1,
"enabled": true,
"name": "file-extension",
"value": "wav",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"10": {
"id": 10,
"position": 10,
"enabled": true,
"name": "callback-context",
"value": "default",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"11": {
"id": 11,
"position": 11,
"enabled": true,
"name": "play-new-messages-key",
"value": "1",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"12": {
"id": 12,
"position": 12,
"enabled": true,
"name": "play-saved-messages-key",
"value": "2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"13": {
"id": 13,
"position": 13,
"enabled": true,
"name": "login-keys",
"value": "0",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"14": {
"id": 14,
"position": 14,
"enabled": true,
"name": "main-menu-key",
"value": "0",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"15": {
"id": 15,
"position": 15,
"enabled": true,
"name": "config-menu-key",
"value": "5",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"16": {
"id": 16,
"position": 16,
"enabled": true,
"name": "record-greeting-key",
"value": "1",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"17": {
"id": 17,
"position": 17,
"enabled": true,
"name": "choose-greeting-key",
"value": "2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"18": {
"id": 18,
"position": 18,
"enabled": true,
"name": "change-pass-key",
"value": "6",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"19": {
"id": 19,
"position": 19,
"enabled": true,
"name": "record-name-key",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"2": {
"id": 2,
"position": 2,
"enabled": true,
"name": "terminator-key",
"value": "#",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"20": {
"id": 20,
"position": 20,
"enabled": true,
"name": "record-file-key",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"21": {
"id": 21,
"position": 21,
"enabled": true,
"name": "listen-file-key",
"value": "1",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"22": {
"id": 22,
"position": 22,
"enabled": true,
"name": "save-file-key",
"value": "2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"23": {
"id": 23,
"position": 23,
"enabled": true,
"name": "delete-file-key",
"value": "7",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"24": {
"id": 24,
"position": 24,
"enabled": true,
"name": "undelete-file-key",
"value": "8",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"25": {
"id": 25,
"position": 25,
"enabled": true,
"name": "email-key",
"value": "4",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"26": {
"id": 26,
"position": 26,
"enabled": true,
"name": "pause-key",
"value": "0",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"27": {
"id": 27,
"position": 27,
"enabled": true,
"name": "restart-key",
"value": "1",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"28": {
"id": 28,
"position": 28,
"enabled": true,
"name": "ff-key",
"value": "6",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"29": {
"id": 29,
"position": 29,
"enabled": true,
"name": "rew-key",
"value": "4",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"3": {
"id": 3,
"position": 3,
"enabled": true,
"name": "max-login-attempts",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"30": {
"id": 30,
"position": 30,
"enabled": true,
"name": "skip-greet-key",
"value": "#",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"31": {
"id": 31,
"position": 31,
"enabled": true,
"name": "previous-message-key",
"value": "1",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"32": {
"id": 32,
"position": 32,
"enabled": true,
"name": "next-message-key",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"33": {
"id": 33,
"position": 33,
"enabled": true,
"name": "skip-info-key",
"value": "*",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"34": {
"id": 34,
"position": 34,
"enabled": true,
"name": "repeat-message-key",
"value": "0",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"35": {
"id": 35,
"position": 35,
"enabled": true,
"name": "record-silence-threshold",
"value": "200",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"36": {
"id": 36,
"position": 36,
"enabled": true,
"name": "record-silence-hits",
"value": "2",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"37": {
"id": 37,
"position": 37,
"enabled": true,
"name": "web-template-file",
"value": "web-vm.tpl",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"38": {
"id": 38,
"position": 38,
"enabled": true,
"name": "db-password-override",
"value": "false",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"39": {
"id": 39,
"position": 39,
"enabled": true,
"name": "allow-empty-password-auth",
"value": "true",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"4": {
"id": 4,
"position": 4,
"enabled": true,
"name": "digit-timeout",
"value": "10000",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"40": {
"id": 40,
"position": 40,
"enabled": true,
"name": "operator-extension",
"value": "operator XML default",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"41": {
"id": 41,
"position": 41,
"enabled": true,
"name": "operator-key",
"value": "9",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"42": {
"id": 42,
"position": 42,
"enabled": true,
"name": "vmain-extension",
"value": "vmain XML default",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"43": {
"id": 43,
"position": 43,
"enabled": true,
"name": "vmain-key",
"value": "*",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"5": {
"id": 5,
"position": 5,
"enabled": true,
"name": "min-record-len",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"6": {
"id": 6,
"position": 6,
"enabled": true,
"name": "max-record-len",
"value": "300",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"7": {
"id": 7,
"position": 7,
"enabled": true,
"name": "max-retries",
"value": "3",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"8": {
"id": 8,
"position": 8,
"enabled": true,
"name": "tone-spec",
"value": "%(1000, 0, 640)",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
},
"9": {
"id": 9,
"position": 9,
"enabled": true,
"name": "callback-dialplan",
"value": "XML",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
}
Get Voicemail Profile Parameters.
Event value
GetVoicemailProfileParameters
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
AddVoicemailProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}'
exampleSocket.send('{"event":"AddVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","id":2,"param":{"name":"paramn","value":"paramv"}}}');
Returns JSON structured like this:
{
"MessageType": "AddVoicemailProfileParameter",
"data": {
"id": 48,
"position": 44,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Add Voicemail Profile Parameter.
Event value
AddVoicemailProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| param | Object | |
| - value | String | Item value |
| - name | String | Item name |
Errors
DelVoicemailProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":48}}}'
exampleSocket.send('{"event":"DelVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":48}}}');
Returns JSON structured like this:
{
"MessageType": "DelVoicemailProfileParameter",
"data": {
"id": 48,
"position": 44,
"enabled": true,
"name": "paramn",
"value": "paramv",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Del Voicemail Profile Parameter.
Event value
DelVoicemailProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
Errors
SwitchVoicemailProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":43,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":43,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchVoicemailProfileParameter",
"data": {
"id": 43,
"position": 43,
"enabled": false,
"name": "vmain-key",
"value": "*",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Switch Voicemail Profile Parameter.
Event value
SwitchVoicemailProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
UpdateVoicemailProfileParameter
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":43,"name":"vmain-key","value":"*"}}}'
exampleSocket.send('{"event":"UpdateVoicemailProfileParameter","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","param":{"id":43,"name":"vmain-key","value":"*"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateVoicemailProfileParameter",
"data": {
"id": 43,
"position": 43,
"enabled": true,
"name": "vmain-key",
"value": "*",
"description": "",
"parent": {
"id": 2,
"position": 0,
"enabled": false,
"name": "",
"description": "",
"parent": null
}
}
}
Update Voicemail Profile Parameter.
Event value
UpdateVoicemailProfileParameter
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| param | Object | |
| - name | String | Item name |
| - value | String | Item value |
| - id | Integer | Item ID. |
Errors
UpdateGlobalVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"UpdateGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":117,"dynamic":false,"name":"new_var2","value":"new_val2","type":"set"}}}'
exampleSocket.send('{"event":"UpdateGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":117,"dynamic":false,"name":"new_var2","value":"new_val2","type":"set"}}}');
Returns JSON structured like this:
{
"MessageType": "UpdateGlobalVariable",
"global_variables": {
"117": {
"id": 117,
"enabled": true,
"dynamic": false,
"name": "new_var2",
"value": "new_val2",
"type": "set",
"position": 114
}
}
}
Update Global Variable.
Event value
UpdateGlobalVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| variable | Object | |
| - value | String | Item value |
| - type | String | |
| - id | Integer | Item ID. |
| - dynamic | Boolean | |
| - name | String | Item name |
Errors
SwitchGlobalVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"SwitchGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":90,"enabled":false}}}'
exampleSocket.send('{"event":"SwitchGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":90,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "SwitchGlobalVariable",
"global_variables": {
"90": {
"id": 90,
"enabled": false,
"dynamic": false,
"name": "internal_sip_port",
"value": "5060",
"type": "set",
"position": 90
}
}
}
Switch Global Variable.
Event value
SwitchGlobalVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| variable | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
AddGlobalVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"AddGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"name":"new_var","value":"new_val","type":"set"}}}'
exampleSocket.send('{"event":"AddGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"name":"new_var","value":"new_val","type":"set"}}}');
Returns JSON structured like this:
{
"MessageType": "AddGlobalVariable",
"global_variables": {
"117": {
"id": 117,
"enabled": true,
"dynamic": false,
"name": "new_var",
"value": "new_val",
"type": "set",
"position": 114
}
}
}
Add Global Variable.
Event value
AddGlobalVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| variable | Object | |
| - type | String | |
| - name | String | Item name |
| - value | String | Item value |
Errors
DelGlobalVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DelGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":117}}}'
exampleSocket.send('{"event":"DelGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","variable":{"id":117}}}');
Returns JSON structured like this:
{
"MessageType": "DelGlobalVariable",
"id": 117
}
Del Global Variable.
Event value
DelGlobalVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| variable | Object | |
| - id | Integer | Item ID. |
Errors
MoveGlobalVariable
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"MoveGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":111,"current_index":108,"id":110}}'
exampleSocket.send('{"event":"MoveGlobalVariable","data":{"token":"3c2f3200f73699a28c96783a15dff1d7","previous_index":111,"current_index":108,"id":110}}');
Returns JSON structured like this:
{
"MessageType": "MoveGlobalVariable",
"global_variables": {
"1": {
"id": 1,
"enabled": true,
"dynamic": true,
"name": "hostname",
"value": "debian-05",
"type": "set",
"position": 1
},
"10": {
"id": 10,
"enabled": true,
"dynamic": true,
"name": "log_dir",
"value": "/var/log/freeswitch",
"type": "set",
"position": 10
},
"100": {
"id": 100,
"enabled": true,
"dynamic": false,
"name": "video_mute_png",
"value": "/var/lib/freeswitch/images/default-mute.png",
"type": "set",
"position": 100
},
"101": {
"id": 101,
"enabled": true,
"dynamic": false,
"name": "video_no_avatar_png",
"value": "/var/lib/freeswitch/images/default-avatar.png",
"type": "set",
"position": 101
},
"102": {
"id": 102,
"enabled": true,
"dynamic": false,
"name": "rtp_liberal_dtmf",
"value": "true",
"type": "set",
"position": 102
},
"103": {
"id": 103,
"enabled": true,
"dynamic": false,
"name": "AT_EPENT1",
"value": "0 0 0 -1 -1 0 -1 0 -1 -1 0 -1",
"type": "set",
"position": 103
},
"104": {
"id": 104,
"enabled": true,
"dynamic": false,
"name": "AT_EPENT2",
"value": "1 1 1 -1 -1 1 -1 1 -1 -1 1 -1",
"type": "set",
"position": 104
},
"105": {
"id": 105,
"enabled": true,
"dynamic": false,
"name": "AT_CPENT1",
"value": "0 -1 -1 0 -1 0 0 0 -1 -1 0 -1",
"type": "set",
"position": 105
},
"106": {
"id": 106,
"enabled": true,
"dynamic": false,
"name": "AT_CPENT2",
"value": "1 -1 -1 1 -1 1 1 1 -1 -1 1 -1",
"type": "set",
"position": 106
},
"107": {
"id": 107,
"enabled": true,
"dynamic": false,
"name": "AT_CMAJ1",
"value": "0 -1 0 0 -1 0 -1 0 0 -1 0 -1",
"type": "set",
"position": 107
},
"108": {
"id": 108,
"enabled": true,
"dynamic": false,
"name": "AT_CMAJ2",
"value": "1 -1 1 1 -1 1 -1 1 1 -1 1 -1",
"type": "set",
"position": 110
},
"109": {
"id": 109,
"enabled": true,
"dynamic": false,
"name": "AT_BBLUES",
"value": "1 -1 1 -1 -1 1 -1 1 1 1 -1 -1",
"type": "set",
"position": 111
},
"11": {
"id": 11,
"enabled": true,
"dynamic": true,
"name": "run_dir",
"value": "/var/run/freeswitch",
"type": "set",
"position": 11
},
"110": {
"id": 110,
"enabled": true,
"dynamic": false,
"name": "ATGPENT2",
"value": "-1 1 -1 1 -1 1 -1 -1 1 -1 1 -1",
"type": "set",
"position": 108
},
"111": {
"id": 111,
"enabled": true,
"dynamic": true,
"name": "zrtp_enabled",
"value": "false",
"type": "set",
"position": 112
},
"112": {
"id": 112,
"enabled": true,
"dynamic": true,
"name": "core_uuid",
"value": "set",
"type": "set",
"position": 113
},
"113": {
"id": 113,
"enabled": true,
"dynamic": false,
"name": "sfsdfsdf",
"value": "dsfcsdfsfsdfsd",
"type": "set",
"position": 109
},
"12": {
"id": 12,
"enabled": true,
"dynamic": true,
"name": "db_dir",
"value": "/var/lib/freeswitch/db",
"type": "set",
"position": 12
},
"13": {
"id": 13,
"enabled": true,
"dynamic": true,
"name": "mod_dir",
"value": "/usr/lib/freeswitch/mod",
"type": "set",
"position": 13
},
"14": {
"id": 14,
"enabled": true,
"dynamic": true,
"name": "htdocs_dir",
"value": "/usr/share/freeswitch/htdocs",
"type": "set",
"position": 14
},
"15": {
"id": 15,
"enabled": true,
"dynamic": true,
"name": "script_dir",
"value": "/usr/share/freeswitch/scripts",
"type": "set",
"position": 15
},
"16": {
"id": 16,
"enabled": true,
"dynamic": true,
"name": "temp_dir",
"value": "/tmp",
"type": "set",
"position": 16
},
"17": {
"id": 17,
"enabled": true,
"dynamic": true,
"name": "grammar_dir",
"value": "/usr/share/freeswitch/grammar",
"type": "set",
"position": 17
},
"18": {
"id": 18,
"enabled": true,
"dynamic": true,
"name": "certs_dir",
"value": "/etc/freeswitch/tls",
"type": "set",
"position": 18
},
"19": {
"id": 19,
"enabled": true,
"dynamic": true,
"name": "storage_dir",
"value": "/var/lib/freeswitch/storage",
"type": "set",
"position": 19
},
"2": {
"id": 2,
"enabled": true,
"dynamic": true,
"name": "local_ip_v4",
"value": "domain.com",
"type": "set",
"position": 2
},
"20": {
"id": 20,
"enabled": true,
"dynamic": true,
"name": "cache_dir",
"value": "/var/cache/freeswitch",
"type": "set",
"position": 20
},
"21": {
"id": 21,
"enabled": true,
"dynamic": true,
"name": "switch_serial",
"value": "2d3d364cd6cc",
"type": "set",
"position": 21
},
"22": {
"id": 22,
"enabled": true,
"dynamic": false,
"name": "fonts_dir",
"value": "/usr/share/freeswitch/fonts",
"type": "set",
"position": 22
},
"23": {
"id": 23,
"enabled": true,
"dynamic": false,
"name": "images_dir",
"value": "/var/lib/freeswitch/images",
"type": "set",
"position": 23
},
"24": {
"id": 24,
"enabled": true,
"dynamic": false,
"name": "data_dir",
"value": "/usr/share/freeswitch",
"type": "set",
"position": 24
},
"25": {
"id": 25,
"enabled": true,
"dynamic": false,
"name": "localstate_dir",
"value": "/var/lib/freeswitch",
"type": "set",
"position": 25
},
"26": {
"id": 26,
"enabled": true,
"dynamic": false,
"name": "default_password",
"value": "12345asdqwe123asd213fsfd3qrsd3qrrfd32rffd5uhr6",
"type": "set",
"position": 26
},
"27": {
"id": 27,
"enabled": true,
"dynamic": false,
"name": "domain",
"value": "domain.com",
"type": "set",
"position": 27
},
"28": {
"id": 28,
"enabled": true,
"dynamic": false,
"name": "domain_name",
"value": "domain.com",
"type": "set",
"position": 28
},
"29": {
"id": 29,
"enabled": true,
"dynamic": false,
"name": "hold_music",
"value": "local_stream://moh",
"type": "set",
"position": 29
},
"3": {
"id": 3,
"enabled": true,
"dynamic": true,
"name": "local_mask_v4",
"value": "255.255.255.0",
"type": "set",
"position": 3
},
"30": {
"id": 30,
"enabled": true,
"dynamic": false,
"name": "use_profile",
"value": "external",
"type": "set",
"position": 30
},
"31": {
"id": 31,
"enabled": true,
"dynamic": false,
"name": "rtp_sdes_suites",
"value": "AEAD_AES_256_GCM_8|AEAD_AES_128_GCM_8|AES_CM_256_HMAC_SHA1_80|AES_CM_192_HMAC_SHA1_80|AES_CM_128_HMAC_SHA1_80|AES_CM_256_HMAC_SHA1_32|AES_CM_192_HMAC_SHA1_32|AES_CM_128_HMAC_SHA1_32|AES_CM_128_NULL_AUTH",
"type": "set",
"position": 31
},
"32": {
"id": 32,
"enabled": true,
"dynamic": false,
"name": "zrtp_secure_media",
"value": "true",
"type": "set",
"position": 32
},
"33": {
"id": 33,
"enabled": true,
"dynamic": false,
"name": "global_codec_prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"type": "set",
"position": 33
},
"34": {
"id": 34,
"enabled": true,
"dynamic": false,
"name": "outbound_codec_prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"type": "set",
"position": 34
},
"35": {
"id": 35,
"enabled": true,
"dynamic": false,
"name": "xmpp_client_profile",
"value": "xmppc",
"type": "set",
"position": 35
},
"36": {
"id": 36,
"enabled": true,
"dynamic": false,
"name": "xmpp_server_profile",
"value": "xmpps",
"type": "set",
"position": 36
},
"37": {
"id": 37,
"enabled": true,
"dynamic": false,
"name": "bind_server_ip",
"value": "auto",
"type": "set",
"position": 37
},
"38": {
"id": 38,
"enabled": true,
"dynamic": false,
"name": "external_rtp_ip",
"value": "domain.com",
"type": "set",
"position": 38
},
"39": {
"id": 39,
"enabled": true,
"dynamic": false,
"name": "external_sip_ip",
"value": "domain.com",
"type": "set",
"position": 39
},
"4": {
"id": 4,
"enabled": true,
"dynamic": true,
"name": "local_ip_v6",
"value": "::1",
"type": "set",
"position": 4
},
"40": {
"id": 40,
"enabled": true,
"dynamic": false,
"name": "unroll_loops",
"value": "true",
"type": "set",
"position": 40
},
"41": {
"id": 41,
"enabled": true,
"dynamic": false,
"name": "outbound_caller_name",
"value": "FreeSWITCH",
"type": "set",
"position": 41
},
"42": {
"id": 42,
"enabled": true,
"dynamic": false,
"name": "outbound_caller_id",
"value": "0000000000",
"type": "set",
"position": 42
},
"43": {
"id": 43,
"enabled": true,
"dynamic": false,
"name": "call_debug",
"value": "false",
"type": "set",
"position": 43
},
"44": {
"id": 44,
"enabled": true,
"dynamic": false,
"name": "console_loglevel",
"value": "info",
"type": "set",
"position": 44
},
"45": {
"id": 45,
"enabled": true,
"dynamic": false,
"name": "default_areacode",
"value": "918",
"type": "set",
"position": 45
},
"46": {
"id": 46,
"enabled": true,
"dynamic": false,
"name": "default_country",
"value": "US",
"type": "set",
"position": 46
},
"47": {
"id": 47,
"enabled": true,
"dynamic": false,
"name": "presence_privacy",
"value": "false",
"type": "set",
"position": 47
},
"48": {
"id": 48,
"enabled": true,
"dynamic": false,
"name": "au-ring",
"value": "%(400,200,383,417);%(400,2000,383,417)",
"type": "set",
"position": 48
},
"49": {
"id": 49,
"enabled": true,
"dynamic": false,
"name": "be-ring",
"value": "%(1000,3000,425)",
"type": "set",
"position": 49
},
"5": {
"id": 5,
"enabled": true,
"dynamic": true,
"name": "base_dir",
"value": "/usr",
"type": "set",
"position": 5
},
"50": {
"id": 50,
"enabled": true,
"dynamic": false,
"name": "ca-ring",
"value": "%(2000,4000,440,480)",
"type": "set",
"position": 50
},
"51": {
"id": 51,
"enabled": true,
"dynamic": false,
"name": "cn-ring",
"value": "%(1000,4000,450)",
"type": "set",
"position": 51
},
"52": {
"id": 52,
"enabled": true,
"dynamic": false,
"name": "cy-ring",
"value": "%(1500,3000,425)",
"type": "set",
"position": 52
},
"53": {
"id": 53,
"enabled": true,
"dynamic": false,
"name": "cz-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 53
},
"54": {
"id": 54,
"enabled": true,
"dynamic": false,
"name": "de-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 54
},
"55": {
"id": 55,
"enabled": true,
"dynamic": false,
"name": "dk-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 55
},
"56": {
"id": 56,
"enabled": true,
"dynamic": false,
"name": "dz-ring",
"value": "%(1500,3500,425)",
"type": "set",
"position": 56
},
"57": {
"id": 57,
"enabled": true,
"dynamic": false,
"name": "eg-ring",
"value": "%(2000,1000,475,375)",
"type": "set",
"position": 57
},
"58": {
"id": 58,
"enabled": true,
"dynamic": false,
"name": "es-ring",
"value": "%(1500,3000,425)",
"type": "set",
"position": 58
},
"59": {
"id": 59,
"enabled": true,
"dynamic": false,
"name": "fi-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 59
},
"6": {
"id": 6,
"enabled": true,
"dynamic": true,
"name": "recordings_dir",
"value": "/var/lib/freeswitch/recordings",
"type": "set",
"position": 6
},
"60": {
"id": 60,
"enabled": true,
"dynamic": false,
"name": "fr-ring",
"value": "%(1500,3500,440)",
"type": "set",
"position": 60
},
"61": {
"id": 61,
"enabled": true,
"dynamic": false,
"name": "hk-ring",
"value": "%(400,200,440,480);%(400,3000,440,480)",
"type": "set",
"position": 61
},
"62": {
"id": 62,
"enabled": true,
"dynamic": false,
"name": "hu-ring",
"value": "%(1250,3750,425)",
"type": "set",
"position": 62
},
"63": {
"id": 63,
"enabled": true,
"dynamic": false,
"name": "il-ring",
"value": "%(1000,3000,400)",
"type": "set",
"position": 63
},
"64": {
"id": 64,
"enabled": true,
"dynamic": false,
"name": "in-ring",
"value": "%(400,200,425,375);%(400,2000,425,375)",
"type": "set",
"position": 64
},
"65": {
"id": 65,
"enabled": true,
"dynamic": false,
"name": "jp-ring",
"value": "%(1000,2000,420,380)",
"type": "set",
"position": 65
},
"66": {
"id": 66,
"enabled": true,
"dynamic": false,
"name": "ko-ring",
"value": "%(1000,2000,440,480)",
"type": "set",
"position": 66
},
"67": {
"id": 67,
"enabled": true,
"dynamic": false,
"name": "pk-ring",
"value": "%(1000,2000,400)",
"type": "set",
"position": 67
},
"68": {
"id": 68,
"enabled": true,
"dynamic": false,
"name": "pl-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 68
},
"69": {
"id": 69,
"enabled": true,
"dynamic": false,
"name": "ro-ring",
"value": "%(1850,4150,475,425)",
"type": "set",
"position": 69
},
"7": {
"id": 7,
"enabled": true,
"dynamic": true,
"name": "sound_prefix",
"value": "/usr/share/freeswitch/sounds",
"type": "set",
"position": 7
},
"70": {
"id": 70,
"enabled": true,
"dynamic": false,
"name": "rs-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 70
},
"71": {
"id": 71,
"enabled": true,
"dynamic": false,
"name": "ru-ring",
"value": "%(800,3200,425)",
"type": "set",
"position": 71
},
"72": {
"id": 72,
"enabled": true,
"dynamic": false,
"name": "sa-ring",
"value": "%(1200,4600,425)",
"type": "set",
"position": 72
},
"73": {
"id": 73,
"enabled": true,
"dynamic": false,
"name": "tr-ring",
"value": "%(2000,4000,450)",
"type": "set",
"position": 73
},
"74": {
"id": 74,
"enabled": true,
"dynamic": false,
"name": "uk-ring",
"value": "%(400,200,400,450);%(400,2000,400,450)",
"type": "set",
"position": 74
},
"75": {
"id": 75,
"enabled": true,
"dynamic": false,
"name": "us-ring",
"value": "%(2000,4000,440,480)",
"type": "set",
"position": 75
},
"76": {
"id": 76,
"enabled": true,
"dynamic": false,
"name": "bong-ring",
"value": "v",
"type": "set",
"position": 76
},
"77": {
"id": 77,
"enabled": true,
"dynamic": false,
"name": "beep",
"value": "%(1000,0,640)",
"type": "set",
"position": 77
},
"78": {
"id": 78,
"enabled": true,
"dynamic": false,
"name": "sit",
"value": "%(274,0,913.8);%(274,0,1370.6);%(380,0,1776.7)",
"type": "set",
"position": 78
},
"79": {
"id": 79,
"enabled": true,
"dynamic": false,
"name": "df_us_ssn",
"value": "(?!219099999|078051120)(?!666|000|9\\d{2})\\d{3}(?!00)\\d{2}(?!0{4})\\d{4}",
"type": "set",
"position": 79
},
"8": {
"id": 8,
"enabled": true,
"dynamic": true,
"name": "sounds_dir",
"value": "/usr/share/freeswitch/sounds",
"type": "set",
"position": 8
},
"80": {
"id": 80,
"enabled": true,
"dynamic": false,
"name": "df_luhn",
"value": "?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|6(?:011|5[0-9]{2})[0-9]{12}|(?:2131|1800|35\\d{3})\\d{11}",
"type": "set",
"position": 80
},
"81": {
"id": 81,
"enabled": true,
"dynamic": false,
"name": "default_provider",
"value": "example.com",
"type": "set",
"position": 81
},
"82": {
"id": 82,
"enabled": true,
"dynamic": false,
"name": "default_provider_username",
"value": "joeuser",
"type": "set",
"position": 82
},
"83": {
"id": 83,
"enabled": true,
"dynamic": false,
"name": "default_provider_password",
"value": "password",
"type": "set",
"position": 83
},
"84": {
"id": 84,
"enabled": true,
"dynamic": false,
"name": "default_provider_from_domain",
"value": "example.com",
"type": "set",
"position": 84
},
"85": {
"id": 85,
"enabled": true,
"dynamic": false,
"name": "default_provider_register",
"value": "false",
"type": "set",
"position": 85
},
"86": {
"id": 86,
"enabled": true,
"dynamic": false,
"name": "default_provider_contact",
"value": "5000",
"type": "set",
"position": 86
},
"87": {
"id": 87,
"enabled": true,
"dynamic": false,
"name": "sip_tls_version",
"value": "tlsv1,tlsv1.1,tlsv1.2",
"type": "set",
"position": 87
},
"88": {
"id": 88,
"enabled": true,
"dynamic": false,
"name": "sip_tls_ciphers",
"value": "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
"type": "set",
"position": 88
},
"89": {
"id": 89,
"enabled": true,
"dynamic": false,
"name": "internal_auth_calls",
"value": "true",
"type": "set",
"position": 89
},
"9": {
"id": 9,
"enabled": true,
"dynamic": true,
"name": "conf_dir",
"value": "/etc/freeswitch",
"type": "set",
"position": 9
},
"90": {
"id": 90,
"enabled": true,
"dynamic": false,
"name": "internal_sip_port",
"value": "5060",
"type": "set",
"position": 90
},
"91": {
"id": 91,
"enabled": true,
"dynamic": false,
"name": "internal_tls_port",
"value": "5061",
"type": "set",
"position": 91
},
"92": {
"id": 92,
"enabled": true,
"dynamic": false,
"name": "internal_ssl_enable",
"value": "false",
"type": "set",
"position": 92
},
"93": {
"id": 93,
"enabled": true,
"dynamic": false,
"name": "external_auth_calls",
"value": "false",
"type": "set",
"position": 93
},
"94": {
"id": 94,
"enabled": true,
"dynamic": false,
"name": "external_sip_port",
"value": "5080",
"type": "set",
"position": 94
},
"95": {
"id": 95,
"enabled": true,
"dynamic": false,
"name": "external_tls_port",
"value": "5081",
"type": "set",
"position": 95
},
"96": {
"id": 96,
"enabled": true,
"dynamic": false,
"name": "external_ssl_enable",
"value": "false",
"type": "set",
"position": 96
},
"97": {
"id": 97,
"enabled": true,
"dynamic": false,
"name": "rtp_video_max_bandwidth_in",
"value": "3mb",
"type": "set",
"position": 97
},
"98": {
"id": 98,
"enabled": true,
"dynamic": false,
"name": "rtp_video_max_bandwidth_out",
"value": "3mb",
"type": "set",
"position": 98
},
"99": {
"id": 99,
"enabled": true,
"dynamic": false,
"name": "suppress_cng",
"value": "true",
"type": "set",
"position": 99
}
}
}
Move Global Variable.
Event value
MoveGlobalVariable
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer | |
| id | Integer | Item ID. |
Errors
ImportGlobalVariables
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"ImportGlobalVariables","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}'
exampleSocket.send('{"event":"ImportGlobalVariables","data":{"token":"3c2f3200f73699a28c96783a15dff1d7"}}');
Returns JSON structured like this:
{
"MessageType": "ImportGlobalVariables",
"global_variables": {
"1": {
"id": 1,
"enabled": true,
"dynamic": true,
"name": "hostname",
"value": "debian-05",
"type": "set",
"position": 1
},
"10": {
"id": 10,
"enabled": true,
"dynamic": true,
"name": "log_dir",
"value": "/var/log/freeswitch",
"type": "set",
"position": 10
},
"100": {
"id": 100,
"enabled": true,
"dynamic": false,
"name": "video_no_avatar_png",
"value": "/var/lib/freeswitch/images/default-avatar.png",
"type": "set",
"position": 100
},
"101": {
"id": 101,
"enabled": true,
"dynamic": false,
"name": "rtp_liberal_dtmf",
"value": "true",
"type": "set",
"position": 101
},
"102": {
"id": 102,
"enabled": true,
"dynamic": false,
"name": "sfsdfsdf",
"value": "dsfcsdfsfsdfsd",
"type": "set",
"position": 102
},
"103": {
"id": 103,
"enabled": true,
"dynamic": false,
"name": "AT_EPENT1",
"value": "0 0 0 -1 -1 0 -1 0 -1 -1 0 -1",
"type": "set",
"position": 103
},
"104": {
"id": 104,
"enabled": true,
"dynamic": false,
"name": "AT_EPENT2",
"value": "1 1 1 -1 -1 1 -1 1 -1 -1 1 -1",
"type": "set",
"position": 104
},
"105": {
"id": 105,
"enabled": true,
"dynamic": false,
"name": "AT_CPENT1",
"value": "0 -1 -1 0 -1 0 0 0 -1 -1 0 -1",
"type": "set",
"position": 105
},
"106": {
"id": 106,
"enabled": true,
"dynamic": false,
"name": "AT_CPENT2",
"value": "1 -1 -1 1 -1 1 1 1 -1 -1 1 -1",
"type": "set",
"position": 106
},
"107": {
"id": 107,
"enabled": true,
"dynamic": false,
"name": "AT_CMAJ1",
"value": "0 -1 0 0 -1 0 -1 0 0 -1 0 -1",
"type": "set",
"position": 107
},
"108": {
"id": 108,
"enabled": true,
"dynamic": false,
"name": "AT_CMAJ2",
"value": "1 -1 1 1 -1 1 -1 1 1 -1 1 -1",
"type": "set",
"position": 108
},
"109": {
"id": 109,
"enabled": true,
"dynamic": false,
"name": "AT_BBLUES",
"value": "1 -1 1 -1 -1 1 -1 1 1 1 -1 -1",
"type": "set",
"position": 109
},
"11": {
"id": 11,
"enabled": true,
"dynamic": true,
"name": "run_dir",
"value": "/var/run/freeswitch",
"type": "set",
"position": 11
},
"110": {
"id": 110,
"enabled": true,
"dynamic": false,
"name": "ATGPENT2",
"value": "-1 1 -1 1 -1 1 -1 -1 1 -1 1 -1",
"type": "set",
"position": 110
},
"111": {
"id": 111,
"enabled": true,
"dynamic": true,
"name": "core_uuid",
"value": "4ee847e9-b9fb-49a8-99be-11e42a8cfdd4",
"type": "set",
"position": 111
},
"112": {
"id": 112,
"enabled": true,
"dynamic": true,
"name": "zrtp_enabled",
"value": "false",
"type": "set",
"position": 112
},
"113": {
"id": 113,
"enabled": true,
"dynamic": false,
"name": "internal_sip_port",
"value": "5060",
"type": "set",
"position": 113
},
"12": {
"id": 12,
"enabled": true,
"dynamic": true,
"name": "db_dir",
"value": "/var/lib/freeswitch/db",
"type": "set",
"position": 12
},
"13": {
"id": 13,
"enabled": true,
"dynamic": true,
"name": "mod_dir",
"value": "/usr/lib/freeswitch/mod",
"type": "set",
"position": 13
},
"14": {
"id": 14,
"enabled": true,
"dynamic": true,
"name": "htdocs_dir",
"value": "/usr/share/freeswitch/htdocs",
"type": "set",
"position": 14
},
"15": {
"id": 15,
"enabled": true,
"dynamic": true,
"name": "script_dir",
"value": "/usr/share/freeswitch/scripts",
"type": "set",
"position": 15
},
"16": {
"id": 16,
"enabled": true,
"dynamic": true,
"name": "temp_dir",
"value": "/tmp",
"type": "set",
"position": 16
},
"17": {
"id": 17,
"enabled": true,
"dynamic": true,
"name": "grammar_dir",
"value": "/usr/share/freeswitch/grammar",
"type": "set",
"position": 17
},
"18": {
"id": 18,
"enabled": true,
"dynamic": true,
"name": "certs_dir",
"value": "/etc/freeswitch/tls",
"type": "set",
"position": 18
},
"19": {
"id": 19,
"enabled": true,
"dynamic": true,
"name": "storage_dir",
"value": "/var/lib/freeswitch/storage",
"type": "set",
"position": 19
},
"2": {
"id": 2,
"enabled": true,
"dynamic": true,
"name": "local_ip_v4",
"value": "domain.com",
"type": "set",
"position": 2
},
"20": {
"id": 20,
"enabled": true,
"dynamic": true,
"name": "cache_dir",
"value": "/var/cache/freeswitch",
"type": "set",
"position": 20
},
"21": {
"id": 21,
"enabled": true,
"dynamic": true,
"name": "switch_serial",
"value": "2d3d364cd6cc",
"type": "set",
"position": 21
},
"22": {
"id": 22,
"enabled": true,
"dynamic": false,
"name": "fonts_dir",
"value": "/usr/share/freeswitch/fonts",
"type": "set",
"position": 22
},
"23": {
"id": 23,
"enabled": true,
"dynamic": false,
"name": "images_dir",
"value": "/var/lib/freeswitch/images",
"type": "set",
"position": 23
},
"24": {
"id": 24,
"enabled": true,
"dynamic": false,
"name": "data_dir",
"value": "/usr/share/freeswitch",
"type": "set",
"position": 24
},
"25": {
"id": 25,
"enabled": true,
"dynamic": false,
"name": "localstate_dir",
"value": "/var/lib/freeswitch",
"type": "set",
"position": 25
},
"26": {
"id": 26,
"enabled": true,
"dynamic": false,
"name": "default_password",
"value": "12345asdqwe123asd213fsfd3qrsd3qrrfd32rffd5uhr6",
"type": "set",
"position": 26
},
"27": {
"id": 27,
"enabled": true,
"dynamic": false,
"name": "domain",
"value": "domain.com",
"type": "set",
"position": 27
},
"28": {
"id": 28,
"enabled": true,
"dynamic": false,
"name": "domain_name",
"value": "domain.com",
"type": "set",
"position": 28
},
"29": {
"id": 29,
"enabled": true,
"dynamic": false,
"name": "hold_music",
"value": "local_stream://moh",
"type": "set",
"position": 29
},
"3": {
"id": 3,
"enabled": true,
"dynamic": true,
"name": "local_mask_v4",
"value": "255.255.255.0",
"type": "set",
"position": 3
},
"30": {
"id": 30,
"enabled": true,
"dynamic": false,
"name": "use_profile",
"value": "external",
"type": "set",
"position": 30
},
"31": {
"id": 31,
"enabled": true,
"dynamic": false,
"name": "rtp_sdes_suites",
"value": "AEAD_AES_256_GCM_8|AEAD_AES_128_GCM_8|AES_CM_256_HMAC_SHA1_80|AES_CM_192_HMAC_SHA1_80|AES_CM_128_HMAC_SHA1_80|AES_CM_256_HMAC_SHA1_32|AES_CM_192_HMAC_SHA1_32|AES_CM_128_HMAC_SHA1_32|AES_CM_128_NULL_AUTH",
"type": "set",
"position": 31
},
"32": {
"id": 32,
"enabled": true,
"dynamic": false,
"name": "zrtp_secure_media",
"value": "true",
"type": "set",
"position": 32
},
"33": {
"id": 33,
"enabled": true,
"dynamic": false,
"name": "global_codec_prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"type": "set",
"position": 33
},
"34": {
"id": 34,
"enabled": true,
"dynamic": false,
"name": "outbound_codec_prefs",
"value": "OPUS,G722,PCMU,PCMA,H264,VP8",
"type": "set",
"position": 34
},
"35": {
"id": 35,
"enabled": true,
"dynamic": false,
"name": "xmpp_client_profile",
"value": "xmppc",
"type": "set",
"position": 35
},
"36": {
"id": 36,
"enabled": true,
"dynamic": false,
"name": "xmpp_server_profile",
"value": "xmpps",
"type": "set",
"position": 36
},
"37": {
"id": 37,
"enabled": true,
"dynamic": false,
"name": "bind_server_ip",
"value": "auto",
"type": "set",
"position": 37
},
"38": {
"id": 38,
"enabled": true,
"dynamic": false,
"name": "external_rtp_ip",
"value": "domain.com",
"type": "set",
"position": 38
},
"39": {
"id": 39,
"enabled": true,
"dynamic": false,
"name": "external_sip_ip",
"value": "domain.com",
"type": "set",
"position": 39
},
"4": {
"id": 4,
"enabled": true,
"dynamic": true,
"name": "local_ip_v6",
"value": "::1",
"type": "set",
"position": 4
},
"40": {
"id": 40,
"enabled": true,
"dynamic": false,
"name": "unroll_loops",
"value": "true",
"type": "set",
"position": 40
},
"41": {
"id": 41,
"enabled": true,
"dynamic": false,
"name": "outbound_caller_name",
"value": "FreeSWITCH",
"type": "set",
"position": 41
},
"42": {
"id": 42,
"enabled": true,
"dynamic": false,
"name": "outbound_caller_id",
"value": "0000000000",
"type": "set",
"position": 42
},
"43": {
"id": 43,
"enabled": true,
"dynamic": false,
"name": "call_debug",
"value": "false",
"type": "set",
"position": 43
},
"44": {
"id": 44,
"enabled": true,
"dynamic": false,
"name": "console_loglevel",
"value": "info",
"type": "set",
"position": 44
},
"45": {
"id": 45,
"enabled": true,
"dynamic": false,
"name": "default_areacode",
"value": "918",
"type": "set",
"position": 45
},
"46": {
"id": 46,
"enabled": true,
"dynamic": false,
"name": "default_country",
"value": "US",
"type": "set",
"position": 46
},
"47": {
"id": 47,
"enabled": true,
"dynamic": false,
"name": "presence_privacy",
"value": "false",
"type": "set",
"position": 47
},
"48": {
"id": 48,
"enabled": true,
"dynamic": false,
"name": "au-ring",
"value": "%(400,200,383,417);%(400,2000,383,417)",
"type": "set",
"position": 48
},
"49": {
"id": 49,
"enabled": true,
"dynamic": false,
"name": "be-ring",
"value": "%(1000,3000,425)",
"type": "set",
"position": 49
},
"5": {
"id": 5,
"enabled": true,
"dynamic": true,
"name": "base_dir",
"value": "/usr",
"type": "set",
"position": 5
},
"50": {
"id": 50,
"enabled": true,
"dynamic": false,
"name": "ca-ring",
"value": "%(2000,4000,440,480)",
"type": "set",
"position": 50
},
"51": {
"id": 51,
"enabled": true,
"dynamic": false,
"name": "cn-ring",
"value": "%(1000,4000,450)",
"type": "set",
"position": 51
},
"52": {
"id": 52,
"enabled": true,
"dynamic": false,
"name": "cy-ring",
"value": "%(1500,3000,425)",
"type": "set",
"position": 52
},
"53": {
"id": 53,
"enabled": true,
"dynamic": false,
"name": "cz-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 53
},
"54": {
"id": 54,
"enabled": true,
"dynamic": false,
"name": "de-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 54
},
"55": {
"id": 55,
"enabled": true,
"dynamic": false,
"name": "dk-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 55
},
"56": {
"id": 56,
"enabled": true,
"dynamic": false,
"name": "dz-ring",
"value": "%(1500,3500,425)",
"type": "set",
"position": 56
},
"57": {
"id": 57,
"enabled": true,
"dynamic": false,
"name": "eg-ring",
"value": "%(2000,1000,475,375)",
"type": "set",
"position": 57
},
"58": {
"id": 58,
"enabled": true,
"dynamic": false,
"name": "es-ring",
"value": "%(1500,3000,425)",
"type": "set",
"position": 58
},
"59": {
"id": 59,
"enabled": true,
"dynamic": false,
"name": "fi-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 59
},
"6": {
"id": 6,
"enabled": true,
"dynamic": true,
"name": "recordings_dir",
"value": "/var/lib/freeswitch/recordings",
"type": "set",
"position": 6
},
"60": {
"id": 60,
"enabled": true,
"dynamic": false,
"name": "fr-ring",
"value": "%(1500,3500,440)",
"type": "set",
"position": 60
},
"61": {
"id": 61,
"enabled": true,
"dynamic": false,
"name": "hk-ring",
"value": "%(400,200,440,480);%(400,3000,440,480)",
"type": "set",
"position": 61
},
"62": {
"id": 62,
"enabled": true,
"dynamic": false,
"name": "hu-ring",
"value": "%(1250,3750,425)",
"type": "set",
"position": 62
},
"63": {
"id": 63,
"enabled": true,
"dynamic": false,
"name": "il-ring",
"value": "%(1000,3000,400)",
"type": "set",
"position": 63
},
"64": {
"id": 64,
"enabled": true,
"dynamic": false,
"name": "in-ring",
"value": "%(400,200,425,375);%(400,2000,425,375)",
"type": "set",
"position": 64
},
"65": {
"id": 65,
"enabled": true,
"dynamic": false,
"name": "jp-ring",
"value": "%(1000,2000,420,380)",
"type": "set",
"position": 65
},
"66": {
"id": 66,
"enabled": true,
"dynamic": false,
"name": "ko-ring",
"value": "%(1000,2000,440,480)",
"type": "set",
"position": 66
},
"67": {
"id": 67,
"enabled": true,
"dynamic": false,
"name": "pk-ring",
"value": "%(1000,2000,400)",
"type": "set",
"position": 67
},
"68": {
"id": 68,
"enabled": true,
"dynamic": false,
"name": "pl-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 68
},
"69": {
"id": 69,
"enabled": true,
"dynamic": false,
"name": "ro-ring",
"value": "%(1850,4150,475,425)",
"type": "set",
"position": 69
},
"7": {
"id": 7,
"enabled": true,
"dynamic": true,
"name": "sound_prefix",
"value": "/usr/share/freeswitch/sounds",
"type": "set",
"position": 7
},
"70": {
"id": 70,
"enabled": true,
"dynamic": false,
"name": "rs-ring",
"value": "%(1000,4000,425)",
"type": "set",
"position": 70
},
"71": {
"id": 71,
"enabled": true,
"dynamic": false,
"name": "ru-ring",
"value": "%(800,3200,425)",
"type": "set",
"position": 71
},
"72": {
"id": 72,
"enabled": true,
"dynamic": false,
"name": "sa-ring",
"value": "%(1200,4600,425)",
"type": "set",
"position": 72
},
"73": {
"id": 73,
"enabled": true,
"dynamic": false,
"name": "tr-ring",
"value": "%(2000,4000,450)",
"type": "set",
"position": 73
},
"74": {
"id": 74,
"enabled": true,
"dynamic": false,
"name": "uk-ring",
"value": "%(400,200,400,450);%(400,2000,400,450)",
"type": "set",
"position": 74
},
"75": {
"id": 75,
"enabled": true,
"dynamic": false,
"name": "us-ring",
"value": "%(2000,4000,440,480)",
"type": "set",
"position": 75
},
"76": {
"id": 76,
"enabled": true,
"dynamic": false,
"name": "bong-ring",
"value": "v",
"type": "set",
"position": 76
},
"77": {
"id": 77,
"enabled": true,
"dynamic": false,
"name": "beep",
"value": "%(1000,0,640)",
"type": "set",
"position": 77
},
"78": {
"id": 78,
"enabled": true,
"dynamic": false,
"name": "sit",
"value": "%(274,0,913.8);%(274,0,1370.6);%(380,0,1776.7)",
"type": "set",
"position": 78
},
"79": {
"id": 79,
"enabled": true,
"dynamic": false,
"name": "df_us_ssn",
"value": "(?!219099999|078051120)(?!666|000|9\\d{2})\\d{3}(?!00)\\d{2}(?!0{4})\\d{4}",
"type": "set",
"position": 79
},
"8": {
"id": 8,
"enabled": true,
"dynamic": true,
"name": "sounds_dir",
"value": "/usr/share/freeswitch/sounds",
"type": "set",
"position": 8
},
"80": {
"id": 80,
"enabled": true,
"dynamic": false,
"name": "df_luhn",
"value": "?:4[0-9]{12}(?:[0-9]{3})?|5[1-5][0-9]{14}|3[47][0-9]{13}|3(?:0[0-5]|[68][0-9])[0-9]{11}|6(?:011|5[0-9]{2})[0-9]{12}|(?:2131|1800|35\\d{3})\\d{11}",
"type": "set",
"position": 80
},
"81": {
"id": 81,
"enabled": true,
"dynamic": false,
"name": "default_provider",
"value": "example.com",
"type": "set",
"position": 81
},
"82": {
"id": 82,
"enabled": true,
"dynamic": false,
"name": "default_provider_username",
"value": "joeuser",
"type": "set",
"position": 82
},
"83": {
"id": 83,
"enabled": true,
"dynamic": false,
"name": "default_provider_password",
"value": "password",
"type": "set",
"position": 83
},
"84": {
"id": 84,
"enabled": true,
"dynamic": false,
"name": "default_provider_from_domain",
"value": "example.com",
"type": "set",
"position": 84
},
"85": {
"id": 85,
"enabled": true,
"dynamic": false,
"name": "default_provider_register",
"value": "false",
"type": "set",
"position": 85
},
"86": {
"id": 86,
"enabled": true,
"dynamic": false,
"name": "default_provider_contact",
"value": "5000",
"type": "set",
"position": 86
},
"87": {
"id": 87,
"enabled": true,
"dynamic": false,
"name": "sip_tls_version",
"value": "tlsv1,tlsv1.1,tlsv1.2",
"type": "set",
"position": 87
},
"88": {
"id": 88,
"enabled": true,
"dynamic": false,
"name": "sip_tls_ciphers",
"value": "ALL:!ADH:!LOW:!EXP:!MD5:@STRENGTH",
"type": "set",
"position": 88
},
"89": {
"id": 89,
"enabled": true,
"dynamic": false,
"name": "internal_auth_calls",
"value": "true",
"type": "set",
"position": 89
},
"9": {
"id": 9,
"enabled": true,
"dynamic": true,
"name": "conf_dir",
"value": "/etc/freeswitch",
"type": "set",
"position": 9
},
"90": {
"id": 90,
"enabled": true,
"dynamic": false,
"name": "internal_tls_port",
"value": "5061",
"type": "set",
"position": 90
},
"91": {
"id": 91,
"enabled": true,
"dynamic": false,
"name": "internal_ssl_enable",
"value": "false",
"type": "set",
"position": 91
},
"92": {
"id": 92,
"enabled": true,
"dynamic": false,
"name": "external_auth_calls",
"value": "false",
"type": "set",
"position": 92
},
"93": {
"id": 93,
"enabled": true,
"dynamic": false,
"name": "external_sip_port",
"value": "5080",
"type": "set",
"position": 93
},
"94": {
"id": 94,
"enabled": true,
"dynamic": false,
"name": "external_tls_port",
"value": "5081",
"type": "set",
"position": 94
},
"95": {
"id": 95,
"enabled": true,
"dynamic": false,
"name": "external_ssl_enable",
"value": "false",
"type": "set",
"position": 95
},
"96": {
"id": 96,
"enabled": true,
"dynamic": false,
"name": "rtp_video_max_bandwidth_in",
"value": "3mb",
"type": "set",
"position": 96
},
"97": {
"id": 97,
"enabled": true,
"dynamic": false,
"name": "rtp_video_max_bandwidth_out",
"value": "3mb",
"type": "set",
"position": 97
},
"98": {
"id": 98,
"enabled": true,
"dynamic": false,
"name": "suppress_cng",
"value": "true",
"type": "set",
"position": 98
},
"99": {
"id": 99,
"enabled": true,
"dynamic": false,
"name": "video_mute_png",
"value": "/var/lib/freeswitch/images/default-mute.png",
"type": "set",
"position": 99
}
}
}
Import Global Variables.
Event value
ImportGlobalVariables
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
Dialplan
Contexts
Disable/Enable static dialplan
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"DialplanChangeNotProceed","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","enabled":true}}'
exampleSocket.send('{"event":"DialplanChangeNotProceed","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","enabled":true}}');
Returns JSON structured like this:
{
"MessageType": "DialplanChangeNotProceed",
"dialplan_settings": {
"no_proceed": true,
"enable_debug": false
}
}
Disable/Enable proceeding dialplan at custompbx side (generate xml with only actions from matched conditions or return full xml context).
Event value
DialplanChangeNotProceed
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| enabled | Boolean | Enabled/Disabled status of item. |
Errors
Get Contexts List
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Get] Contexts","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb"}}'
exampleSocket.send('{"event":"[Dialplan][Get] Contexts","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb"}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Get] Contexts",
"dialplan_contexts": {
"16": {
"id": 16,
"enabled": true,
"name": "default"
},
"18": {
"id": 18,
"enabled": true,
"name": "features"
},
"19": {
"id": 19,
"enabled": true,
"name": "public"
},
"20": {
"id": 20,
"enabled": true,
"name": "skinny-patterns"
}
}
}
Returns list of сontexts.
Event value
[Dialplan][Get] Contexts
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
Errors
Add Context
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Add] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","name":"new-context"}}'
exampleSocket.send('{"event":"[Dialplan][Add] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","name":"new-context"}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Add] Context",
"dialplan_contexts": {
"21": {
"id": 21,
"enabled": true,
"name": "new-context"
}
}
}
.
Event value
[Dialplan][Add] Context
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String |
Errors
- empty data
- db error
Rename Context
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Rename] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":21,"name":"new-context-2"}}'
exampleSocket.send('{"event":"[Dialplan][Rename] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":21,"name":"new-context-2"}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Rename] Context",
"dialplan_contexts": {
"21": {
"id": 21,
"enabled": true,
"name": "new-context-2"
}
}
}
.
Event value
[Dialplan][Rename] Context
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| name | String |
Errors
- wrong id
- empty data
- context not found
- db error
Delete Context
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Delete] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":21}}'
exampleSocket.send('{"event":"[Dialplan][Delete] Context","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":21}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Delete] Context",
"id": 21
}
.
Event value
[Dialplan][Delete] Context
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- context not found
- db error
Get Extensions List
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Get] Extensions","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":19}}'
exampleSocket.send('{"event":"[Dialplan][Get] Extensions","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":19}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Get] Extensions",
"id": 19,
"dialplan_extensions": [
{
"id": 375,
"enabled": true,
"position": 2,
"name": "outside_call",
"continue": "true"
},
{
"id": 376,
"enabled": true,
"position": 3,
"name": "call_debug",
"continue": "true"
},
{
"id": 378,
"enabled": true,
"position": 5,
"name": "public_conference_extensions",
"continue": ""
},
{
"id": 377,
"enabled": true,
"position": 4,
"name": "public_extensions",
"continue": ""
},
{
"id": 379,
"enabled": true,
"position": 6,
"name": "public_did",
"continue": ""
},
{
"id": 374,
"enabled": true,
"position": 1,
"name": "unloop",
"continue": ""
}
]
}
Get Extensions list of context.
Event value
[Dialplan][Get] Extensions
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- context not found
Extensions
Add Extension
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Add] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","name":"new-extension","id":19}}'
exampleSocket.send('{"event":"[Dialplan][Add] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","name":"new-extension","id":19}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Add] Extension",
"id": 19,
"dialplan_extensions": [
{
"id": 386,
"enabled": true,
"position": 7,
"name": "new-extension",
"continue": ""
}
]
}
.
Event value
[Dialplan][Add] Extension
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| name | String | |
| id | Integer | Item ID. |
Errors
- wrong id
- empty data
- context not found
- db error
Rename Extension
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Rename] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":386,"name":"new-extension-2"}}'
exampleSocket.send('{"event":"[Dialplan][Rename] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":386,"name":"new-extension-2"}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Rename] Extension",
"id": 19,
"dialplan_extensions": [
{
"id": 386,
"enabled": true,
"position": 7,
"name": "new-extension-2",
"continue": ""
}
]
}
.
Event value
[Dialplan][Rename] Extension
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| name | String | |
| token | String | User auth token. |
Errors
- wrong id
- empty data
- extension not found
- db error
Delete Extension
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Delete] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":386}}'
exampleSocket.send('{"event":"[Dialplan][Delete] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":386}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Delete] Extension",
"id": 19,
"affected_id": 386
}
.
Event value
[Dialplan][Delete] Extension
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- extension not found
- db error
Set Extension Continue
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Switch] Extension Continue","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374,"value":"true"}}'
exampleSocket.send('{"event":"[Dialplan][Switch] Extension Continue","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374,"value":"true"}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Switch] Extension Continue",
"id": 19,
"dialplan_extensions": [
{
"id": 374,
"enabled": true,
"position": 1,
"name": "unloop",
"continue": "true"
}
]
}
.
Event value
[Dialplan][Switch] Extension Continue
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| value | String |
Errors
- wrong id
- extension not found
- wrong value
- db error
Move Extension
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Move] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":3,"current_index":2,"id":376}}'
exampleSocket.send('{"event":"[Dialplan][Move] Extension","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":3,"current_index":2,"id":376}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Move] Extension",
"id": 19,
"dialplan_extensions": [
{
"id": 374,
"enabled": true,
"position": 1,
"name": "unloop",
"continue": "true"
},
{
"id": 375,
"enabled": true,
"position": 3,
"name": "outside_call",
"continue": "true"
},
{
"id": 376,
"enabled": true,
"position": 2,
"name": "call_debug",
"continue": "true"
},
{
"id": 378,
"enabled": true,
"position": 5,
"name": "public_conference_extensions",
"continue": ""
},
{
"id": 377,
"enabled": true,
"position": 4,
"name": "public_extensions",
"continue": ""
},
{
"id": 379,
"enabled": true,
"position": 6,
"name": "public_did",
"continue": ""
}
]
}
Change extension priority position in context.
Event value
[Dialplan][Move] Extension
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer |
Errors
- wrong id
- wrong position
- extension not found
- can't move extension
Conditions
Get Conditions
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Get] Conditions","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374}}'
exampleSocket.send('{"event":"[Dialplan][Get] Conditions","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Get] Conditions",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 485,
"enabled": true,
"position": 1,
"break": "",
"field": "${unroll_loops}",
"expression": "^true$",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
},
{
"id": 486,
"enabled": true,
"position": 2,
"break": "",
"field": "${sip_looped_call}",
"expression": "^true$",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
.
Event value
[Dialplan][Get] Conditions
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- extension not found
Add Condition
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Add] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374}}'
exampleSocket.send('{"event":"[Dialplan][Add] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":374}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Add] Condition",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 499,
"enabled": true,
"position": 3,
"break": "",
"field": "",
"expression": "",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
.
Event value
[Dialplan][Add] Condition
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- extension not found
- db error
Update Condition
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Update] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":true,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}'
exampleSocket.send('{"event":"[Dialplan][Update] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":true,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Update] Condition",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 499,
"enabled": true,
"position": 3,
"break": "",
"field": "",
"expression": "",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
.
Event value
[Dialplan][Update] Condition
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| condition | Object | |
| - hour | String | |
| - mon | String | |
| - mweek | String | |
| - time_of_day | String | |
| - minute | String | |
| - yday | String | |
| - regexes | Array | |
| - id | Integer | Item ID. |
| - antiactions | Array | |
| - position | Integer | |
| - field | String | |
| - minday | String | |
| - dst | String | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - date_time | String | |
| - year | String | |
| - week | String | |
| - regex | String | |
| - actions | Array | |
| - break | String | |
| - mday | String | |
| - wday | String | |
| - tz_offset | String | |
| - expression | String |
Errors
- condition not found
- can't update
Disable Condition
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Switch] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":false,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}'
exampleSocket.send('{"event":"[Dialplan][Switch] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":false,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Switch] Condition",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 499,
"enabled": false,
"position": 3,
"break": "",
"field": "",
"expression": "",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
.
Event value
[Dialplan][Switch] Condition
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| condition | Object | |
| - mon | String | |
| - date_time | String | |
| - minday | String | |
| - dst | String | |
| - actions | Array | |
| - antiactions | Array | |
| - expression | String | |
| - position | Integer | |
| - field | String | |
| - hour | String | |
| - wday | String | |
| - year | String | |
| - minute | String | |
| - tz_offset | String | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - regex | String | |
| - mweek | String | |
| - week | String | |
| - yday | String | |
| - regexes | Array | |
| - break | String | |
| - mday | String | |
| - time_of_day | String | |
| - id | Integer | Item ID. |
Errors
- condition not found
- can't update
Delete Condition
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Delete] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":false,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}'
exampleSocket.send('{"event":"[Dialplan][Delete] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","condition":{"id":499,"enabled":false,"position":3,"break":"","field":"","expression":"","hour":"","mday":"","mon":"","mweek":"","wday":"","date_time":"","time_of_day":"","year":"","minute":"","week":"","yday":"","minday":"","tz_offset":"","dst":"","regex":"","regexes":[],"actions":[],"antiactions":[]}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Delete] Condition",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 499,
"enabled": false,
"position": 3,
"break": "",
"field": "",
"expression": "",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
.
Event value
[Dialplan][Delete] Condition
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| condition | Object | |
| - week | String | |
| - dst | String | |
| - actions | Array | |
| - id | Integer | Item ID. |
| - break | String | |
| - mday | String | |
| - mweek | String | |
| - date_time | String | |
| - regexes | Array | |
| - field | String | |
| - expression | String | |
| - hour | String | |
| - wday | String | |
| - year | String | |
| - regex | String | |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - position | Integer | |
| - mon | String | |
| - minday | String | |
| - tz_offset | String | |
| - antiactions | Array | |
| - time_of_day | String | |
| - minute | String | |
| - yday | String |
Errors
- condition not found
- can't update
Get Extension Data
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Get] Extension details","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":486}}'
exampleSocket.send('{"event":"[Dialplan][Get] Extension details","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":486}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Get] Extension details",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"486": {
"actions": [
{
"id": 1176,
"enabled": true,
"position": 1,
"application": "deflect",
"data": "${destination_number}",
"inline": false
}
],
"antiactions": [],
"regexes": []
}
}
}
Get extension data, actions and antiactions.
Event value
[Dialplan][Get] Extension details
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
Errors
- wrong id
- condition not found
Move Condition
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Move] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":3,"current_index":2,"id":500}}'
exampleSocket.send('{"event":"[Dialplan][Move] Condition","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":3,"current_index":2,"id":500}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Move] Condition",
"id": 19,
"dialplan_conditions": {
"374": [
{
"id": 500,
"enabled": true,
"position": 2,
"break": "",
"field": "",
"expression": "",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
},
{
"id": 485,
"enabled": true,
"position": 1,
"break": "",
"field": "${unroll_loops}",
"expression": "^true$",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
},
{
"id": 486,
"enabled": true,
"position": 3,
"break": "",
"field": "${sip_looped_call}",
"expression": "^true$",
"hour": "",
"mday": "",
"mon": "",
"mweek": "",
"wday": "",
"date_time": "",
"time_of_day": "",
"year": "",
"minute": "",
"week": "",
"yday": "",
"minday": "",
"tz_offset": "",
"dst": "",
"regex": ""
}
]
}
}
Change condition priority position in extension.
Event value
[Dialplan][Move] Condition
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer | |
| id | Integer | Item ID. |
Errors
- wrong id
- wrong position
- condition not found
- can't move condition
Actions
Add Action
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Add] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":500,"action":{"application":"name","data":"value","inline":false}}}'
exampleSocket.send('{"event":"[Dialplan][Add] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":500,"action":{"application":"name","data":"value","inline":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Add] Action",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"actions": [
{
"id": 1192,
"enabled": true,
"position": 1,
"application": "name",
"data": "value",
"inline": false
}
]
}
}
}
.
Event value
[Dialplan][Add] Action
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| id | Integer | Item ID. |
| action | Object | |
| - inline | Boolean | |
| - application | String | |
| - data | String |
Errors
- wrong id
- empty data
- condition not found
- db error
Update Action
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Update] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1193,"enabled":true,"position":1,"application":"name_new","data":"value_new","inline":false}}}'
exampleSocket.send('{"event":"[Dialplan][Update] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1193,"enabled":true,"position":1,"application":"name_new","data":"value_new","inline":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Update] Action",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"actions": [
{
"id": 1193,
"enabled": true,
"position": 1,
"application": "name_new",
"data": "value_new",
"inline": false
}
]
}
}
}
.
Event value
[Dialplan][Update] Action
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| action | Object | |
| - inline | Boolean | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
| - position | Integer | |
| - application | String | |
| - data | String |
Errors
- action not found
- can't update
Disable/Enable Action
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Switch] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1192, "enabled":false}}}'
exampleSocket.send('{"event":"[Dialplan][Switch] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1192, "enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Switch] Action",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"actions": [
{
"id": 1192,
"enabled": false,
"position": 1,
"application": "name",
"data": "value",
"inline": false
}
]
}
}
}
.
Event value
[Dialplan][Switch] Action
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| action | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
Errors
- action not found
- can't update
Delete Action
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Delete] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1192}}}'
exampleSocket.send('{"event":"[Dialplan][Delete] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","action":{"id":1192}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Delete] Action",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"actions": []
}
}
}
.
Event value
[Dialplan][Delete] Action
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| action | Object | |
| - id | Integer | Item ID. |
Errors
- action not found
- can't update
Move Action
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Move] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":2,"current_index":1,"id":1194}}'
exampleSocket.send('{"event":"[Dialplan][Move] Action","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":2,"current_index":1,"id":1194}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Move] Action",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"actions": [
{
"id": 1193,
"enabled": true,
"position": 2,
"application": "name_new",
"data": "value_new",
"inline": false
},
{
"id": 1194,
"enabled": true,
"position": 1,
"application": "ddd",
"data": "dddd",
"inline": false
}
]
}
}
}
Change action priority position in condition.
Event value
[Dialplan][Move] Action
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer | |
| id | Integer | Item ID. |
Errors
- wrong id
- wrong position
- action not found
- can't move action
Antiactions
Add Antiaction
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Add] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":500,"antiaction":{"application":"name","data":"value"}}}'
exampleSocket.send('{"event":"[Dialplan][Add] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","id":500,"antiaction":{"application":"name","data":"value"}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Add] Antiaction",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"antiactions": [
{
"id": 33,
"enabled": true,
"position": 1,
"application": "name",
"data": "value"
}
]
}
}
}
.
Event value
[Dialplan][Add] Antiaction
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| antiaction | Object | |
| - application | String | |
| - data | String | |
| token | String | User auth token. |
Errors
- wrong id
- empty data
- condition not found
- db error
Update Antiaction
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Update] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":35,"enabled":true,"position":1,"application":"name_new","data":"value_new"}}}'
exampleSocket.send('{"event":"[Dialplan][Update] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":35,"enabled":true,"position":1,"application":"name_new","data":"value_new"}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Update] Antiaction",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"antiactions": [
{
"id": 35,
"enabled": true,
"position": 1,
"application": "name_new",
"data": "value_new"
}
]
}
}
}
.
Event value
[Dialplan][Update] Antiaction
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| antiaction | Object | |
| - position | Integer | |
| - application | String | |
| - data | String | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
| token | String | User auth token. |
Errors
- antiAction not found
- can't update
Disable/Enable Antiaction
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Switch] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":33,"enabled":false}}}'
exampleSocket.send('{"event":"[Dialplan][Switch] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":33,"enabled":false}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Switch] Antiaction",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"antiactions": [
{
"id": 33,
"enabled": false,
"position": 1,
"application": "name",
"data": "value"
}
]
}
}
}
.
Event value
[Dialplan][Switch] Antiaction
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| antiaction | Object | |
| - id | Integer | Item ID. |
| - enabled | Boolean | Enabled/Disabled status of item. |
| token | String | User auth token. |
Errors
- antiAction not found
- can't update
Delete Antiaction
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Delete] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":33}}}'
exampleSocket.send('{"event":"[Dialplan][Delete] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","antiaction":{"id":33}}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Delete] Antiaction",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"antiactions": []
}
}
}
.
Event value
[Dialplan][Delete] Antiaction
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| token | String | User auth token. |
| antiaction | Object | |
| - id | Integer | Item ID. |
Errors
- antiAction not found
- can't delete
Move Antiaction
curl -X POST "https://HOST:PORT/api/v1"
-d '{"event":"[Dialplan][Move] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":2,"current_index":1,"id":36}}'
exampleSocket.send('{"event":"[Dialplan][Move] Antiaction","data":{"token":"185f2b5b4dbf7a456e6d6f9cb62805cb","previous_index":2,"current_index":1,"id":36}}');
Returns JSON structured like this:
{
"MessageType": "[Dialplan][Move] Antiaction",
"id": 19,
"affected_id": 374,
"dialplan_details": {
"500": {
"antiactions": [
{
"id": 35,
"enabled": true,
"position": 2,
"application": "name_new",
"data": "value_new"
},
{
"id": 36,
"enabled": true,
"position": 1,
"application": "sddsdsds",
"data": "dsdds"
}
]
}
}
}
Change antiAction priority position in condition.
Event value
[Dialplan][Move] Antiaction
Data Parameters
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Item ID. |
| token | String | User auth token. |
| previous_index | Integer | |
| current_index | Integer |
Errors
- wrong id
- wrong position
- antiAction not found
- can't move antiAction