API(s)
If you have any problems related to hardware and software you can raised a ticket, our support team help you either desktop or telephone.
| SN | Title | Request | Response |
|---|---|---|---|
| 1 | Device Info |
device/${token}/api/v1.0/command/system
{"cmd": "deviceinfo", "request_id":" e914b5997b762aa7"} |
{"status": "Success", "deviceinfo": { "devicename": "SPX1006O16S", "sn": "XR18132110000787", "firmwarever": "0.0.1-beta-20220610", "systemtime": "Fri Jun 10 11:37:23 2022", "uptime": "00:22:27"}, "message": "success", "request_id": "e914b5997b762aa7"} |
| 2 | Extension List |
device/${token}/api/v1.0/command/system
{"cmd": "extension_list", "request_id":" e914b5997b762aa7"} |
{ "status": "Success", "message": "success", "extlist":[{"status": "Unavailable", "type": "SIP", "number": "8001", "username": "8001"}, {"number": "2005", "status": "Idle", "type": "FXS", "port": "5", "username":""}, {"number": "2006", "status": "Idle", "type": "FXS", "port": "6", "username":""}, {"number": "2016", "status": "Idle", "type": "FXS", "port": "16", "username":""}], "request_id":" e914b5997b762aa7"} |
| 3 | Extension Set |
device/${token}/api/v1.0/command/cfg
{ "cmd": "extension_set", "request_id": "xxxx", "extension": "8001", "params": { "logout_status": "0", "fullname": "Tom", "permission": "3" } } |
{"message": "success", "status": "Success", "request_id": "xxxx"} |
| 4 | Alarm Set |
device/${token}/api/v1.0/command/cfg
{ "cmd": "alarm_set", "request_id": "xxxx", "extension": "8001", "params": { "start": "16:30", "clock_sound": "xxxx.wav", "cycle": "10", "times": "1", "days": "10" } } |
{"request_id": "xxxx", "status": "Failed", "message": "clock sound is not existing"} |
| 5 | Trunk List |
device/${token}/api/v1.0/command/system
{"cmd": "trunk_list", "request_id":" e914b5997b762aa7"} |
{ "trunklist":[{"status": "Idle", "name": "SIP_kMvORe", "type": "SIP"}, {"port": "1", "vbat":50, "status": "Idle", "name": "FXO-1", "type": "FXO"}, {"port": "4", "vbat":1, "status": "Disconnected", "name": "FXO-4", "type": "FXO"}], "request_id":" e914b5997b762aa7", "status": "Success", "message": "success"} |
| 6 | Live Call |
device/${token}/api/v1.0/command/system
{"cmd": "livecall", "request_id":" e914b5997b762aa7"} |
{ "request_id": "e914b5997b762aa7", "status": "Success", "livecall": [{"caller": "2005", "source": "FXS/5", "called": "2006", "destination": "FXS/6", "duration": "00:00:06", "callid": "1673071399.25", "state": "Ringing", "direction": "Internal", "recording": "no"}], "message": "success"} |
| 7 | Hangup |
device/${token}/api/v1.0/command/call
{"cmd": "hangup", "request_id": "xxx", "callid": "1672030725.7987",} |
{ "request_id": "xxx", "status": "Success", "message": "Channel Hungup" } |
| 8 | Event acquisition |
device/${token}/api/v1.0/event
1.{ "event": "extension_status", "extension": "2005", "status": "Idle" } 2. { "event": "extension_status", "extension": "2005", "status": "InUse" } 3. { "event": "extension_status", "extension": "2005", "status": "Busy" } 4. { "event": "extension_status", "extension": "8001", "ipaddr": "sip:8001@192.168.8.171:63414", "status": "InUse" } |
{"event": "invite", "from": "8001", "to": "2005", "callid": "1673077852.143"} |
| 9 | Outbound Call |
device/${token}/api/v1.0/command/call
{"cmd": "dial", "request_id": "xxx", "caller": "8001", "callee": "2005"} |
{"message": "success", "callid": "1673080587.2118", "request_id": "xxx", "status": "Success"} |
| 10 | IVR |
device/${token}/api/v1.0/command/call
{"cmd": "dial", "request_id": "xxx", "caller": "8001", "callee": "9000", "dialpermission": "8001"} |
{"callid": "1673081585.0187", "request_id": "xxx", "message": "success", "status": "Success"} |
| 11 | Queue |
device/${token}/api/v1.0/command/call
{"cmd": "dial", "request_id": "xxx", "caller": "6666", "callee": "+861235432341231""dialpermission": "8001"} |
{"status": "Success", "callid": "1672026034.6568", "message": "success", "request_id": "xxx"} |
| 12 | Queue List |
device/${token}/api/v1.0/command/queue
{"cmd": "queue_list", "request_id": "xxxx"} |
{"message": "success", "queuelist":[{"number": "33222", "description": "n/a", "members": "2003,2004,2005", "strategy": "ringall"}], "status" : "Success", "request_id": "xxxx"} |
| 13 | Queue Status |
device/${token}/api/v1.0/command/queue
{"cmd": "queue_status", "request_id": "xxx", "queue": "6666"} |
{ "request_id": "xxx", "queue": "6666", "params": { "max": "0", "strategy": "ringall", "calls": "0", "holdtime": "0", "talktime": "", "completed": "0", "abandoned": "0" }, "members": [ { "agent": "2002", "status": "0", "pused": "0" }, { "agent": "8001", "status": "1", "pused": "1" } ], "status": "Success" } |
| 14 | Queue Add |
device/${token}/api/v1.0/command/queue
{"cmd": "queue_add", "request_id": "xxx", "queue": "6666", "extension": "8001"} |
{ "request_id": "xxx", "status": "Success", "message": "Added interface to queue" } |
| 15 | Queue Seat Removal |
device/${token}/api/v1.0/command/queue
{"cmd": "queue_remove", "request_id": "xxx", "queue": "6666", "extension": "8001"} |
{ "request_id": "xxx", "status": "Success", "message": "Remove interface to queue" } |
| 16 | Queue Paused |
device/${token}/api/v1.0/command/queue
{"cmd": "queue_paused", "request_id": "xxx", "queue": "6666", "extension": "8001", "pused": "yes"} |
{ "request_id": "xxx", "status": "Success", "message": " Interface paused successfully" } |
| 17 | Listening to Calls |
device/${token}/api/v1.0/command/call
{"cmd": "listen", "request_id": "xxxx", "monitor": "2008", "extension": "2004", "type": "listen} |
{"callid": "1669694889.6367", "request_id": "xxxx", "status": "Success", "message": "success"} |
| 18 | Confrence Enquiries |
device/${token}/api/v1.0/command/conf
{"cmd": "conf_list", "request_id": "xxxx"} |
{ "message": "success", "conflist":[{"description":"", "number": "33333", "moderators": "2003,2004", "participantepassword": "111", "allowinvite": "yes"," moderatorpassword": "11223", "waitformoderator": "yes"}, {"description":"", "number": "4444", "moderators": "2004,2005", "participantepassword":"", "allowinvite": "yes", "moderatorpassword":""," waitformoderator": "no"} ], "status": "Success", "request_id": "xxxx" } |
| 19 | Confrence Status |
device/${token}/api/v1.0/command/conf
{"cmd": "conf_status", "request_id": "xxxx"} |
{ "request_id": "e914b5997b762aa7", "members": [ { "callerid": "8001", "channel": "PJSIP\/8001-00000002", "admin": "No", "markeduser": "No", "waitmarked": "No", "waiting": "No", "muted": "No", "talking": "No", "answeredtime": "2" } ], "conf": "2222", "status": "Success" } |
| 20 | Meeting Members invited |
device/${token}/api/v1.0/command/conf
{"cmd": "conf_invite", "request_id": "e914b5997b762aa7", "conf": "2222", "dialpermission": "8001", "member": "2003"} |
{"status": "Success", "message": "success", "request_id": "e914b5997b762aa7"} |
| 21 | Meeting Members Kicked Out |
device/${token}/api/v1.0/command/conf
{ "cmd": "conf_kick", "request_id": "e914b5997b762aa7", "conf": "2222", "channel": "PJSIP/8001-00000002" } |
{ "request_id": "e914b5997b762aa7", "status": "Success", "message": "User kicked" } |
| 22 | Meeting Members Muted |
device/${token}/api/v1.0/command/conf
{ "cmd": "conf_mute", "request_id": "e914b5997b762aa7", "conf": "2222", "channel": "PJSIP/8001-00000002" } |
{ "request_id": "e914b5997b762aa7", "status": "Success", "message": "User muted" } |
| 23 | Meeting Members Unmuted |
device/${token}/api/v1.0/command/conf
{ "cmd": "conf_unmute", "request_id": "e914b5997b762aa7", "conf": "2222", "channel": "PJSIP/8001-00000002" } |
{ "request_id": "e914b5997b762aa7", "status": "Success", "message": "User unmuted" } |
| 24 | CDR |
device/${token}/api/v1.0/cdr
|
{ "event": "cdr", "callid": "1672372428.45", "src": "2007", "srctech": "FXS\/7", "dst": "FXS\/7", "dsttech": "2005", "start": "FXS\/5", "end": "2022-12-30 11:53:55", "billsec": "0", "disposition": "NO ANSWER", "direction": "Internal", "dtmf": "0", "recordfile": "" } |
| Title | URL | Parameter | Type | Output |
|---|---|---|---|---|
| Broadcast SMS (Date Range) |
http://localhost/onyxcxm/api/outSms/6?start_date=2023-02-10&end_date=2023-02-10 | 6 => broadcast_id start_date=2023-02-10 end_date=2023-02-10 |
GET | {"status":"success","message":[{"id":"1","action_id":"BRD_6_211026054344","channel":"10","number":"09876543210","message":"test0122","encode":"0","server_id":XR18132008000598,"timestamp":"20211106152502","token":"24A01A3AB17277D55E6C4A8EB9E70677","response":"Success","sms_id":"9718603323-1636192502","sms_schedule_id":null,"created":"2021-11-06 15:24:29","resp_msg":null}]} |
| Broadcast SMS (All) |
http://localhost/onyxcxm/api/outSms/6 | 6 => broadcast_id | GET | {"status":"success","message":[{"id":"1","action_id":"BRD_6_211026054344","channel":"10","number":"09876543210","message":"test0122","encode":"0","server_id":XR18132008000598,"timestamp":"20211106152502","token":"24A01A3AB17277D55E6C4A8EB9E70677","response":"Success","sms_id":"9718603323-1636192502","sms_schedule_id":null,"created":"2021-11-06 15:24:29","resp_msg":null}]} |
| Call Disconnect | http://localhost/onyxcxm/api/hangup?uuid=af14808a-9faf-49f2-aa5b-5fea65b56f80 | uuid=af14808a-9faf-49f2-aa5b-5fea65b56f80 | GET | {"status":"success","message":"\n+OK\n"} |
| Call Duration | http://localhost/onyxcxm/api/callDuration?uuid=527e092d-b25e-4703-ae23-4206f0f68ca9 | uuid=527e092d-b25e-4703-ae23-4206f0f68ca9 | GET | {"status":"success","message":"10"} |
| Call Status | http://localhost/onyxcxm/api/callStatus | GET | {"status":"success","message":[{"uuid":"bafe4e2f-101a-4969-b823-838edffd99dd","direction":"inbound","created":"2021-07-16 17:18:06","name":"sofia\/internal\/2001@103.152.79.226:65197","state":"CS_EXECUTE" ... ... "initial_dialplan":"XML","initial_context":"default"}]} |
|
| CDR (All) | http://localhost/onyxcxm/api/cdr | GET | {"status":"success","message":[{"id":"314","caller_id_name":"2001","caller_id_number":"2001","destination_number":"9718603323","context":"default","start_stamp":"2021-07-16 12:09:25","answer_stamp":null,"end_stamp":"2021-07-16 12:09:25","duration":"0","billsec":"0","hangup_cause":"NORMAL_TEMPORARY_FAILURE","uuid":"8769cb72-52d3-4a8a-9285-e53befc1e10d"}]} | |
| CDR (Date Range) | http://localhost/onyxcxm/api/cdr?start_date=2023-02-10&end_date=2023-02-10 | start_date=2023-02-10 end_date=2023-02-10 |
GET | {"status":"success","message":[{"id":"314","caller_id_name":"2001","caller_id_number":"2001","destination_number":"9718603323","context":"default","start_stamp":"2021-07-16 12:09:25","answer_stamp":null,"end_stamp":"2021-07-16 12:09:25","duration":"0","billsec":"0","hangup_cause":"NORMAL_TEMPORARY_FAILURE","uuid":"8769cb72-52d3-4a8a-9285-e53befc1e10d"}]} |
| Click To Call (Extension To IVR) | http://localhost/onyxcxm/api/ivrCall?extension=1100&caller_id_number=987654xxxxx&ivr=1234 | extension=1100 caller_id_number=987654xxxxx ivr=1234 |
GET | {"status":"success","message":"\n+OK aecee36f-7f9e-4e8e-bbc4-43bba47d8ff5\n"} |
| Click To Call (Extension To Number) | http://localhost/onyxcxm/api/extnCall?extension=1100&caller_id_number=987654xxxxx&gateway=Synway | extension=1100 caller_id_number=987654xxxxx gateway=Synway |
GET | {"status":"success","message":"\n+OK aecee36f-7f9e-4e8e-bbc4-43bba47d8ff5\n"} |
| Click To Call (Number To Number) | http://localhost/onyxcxm/api/numCall?caller_id_number=987654xxxxx&callee_id_number=876543xxxxx&gateway=Synway | caller_id_number=987654xxxxx callee_id_number=876543xxxxx gateway=Synway |
GET | {"status":"success","message":"\n+OK aecee36f-7f9e-4e8e-bbc4-43bba47d8ff5\n"} |
| Get Did Status By Did Number | http://localhost/onyxcxm/api/getByDid?did_no=61212587 | did_no=61212587 | GET | {"status":"success","message":[{"itsp_name":"Jio","service_type":"Open","is_used":"f","did_no":"61212587","voice_channel":"3","used_by":null}]} |
| Get Did(s) Status By DidPool Range | http://localhost/onyxcxm/api/getByDidPools?from_range=61212587&to_range=61212588 | from_range=61212587 to_range=61212588 |
GET | {"status":"success","message":[{"itsp_name":"Jio","service_type":"Inbound","is_used":"t","did_no":"61212588","voice_channel":"3","used_by":JP},{"itsp_name":"Jio","service_type":"Open","is_used":"f","did_no":"61212587","voice_channel":"3","used_by":null}]} |
| Get Did(s) Status By Pilot Number | http://localhost/onyxcxm/api/getByPilot?pilot_number=3361212587 | pilot_number=3361212587 | GET | {"status":"success","message":[{"itsp_name":"Jio","service_type":"Inbound","is_used":"t","did_no":"61212588","voice_channel":"3","used_by":JP},{"itsp_name":"Jio","service_type":"Open","is_used":"f","did_no":"61212587","voice_channel":"3","used_by":null}]} |
| Live Calls | http://localhost/onyxcxm/api/liveCalls | GET | {"status":"success","message":[{"cid_num":"2450","uuid":"c2f20b2b-38da-4558-9973-11ba7107908d","ip_addr":"11.22.33.44","direction":"inbound","cid_name":"2450","dest":"1234567890","application_data":"{origination_caller_id_number=61212345@11.22.33.45,sip_cid_type=pid,sip_h_P-Preferred-Identity=,ignore_early_media=consume}sofia\/gateway\/61212345\/1234567890","callstate":"EARLY","state":"CS_EXECUTE","application":"bridge","created":"2021-10-25 01:34:38","custom_call_mode":null,"intial_dest":null,"serving_agent":null}]} | |
| Mute Call | http://localhost/onyxcxm/api/mute?uuid=0d7c3b93-a5ae-4964-9e4d-902bba50bd19&level=-4 | uuid=0d7c3b93-a5ae-4964-9e4d-902bba50bd19 level=-4 level varies -4 to 4 |
GET | {"status":"success","message":"\n+OK\n"} |
| Outgoing SMS (Date Range) |
http://localhost/onyxcxm/api/outSms?start_date=2023-02-10&end_date=2023-02-10 | start_date=2023-02-10 end_date=2023-02-10 |
GET | {"status":"success","message":[{"id":"1","action_id":"SMS211108041937","channel":"10","number":"09876543210","message":"test0122","encode":"0","server_id":XR18132008000598,"timestamp":"20211106152502","token":"24A01A3AB17277D55E6C4A8EB9E70677","response":"Success","sms_id":"9718603323-1636192502","sms_schedule_id":null,"created":"2021-11-06 15:24:29","resp_msg":null}]} |
| Outgoing SMS (All) |
http://localhost/onyxcxm/api/outSms | GET | {"status":"success","message":[{"id":"1","action_id":"SMS211108041937","channel":"10","number":"09876543210","message":"test0122","encode":"0","server_id":XR18132008000598,"timestamp":"20211106152502","token":"24A01A3AB17277D55E6C4A8EB9E70677","response":"Success","sms_id":"9718603323-1636192502","sms_schedule_id":null,"created":"2021-11-06 15:24:29","resp_msg":null}]} | |
| Recording (All) | http://localhost/onyxcxm/api/recordings | GET | * this api work with browser request time depend upon file size |
|
| Recording (By Date) | http://localhost/onyxcxm/api/recordings?date=2023-02-10 | date=2023-02-10 | GET | * this api work with browser request time depend upon file size |
| Recording (Single) | http://localhost/onyxcxm/api/recordings?date=2023-02-10&file_name={caller_id_number}_{destination_number}_{uuid}.wav | date=2023-02-10 file_name=2021-07-07/2001_6677_fa7ce300-21de-445e-80b7-c42bd1d7c19c.wav |
GET | * this api work with browser request time depend upon file size |